Open Telemetry Stats Sink (proto)

This extension has the qualified name envoy.stat_sinks.open_telemetry

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

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:

This extension must be configured with one of the following type URLs:

Stats configuration proto schema for envoy.stat_sinks.open_telemetry sink.

extensions.stat_sinks.open_telemetry.v3.SinkConfig

[extensions.stat_sinks.open_telemetry.v3.SinkConfig proto]

{
  "grpc_service": {...},
  "report_counters_as_deltas": ...,
  "report_histograms_as_deltas": ...,
  "emit_tags_as_attributes": {...},
  "use_tag_extracted_name": {...},
  "prefix": ...
}
grpc_service

(config.core.v3.GrpcService, REQUIRED) The upstream gRPC cluster that implements the OTLP/gRPC collector.

report_counters_as_deltas

(bool) If set to true, counters will be emitted as deltas, and the OTLP message will have AGGREGATION_TEMPORALITY_DELTA set as AggregationTemporality.

report_histograms_as_deltas

(bool) If set to true, histograms will be emitted as deltas, and the OTLP message will have AGGREGATION_TEMPORALITY_DELTA set as AggregationTemporality.

emit_tags_as_attributes

(BoolValue) If set to true, metrics will have their tags emitted as OTLP attributes, which may contain values used by the tag extractor or additional tags added during stats creation. Otherwise, no attributes will be associated with the export message. Default value is true.

use_tag_extracted_name

(BoolValue) If set to true, metric names will be represented as the tag extracted name instead of the full metric name. Default value is true.

prefix

(string) If set, emitted stats names will be prepended with a prefix, so full stat name will be <prefix>.<stats_name>. For example, if the stat name is “foo.bar” and prefix is “pre”, the full stat name will be “pre.foo.bar”. If this field is not set, there is no prefix added. According to the example, the full stat name will remain “foo.bar”.