Stats Config

MetricConfig

Metric instance configuration overrides. The metric value and the metric type are optional and permit changing the reported value for an existing metric. The standard metrics are optimized and reported through a “fast-path”. The customizations allow full configurability, at the cost of a “slower” path.

FieldTypeDescriptionRequired
dimensionsmap<string, string>

(Optional) Collection of tag names and tag expressions to include in the metric. Conflicts are resolved by the tag name by overriding previously supplied values.

No
namestring

(Optional) Metric name to restrict the override to a metric. If not specified, applies to all.

No
tags_to_removestring[]

(Optional) A list of tags to remove.

No
matchstring

NOT IMPLEMENTED. (Optional) Conditional enabling the override.

No
dropbool

(Optional) If this is set to true, the metric(s) selected by this configuration will not be generated or reported.

No

MetricDefinition

FieldTypeDescriptionRequired
namestring

Metric name.

No
valuestring

Metric value expression.

No
typeMetricType

Metric type.

No

PluginConfig

FieldTypeDescriptionRequired
disable_host_header_fallbackbool

Optional: Disable using host header as a fallback if destination service is not available from the controlplane. Disable the fallback if the host header originates outsides the mesh, like at ingress.

No
tcp_reporting_durationDuration

Optional. Allows configuration of the time between calls out to for TCP metrics reporting. The default duration is 5s.

No
metricsMetricConfig[]

Metric overrides.

No
definitionsMetricDefinition[]

Metric definitions.

No
reporterReporter

Proxy deployment type.

No
rotation_intervalDuration

Metric scope rotation interval. Set to 0 to disable the metric scope rotation. Defaults to 0.

No
graceful_deletion_intervalDuration

Metric expiry graceful deletion interval. No-op if the metric rotation is disabled. Defaults to 5m. Must be >=1s.

No

MetricType

NameDescription
COUNTER
GAUGE
HISTOGRAM

Reporter

Specifies the proxy deployment type.

NameDescription
UNSPECIFIED

Default value is inferred from the listener direction, as either client or server sidecar.

SERVER_GATEWAY

Shared server gateway, e.g. “waypoint”.

Was this information useful?
Do you have any suggestions for improvement?

Thanks for your feedback!