Metrics service

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

config/metrics/v2/metrics_service.proto

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.

Example:

  1. stats_sinks:
  2. - name: envoy.stat_sinks.metrics_service
  3. typed_config:
  4. "@type": type.googleapis.com/envoy.config.metrics.v3.MetricsServiceConfig
  5. transport_api_version: V3

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:

  1. {
  2. "grpc_service": "{...}",
  3. "transport_api_version": "...",
  4. "report_counters_as_deltas": "{...}",
  5. "emit_tags_as_labels": "..."
  6. }

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.

emit_tags_as_labels

(bool) If true, metrics will have their tags emitted as labels on the metrics objects sent to the MetricsService, and the tag extracted name will be used instead of the full name, which may contain values used by the tag extractor or additional tags added during stats creation.