Metrics service

config.metrics.v3.MetricsServiceConfig

[config.metrics.v3.MetricsServiceConfig proto]

Metrics Service is configured as a built-in envoy.stat_sinks.metrics_service StatsSink. This opaque configuration will be used to create Metrics Service.

This extension may be referenced by the qualified name envoy.stat_sinks.metrics_service

Note

This extension does not operate on the data plane and hence is intended to be robust against untrusted traffic.

Tip

This extension extends and can be used with the following extension category:

• envoy.stats_sinks

{
  "grpc_service": "{...}",
  "transport_api_version": "...",
  "report_counters_as_deltas": "{...}"
}

grpc_service

(config.core.v3.GrpcService, REQUIRED) The upstream gRPC cluster that hosts the metrics service.

transport_api_version

(config.core.v3.ApiVersion) API version for metric service transport protocol. This describes the metric service gRPC endpoint and version of messages used on the wire.

report_counters_as_deltas

(BoolValue) If true, counters are reported as the delta between flushing intervals. Otherwise, the current counter value is reported. Defaults to false. Eventually (https://github.com/envoyproxy/envoy/issues/10968) if this value is not set, the sink will take updates from the MetricsResponse.