aardvark/IntermediateModel.proto at master · eswdd/aardvark · GitHub

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
option optimize_for = SPEED;

import "StringSerialisation.proto";

message IntermediateModel {
  optional StringSerialisationData aaStringSerialisedForm = 1;
  optional Global global = 2;
  repeated Graph graphs = 3;
  // deprecated in favour of queries, to be removed in 1.6.0
  repeated Metric metrics = 4;
  repeated Query queries = 5;
  optional int32 version = 6 [ default = 1 ];
}

message TimePeriod {
  optional int32 count = 1;
  optional int32 unit = 2;
}

message Global {
  optional int32 flags = 1;
  optional int64 fromDateTime = 2;
  optional int64 toDateTime = 3;
  optional TimePeriod relativePeriod = 4 [ default = "2h" ];
  optional int32 minGraphHeight = 5;
  optional int32 graphHeight = 6;
  optional int32 autoReloadPeriod = 7;
  optional TimePeriod globalDownsampleTo = 8 [ default = "5m" ];
  optional int32 baselineDatumStyle = 9;
  optional TimePeriod baselineRelativePeriod = 10 [ default = "1d" ];
  optional int64 baselineFromDateTime = 11;
  optional int64 baselineToDateTime = 12;
}

message Gnuplot {
  // Usage stopped after introducing flags on Graph object
  // optional int32 flags = 1;
  optional string yAxisLabel = 2 [ default = "" ];
  optional string y2AxisLabel = 3 [ default = "" ];
  optional string yAxisFormat = 4;
  optional string y2AxisFormat = 5;
  optional string yAxisRange = 6 [ default = "[0:]" ];
  optional string y2AxisRange = 7 [ default = "[0:]" ];
  optional int32 keyLocation = 8 [ default = "top right" ];
  optional int32 style = 9 [ default = "linespoint" ];
}

message Dygraph {
  // Usage stopped after introducing flags on Graph object
  // optional int32 flags = 1;
  optional int32 countFilterEnd = 2;
  optional int32 countFilterCount = 3;
  optional int32 countFilterMeasure = 4;
  optional int32 valueFilterLowerBound = 5;
  optional int32 valueFilterUpperBound = 6;
  optional int32 valueFilterMeasure = 7;
  optional string yAxisRange = 8 [ default = "[:]" ];
  optional string y2AxisRange = 9 [ default = "[:]" ];
}

message Heatmap {
  optional int32 style = 1 [ default = "auto" ];
  optional int32 valueFilterLowerBound = 2;
  optional int32 valueFilterUpperBound = 3;
  optional int32 colourScheme = 4 [ default = "RdYlGn" ];
}

message Scatter {
  optional string xAxisRange = 1 [ default = "[:]" ];
  optional string yAxisRange = 2 [ default = "[:]" ];
}

message Horizon {
  optional int32 sortMethod = 1 [ default = "name" ];
}

message Graph {
  optional int32 id = 1;
  optional int32 type = 2;
  optional string title = 3;
  optional int32 flags = 4;
  optional Gnuplot gnuplot = 5;
  optional Dygraph dygraph = 6;
  optional Heatmap heatmap = 7;
  optional Scatter scatter = 8;
  optional Horizon horizon = 9;
}

message TagPair {
  required string name = 1;
  required string value = 2;
  optional int32 flags = 3 [ default = 0 ];
}

message Metric {
  optional int32 flags = 1;
  optional int32 id = 2;
  optional string name = 3;
  repeated TagPair tags = 4;
  // deprecated from 1.5.0 and moved to query - to be removed in 1.6.0
  optional int32 graphId = 5 [ default = 0 ];
  optional int64 rateCounterReset = 6;
  optional int64 rateCounterMax = 7;
  optional int32 aggregator = 8 [ default = "sum" ];
  optional int32 downsampleBy = 9 [ default = "avg" ];
  optional TimePeriod downsampleTo = 10 [ default = "10m" ];
  // realised that axis control should be in the graph options
  // optional int32 scatterAxis = 11 [ default = "x" ];
  // deprecated from 1.5.0 and moved to query - to be removed in 1.6.0
  optional int32 axis = 12 [ default = "x1y1" ];
}

message GraphiteExpression {
  optional string name = 1;
  optional string function = 2;
  repeated int32 subQueries = 3;
  optional string argument = 4;
}

//message Expression {
//  optional string name = 1;
//  map<string, int32> variables = 2;
//  optional string expression = 3;
//}

message Query {
  // read from Metric.id when deserialising from pre-1.5.0
  optional int32 id = 1;
  // read from Metric.graphId when deserialising from pre-1.5.0
  optional int32 graphId = 2 [ default = 0 ];
  // read from Metric.axis when deserialising from pre-1.5.0
  optional int32 axis = 3 [ default = "x1y1" ];
  // read from Metric.flags when deserialising from pre-1.5.0
  optional int32 renderFlags = 4;
  optional int32 metric = 5;
  optional GraphiteExpression gexp = 6;
  //optional Expression exp = 7;
}