package api.v1.metrics

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetMetrics (GetMetricsRequest, GetMetricsResponse)

  service.proto:13

  Retrieve metrics. metric_type is mandatory, while the rest of the fields in the tags are optional. If project, env or capsule is not specified, they will be treated as wildcards.

  message GetMetricsRequest

  service.proto:21

  • optional Tags tags = 1

  • optional google.protobuf.Timestamp from = 2

  • optional google.protobuf.Timestamp to = 3

  • optional Aggregation aggregation = 4

  message GetMetricsResponse

  service.proto:28

  • repeated Metric metrics = 1

• rpc GetMetricsMany (GetMetricsManyRequest, GetMetricsManyResponse)

  service.proto:16

  Retrive metrics for multiple sets of tags at a time. Metrics within the same set of tags will be in ascending order of timestamp.

  message GetMetricsManyRequest

  service.proto:32

  • repeated Tags tags = 1

  • optional google.protobuf.Timestamp from = 2

  • optional google.protobuf.Timestamp to = 3

  • optional Aggregation aggregation = 4

  message GetMetricsManyResponse

  service.proto:39

  • repeated MetricFull metrics = 1

• rpc GetMetricsExpression (GetMetricsExpressionRequest, GetMetricsExpressionResponse)

  service.proto:17

  message GetMetricsExpressionRequest

  service.proto:56

  • optional Expression expression = 1

  • optional google.protobuf.Timestamp from = 2

  • optional google.protobuf.Timestamp to = 3

  • optional google.protobuf.Duration bucket_size = 4

  message GetMetricsExpressionResponse

  service.proto:63

  • repeated Metric metrics = 1

Used in: GetMetricsManyRequest, GetMetricsRequest

• Aggregator aggregator = 1

• optional google.protobuf.Duration bucket_size = 2

Used in: Aggregation, Expression.Leaf

• AGGREGATOR_UNSPECIFIED = 0

• AGGREGATOR_AVG = 1

• AGGREGATOR_MIN = 2

• AGGREGATOR_MAX = 3

• AGGREGATOR_SUM = 4

Used in: Expression.Operation

• BINOP_UNSPECIFIED = 0

• BINOP_ADD = 1

• BINOP_SUB = 2

• BINOP_MULT = 3

• BINOP_DIV = 4

Used in: Expression.Operation, Expression.Sum, Expression.WithDefault, GetMetricsExpressionRequest

• oneof expression

  • Expression.Leaf leaf = 1

  • Expression.Operation operation = 2

  • Expression.Constant constant = 3

  • Expression.WithDefault with_default = 4

  • Expression.Sum sum = 5

Used in: Expression

• double constant = 1

Used in: Expression

• optional Tags tags = 1

• Aggregator aggregator = 2

Used in: Expression

• optional Expression left = 1

• optional Expression right = 2

• BinOp operation = 3

• optional Keys on = 4

• optional Keys ignore = 5

Used in: Expression

• optional Keys on = 1

• optional Keys ignore = 2

• optional Expression expression = 3

Used in: Expression

• optional Expression expression = 1

• double default = 2

Used in: Expression.Operation, Expression.Sum

• bool project = 1

• bool environment = 2

• bool capsule = 3

• bool metric_name = 4

• string cluster = 6

• bool all = 5

Used in: GetMetricsExpressionResponse, GetMetricsResponse, MetricFull

• optional google.protobuf.Timestamp timestamp = 1

• double value = 2

Used in: GetMetricsManyResponse

• optional Metric metric = 1

• optional Tags tags = 2

Used in: Expression.Leaf, GetMetricsManyRequest, GetMetricsRequest, MetricFull

• string project = 1

• string environment = 2

• string capsule = 3

• string metric_name = 4

• string cluster = 5