|
| 1 | +// Copyright 2016 Google Inc. |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +syntax = "proto3"; |
| 16 | + |
| 17 | +package google.monitoring.v3; |
| 18 | + |
| 19 | +import "google/api/distribution.proto"; |
| 20 | +import "google/protobuf/duration.proto"; |
| 21 | +import "google/protobuf/timestamp.proto"; |
| 22 | + |
| 23 | +option csharp_namespace = "Google.Cloud.Monitoring.V3"; |
| 24 | +option go_package = "google.golang.org/genproto/googleapis/monitoring/v3;monitoring"; |
| 25 | +option java_multiple_files = true; |
| 26 | +option java_outer_classname = "CommonProto"; |
| 27 | +option java_package = "com.google.monitoring.v3"; |
| 28 | + |
| 29 | + |
| 30 | +// A single strongly-typed value. |
| 31 | +message TypedValue { |
| 32 | + // The typed value field. |
| 33 | + oneof value { |
| 34 | + // A Boolean value: `true` or `false`. |
| 35 | + bool bool_value = 1; |
| 36 | + |
| 37 | + // A 64-bit integer. Its range is approximately ±9.2x10<sup>18</sup>. |
| 38 | + int64 int64_value = 2; |
| 39 | + |
| 40 | + // A 64-bit double-precision floating-point number. Its magnitude |
| 41 | + // is approximately ±10<sup>±300</sup> and it has 16 |
| 42 | + // significant digits of precision. |
| 43 | + double double_value = 3; |
| 44 | + |
| 45 | + // A variable-length string value. |
| 46 | + string string_value = 4; |
| 47 | + |
| 48 | + // A distribution value. |
| 49 | + google.api.Distribution distribution_value = 5; |
| 50 | + } |
| 51 | +} |
| 52 | + |
| 53 | +// A time interval extending just after a start time through an end time. |
| 54 | +// If the start time is the same as the end time, then the interval |
| 55 | +// represents a single point in time. |
| 56 | +message TimeInterval { |
| 57 | + // Required. The end of the time interval. |
| 58 | + google.protobuf.Timestamp end_time = 2; |
| 59 | + |
| 60 | + // Optional. The beginning of the time interval. The default value |
| 61 | + // for the start time is the end time. The start time must not be |
| 62 | + // later than the end time. |
| 63 | + google.protobuf.Timestamp start_time = 1; |
| 64 | +} |
| 65 | + |
| 66 | +// Describes how to combine multiple time series to provide different views of |
| 67 | +// the data. Aggregation consists of an alignment step on individual time |
| 68 | +// series (`per_series_aligner`) followed by an optional reduction of the data |
| 69 | +// across different time series (`cross_series_reducer`). For more details, see |
| 70 | +// [Aggregation](/monitoring/api/learn_more#aggregation). |
| 71 | +message Aggregation { |
| 72 | + // The Aligner describes how to bring the data points in a single |
| 73 | + // time series into temporal alignment. |
| 74 | + enum Aligner { |
| 75 | + // No alignment. Raw data is returned. Not valid if cross-time |
| 76 | + // series reduction is requested. The value type of the result is |
| 77 | + // the same as the value type of the input. |
| 78 | + ALIGN_NONE = 0; |
| 79 | + |
| 80 | + // Align and convert to delta metric type. This alignment is valid |
| 81 | + // for cumulative metrics and delta metrics. Aligning an existing |
| 82 | + // delta metric to a delta metric requires that the alignment |
| 83 | + // period be increased. The value type of the result is the same |
| 84 | + // as the value type of the input. |
| 85 | + ALIGN_DELTA = 1; |
| 86 | + |
| 87 | + // Align and convert to a rate. This alignment is valid for |
| 88 | + // cumulative metrics and delta metrics with numeric values. The output is a |
| 89 | + // gauge metric with value type |
| 90 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 91 | + ALIGN_RATE = 2; |
| 92 | + |
| 93 | + // Align by interpolating between adjacent points around the |
| 94 | + // period boundary. This alignment is valid for gauge |
| 95 | + // metrics with numeric values. The value type of the result is the same |
| 96 | + // as the value type of the input. |
| 97 | + ALIGN_INTERPOLATE = 3; |
| 98 | + |
| 99 | + // Align by shifting the oldest data point before the period |
| 100 | + // boundary to the boundary. This alignment is valid for gauge |
| 101 | + // metrics. The value type of the result is the same as the |
| 102 | + // value type of the input. |
| 103 | + ALIGN_NEXT_OLDER = 4; |
| 104 | + |
| 105 | + // Align time series via aggregation. The resulting data point in |
| 106 | + // the alignment period is the minimum of all data points in the |
| 107 | + // period. This alignment is valid for gauge and delta metrics with numeric |
| 108 | + // values. The value type of the result is the same as the value |
| 109 | + // type of the input. |
| 110 | + ALIGN_MIN = 10; |
| 111 | + |
| 112 | + // Align time series via aggregation. The resulting data point in |
| 113 | + // the alignment period is the maximum of all data points in the |
| 114 | + // period. This alignment is valid for gauge and delta metrics with numeric |
| 115 | + // values. The value type of the result is the same as the value |
| 116 | + // type of the input. |
| 117 | + ALIGN_MAX = 11; |
| 118 | + |
| 119 | + // Align time series via aggregation. The resulting data point in |
| 120 | + // the alignment period is the average or arithmetic mean of all |
| 121 | + // data points in the period. This alignment is valid for gauge and delta |
| 122 | + // metrics with numeric values. The value type of the output is |
| 123 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 124 | + ALIGN_MEAN = 12; |
| 125 | + |
| 126 | + // Align time series via aggregation. The resulting data point in |
| 127 | + // the alignment period is the count of all data points in the |
| 128 | + // period. This alignment is valid for gauge and delta metrics with numeric |
| 129 | + // or Boolean values. The value type of the output is |
| 130 | + // [INT64][google.api.MetricDescriptor.ValueType.INT64]. |
| 131 | + ALIGN_COUNT = 13; |
| 132 | + |
| 133 | + // Align time series via aggregation. The resulting data point in |
| 134 | + // the alignment period is the sum of all data points in the |
| 135 | + // period. This alignment is valid for gauge and delta metrics with numeric |
| 136 | + // and distribution values. The value type of the output is the |
| 137 | + // same as the value type of the input. |
| 138 | + ALIGN_SUM = 14; |
| 139 | + |
| 140 | + // Align time series via aggregation. The resulting data point in |
| 141 | + // the alignment period is the standard deviation of all data |
| 142 | + // points in the period. This alignment is valid for gauge and delta metrics |
| 143 | + // with numeric values. The value type of the output is |
| 144 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 145 | + ALIGN_STDDEV = 15; |
| 146 | + |
| 147 | + // Align time series via aggregation. The resulting data point in |
| 148 | + // the alignment period is the count of True-valued data points in the |
| 149 | + // period. This alignment is valid for gauge metrics with |
| 150 | + // Boolean values. The value type of the output is |
| 151 | + // [INT64][google.api.MetricDescriptor.ValueType.INT64]. |
| 152 | + ALIGN_COUNT_TRUE = 16; |
| 153 | + |
| 154 | + // Align time series via aggregation. The resulting data point in |
| 155 | + // the alignment period is the fraction of True-valued data points in the |
| 156 | + // period. This alignment is valid for gauge metrics with Boolean values. |
| 157 | + // The output value is in the range [0, 1] and has value type |
| 158 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 159 | + ALIGN_FRACTION_TRUE = 17; |
| 160 | + |
| 161 | + // Align time series via aggregation. The resulting data point in |
| 162 | + // the alignment period is the 99th percentile of all data |
| 163 | + // points in the period. This alignment is valid for gauge and delta metrics |
| 164 | + // with distribution values. The output is a gauge metric with value type |
| 165 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 166 | + ALIGN_PERCENTILE_99 = 18; |
| 167 | + |
| 168 | + // Align time series via aggregation. The resulting data point in |
| 169 | + // the alignment period is the 95th percentile of all data |
| 170 | + // points in the period. This alignment is valid for gauge and delta metrics |
| 171 | + // with distribution values. The output is a gauge metric with value type |
| 172 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 173 | + ALIGN_PERCENTILE_95 = 19; |
| 174 | + |
| 175 | + // Align time series via aggregation. The resulting data point in |
| 176 | + // the alignment period is the 50th percentile of all data |
| 177 | + // points in the period. This alignment is valid for gauge and delta metrics |
| 178 | + // with distribution values. The output is a gauge metric with value type |
| 179 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 180 | + ALIGN_PERCENTILE_50 = 20; |
| 181 | + |
| 182 | + // Align time series via aggregation. The resulting data point in |
| 183 | + // the alignment period is the 5th percentile of all data |
| 184 | + // points in the period. This alignment is valid for gauge and delta metrics |
| 185 | + // with distribution values. The output is a gauge metric with value type |
| 186 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 187 | + ALIGN_PERCENTILE_05 = 21; |
| 188 | + } |
| 189 | + |
| 190 | + // A Reducer describes how to aggregate data points from multiple |
| 191 | + // time series into a single time series. |
| 192 | + enum Reducer { |
| 193 | + // No cross-time series reduction. The output of the aligner is |
| 194 | + // returned. |
| 195 | + REDUCE_NONE = 0; |
| 196 | + |
| 197 | + // Reduce by computing the mean across time series for each |
| 198 | + // alignment period. This reducer is valid for delta and |
| 199 | + // gauge metrics with numeric or distribution values. The value type of the |
| 200 | + // output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 201 | + REDUCE_MEAN = 1; |
| 202 | + |
| 203 | + // Reduce by computing the minimum across time series for each |
| 204 | + // alignment period. This reducer is valid for delta and |
| 205 | + // gauge metrics with numeric values. The value type of the output |
| 206 | + // is the same as the value type of the input. |
| 207 | + REDUCE_MIN = 2; |
| 208 | + |
| 209 | + // Reduce by computing the maximum across time series for each |
| 210 | + // alignment period. This reducer is valid for delta and |
| 211 | + // gauge metrics with numeric values. The value type of the output |
| 212 | + // is the same as the value type of the input. |
| 213 | + REDUCE_MAX = 3; |
| 214 | + |
| 215 | + // Reduce by computing the sum across time series for each |
| 216 | + // alignment period. This reducer is valid for delta and |
| 217 | + // gauge metrics with numeric and distribution values. The value type of |
| 218 | + // the output is the same as the value type of the input. |
| 219 | + REDUCE_SUM = 4; |
| 220 | + |
| 221 | + // Reduce by computing the standard deviation across time series |
| 222 | + // for each alignment period. This reducer is valid for delta |
| 223 | + // and gauge metrics with numeric or distribution values. The value type of |
| 224 | + // the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 225 | + REDUCE_STDDEV = 5; |
| 226 | + |
| 227 | + // Reduce by computing the count of data points across time series |
| 228 | + // for each alignment period. This reducer is valid for delta |
| 229 | + // and gauge metrics of numeric, Boolean, distribution, and string value |
| 230 | + // type. The value type of the output is |
| 231 | + // [INT64][google.api.MetricDescriptor.ValueType.INT64]. |
| 232 | + REDUCE_COUNT = 6; |
| 233 | + |
| 234 | + // Reduce by computing the count of True-valued data points across time |
| 235 | + // series for each alignment period. This reducer is valid for delta |
| 236 | + // and gauge metrics of Boolean value type. The value type of |
| 237 | + // the output is [INT64][google.api.MetricDescriptor.ValueType.INT64]. |
| 238 | + REDUCE_COUNT_TRUE = 7; |
| 239 | + |
| 240 | + // Reduce by computing the fraction of True-valued data points across time |
| 241 | + // series for each alignment period. This reducer is valid for delta |
| 242 | + // and gauge metrics of Boolean value type. The output value is in the |
| 243 | + // range [0, 1] and has value type |
| 244 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]. |
| 245 | + REDUCE_FRACTION_TRUE = 8; |
| 246 | + |
| 247 | + // Reduce by computing 99th percentile of data points across time series |
| 248 | + // for each alignment period. This reducer is valid for gauge and delta |
| 249 | + // metrics of numeric and distribution type. The value of the output is |
| 250 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE] |
| 251 | + REDUCE_PERCENTILE_99 = 9; |
| 252 | + |
| 253 | + // Reduce by computing 95th percentile of data points across time series |
| 254 | + // for each alignment period. This reducer is valid for gauge and delta |
| 255 | + // metrics of numeric and distribution type. The value of the output is |
| 256 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE] |
| 257 | + REDUCE_PERCENTILE_95 = 10; |
| 258 | + |
| 259 | + // Reduce by computing 50th percentile of data points across time series |
| 260 | + // for each alignment period. This reducer is valid for gauge and delta |
| 261 | + // metrics of numeric and distribution type. The value of the output is |
| 262 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE] |
| 263 | + REDUCE_PERCENTILE_50 = 11; |
| 264 | + |
| 265 | + // Reduce by computing 5th percentile of data points across time series |
| 266 | + // for each alignment period. This reducer is valid for gauge and delta |
| 267 | + // metrics of numeric and distribution type. The value of the output is |
| 268 | + // [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE] |
| 269 | + REDUCE_PERCENTILE_05 = 12; |
| 270 | + } |
| 271 | + |
| 272 | + // The alignment period for per-[time series][google.monitoring.v3.TimeSeries] |
| 273 | + // alignment. If present, `alignmentPeriod` must be at least 60 |
| 274 | + // seconds. After per-time series alignment, each time series will |
| 275 | + // contain data points only on the period boundaries. If |
| 276 | + // `perSeriesAligner` is not specified or equals `ALIGN_NONE`, then |
| 277 | + // this field is ignored. If `perSeriesAligner` is specified and |
| 278 | + // does not equal `ALIGN_NONE`, then this field must be defined; |
| 279 | + // otherwise an error is returned. |
| 280 | + google.protobuf.Duration alignment_period = 1; |
| 281 | + |
| 282 | + // The approach to be used to align individual time series. Not all |
| 283 | + // alignment functions may be applied to all time series, depending |
| 284 | + // on the metric type and value type of the original time |
| 285 | + // series. Alignment may change the metric type or the value type of |
| 286 | + // the time series. |
| 287 | + // |
| 288 | + // Time series data must be aligned in order to perform cross-time |
| 289 | + // series reduction. If `crossSeriesReducer` is specified, then |
| 290 | + // `perSeriesAligner` must be specified and not equal `ALIGN_NONE` |
| 291 | + // and `alignmentPeriod` must be specified; otherwise, an error is |
| 292 | + // returned. |
| 293 | + Aligner per_series_aligner = 2; |
| 294 | + |
| 295 | + // The approach to be used to combine time series. Not all reducer |
| 296 | + // functions may be applied to all time series, depending on the |
| 297 | + // metric type and the value type of the original time |
| 298 | + // series. Reduction may change the metric type of value type of the |
| 299 | + // time series. |
| 300 | + // |
| 301 | + // Time series data must be aligned in order to perform cross-time |
| 302 | + // series reduction. If `crossSeriesReducer` is specified, then |
| 303 | + // `perSeriesAligner` must be specified and not equal `ALIGN_NONE` |
| 304 | + // and `alignmentPeriod` must be specified; otherwise, an error is |
| 305 | + // returned. |
| 306 | + Reducer cross_series_reducer = 4; |
| 307 | + |
| 308 | + // The set of fields to preserve when `crossSeriesReducer` is |
| 309 | + // specified. The `groupByFields` determine how the time series are |
| 310 | + // partitioned into subsets prior to applying the aggregation |
| 311 | + // function. Each subset contains time series that have the same |
| 312 | + // value for each of the grouping fields. Each individual time |
| 313 | + // series is a member of exactly one subset. The |
| 314 | + // `crossSeriesReducer` is applied to each subset of time series. |
| 315 | + // It is not possible to reduce across different resource types, so |
| 316 | + // this field implicitly contains `resource.type`. Fields not |
| 317 | + // specified in `groupByFields` are aggregated away. If |
| 318 | + // `groupByFields` is not specified and all the time series have |
| 319 | + // the same resource type, then the time series are aggregated into |
| 320 | + // a single output time series. If `crossSeriesReducer` is not |
| 321 | + // defined, this field is ignored. |
| 322 | + repeated string group_by_fields = 5; |
| 323 | +} |
0 commit comments