observability.proto | Tigris Documentation

`observability.proto`

path server/v1/observability.proto

package tigrisdata.observability.v1

Messages

`AdditionalFunction`

Additional function to apply on metrics query

Name	Type	Description
`rollup`	`RollupFunction`

`DataPoint`

Represents the data point in timeseries.

Name	Type	Description
`timestamp`	`int64`
`value`	`double`

`MetricSeries`

Represents series in timeseries based on input query.

Name	Type	Description
`from`	`int64`
`to`	`int64`
`metric`	`string`
`scope`	`string`
`dataPoints`	`DataPoint`

`QueryTimeSeriesMetricsRequest`

Requests the time series metrics

Name	Type	Description
`db`	`string`
`collection`	`string`
`from`	`int64`
`to`	`int64`
`metric_name`	`string`
`tigris_operation`	`TigrisOperation`
`space_aggregation`	`MetricQuerySpaceAggregation`
`space_aggregated_by`	`string`
`function`	`MetricQueryFunction`
`quantile`	`float`
`additionalFunctions`	`AdditionalFunction`

`QueryTimeSeriesMetricsResponse`

QueryTimeSeriesMetric responds with this type.

Name	Type	Description
`from`	`int64`
`to`	`int64`
`query`	`string`
`series`	`MetricSeries`

`RollupFunction`

Rollup function aggregates the slices of metrics returned by original query and lets you operate on the slices using aggregator and constructs the bigger slice of your choice of interval (specified in seconds).

Name	Type	Description
`aggregator`	`RollupAggregator`
`interval`	`int64`

Enums

`MetricQueryFunction`

Function to apply on metrics query

Name	Number	Description
`RATE`	`0`
`COUNT`	`1`
`NONE`	`2`

`MetricQuerySpaceAggregation`

Specifies how the metric should be aggregated for the time slices.

Name	Number	Description
`AVG`	`0`
`MIN`	`1`
`MAX`	`2`
`SUM`	`3`

`RollupAggregator`

Specifies how the initial query's result buckets should be processed in next stage.

Name	Number	Description
`ROLLUP_AGGREGATOR_SUM`	`0`
`ROLLUP_AGGREGATOR_COUNT`	`1`
`ROLLUP_AGGREGATOR_MIN`	`2`
`ROLLUP_AGGREGATOR_MAX`	`3`
`ROLLUP_AGGREGATOR_AVG`	`4`

`TigrisOperation`

Represents Tigris operation category

Name	Number	Description
`ALL`	`0`
`READ`	`1`
`WRITE`	`2`

Services

`Observability`

`QueryTimeSeriesMetrics`

Method	`QueryTimeSeriesMetrics`
Request	`QueryTimeSeriesMetricsRequest`
Response	`QueryTimeSeriesMetricsResponse`
Description	Queries time series metrics