photon-protocol 0.0.0

Internal codec and compression traits for Photon
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

syntax = "proto3";

package photon.ingest.v1;

service IngestService {
  // Bidirectional stream for metric batch ingestion.
  // The SDK sends batches, the server sends acks.
  rpc LogMetrics(stream MetricBatchRequest) returns (stream MetricBatchAck);

  // Unary RPC for crash recovery. The SDK asks the server for the
  // last committed sequence number for a given run.
  rpc GetWatermark(WatermarkRequest) returns (WatermarkResponse);
}

message MetricBatchRequest {
  string run_id = 1;
  uint64 sequence_number = 2;
  bytes compressed_payload = 3;
  uint32 crc32 = 4;
  string compressor_name = 5;
  uint64 created_at_epoch_ms = 6;
  uint32 point_count = 7;
  uint32 uncompressed_size = 8;
}

message MetricBatchAck {
  uint64 sequence_number = 1;
  AckStatus status = 2;
  string message = 3;
}

enum AckStatus {
  ACK_STATUS_UNSPECIFIED = 0;
  ACK_STATUS_OK = 1;
  ACK_STATUS_DUPLICATE = 2;
  ACK_STATUS_REJECTED = 3;
}

message MetricBatchContent {
  string run_id = 1;
  repeated string keys = 2;
  repeated MetricPointCompact points = 3;
}

message MetricPointCompact {
  uint32 key_index = 1;
  double value = 2;
  uint64 step = 3;
  uint64 timestamp_epoch_ms = 4;
}

message WatermarkRequest {
  string run_id = 1;
}

message WatermarkResponse {
  uint64 sequence_number = 1;
}