Metric Service

import { PanelContent, PanelContentCode, } from “@theme/Panel”;

Service to manage telemetry metrics.

Metrics

The Metrics service exposes methods to manage Telemetry Metrics from Telemetry Sources.

GetMetric

rpc GetMetric (tetrateio.api.tsb.observability.telemetry.v2.GetMetricRequest) returns (tetrateio.api.tsb.observability.telemetry.v2.Metric)

Get the details of an existing telemetry metric.

ListMetrics

rpc ListMetrics (tetrateio.api.tsb.observability.telemetry.v2.ListMetricsRequest) returns (tetrateio.api.tsb.observability.telemetry.v2.ListMetricsResponse)

List the telemetry metrics that are available for the requested telemetry source.

GetMetricRequest

Request to retrieve a telemetry metric from a parent telemetry source resource.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the telemetry metric.

string = {
  min_len: 1
}

ListMetricsRequest

Request to retrieve the list of telemetry metrics from a parent telemetry source resource.

Field Description Validation Rule

parent

string
REQUIRED
Fully-qualified name of the parent telemetry source resource to retrieve the telemetry metrics.

string = {
  min_len: 1
}

ListMetricsResponse

List of telemetry metrics from the resource.

Field Description Validation Rule

metrics

List of tetrateio.api.tsb.observability.telemetry.v2.Metric