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.

FieldTypeDescription
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.

namestring

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

tagsToRemovestring[]

(Optional) A list of tags to remove.

matchstring

NOT IMPLEMENTED. (Optional) Conditional enabling the override.

MetricDefinition

FieldTypeDescription
namestring

Metric name.

valuestring

Metric value expression.

typeMetricType

NOT IMPLEMENTED (Optional) Metric type.

MetricType

NameDescription
COUNTER
GAUGE
HISTOGRAM

PluginConfig

FieldTypeDescription
debugbool

next id: 7 The following settings should be rarely used. Enable debug for this filter.

maxPeerCacheSizeint32

maximum size of the peer metadata cache. A long lived proxy that connects with many transient peers can build up a large cache. To turn off the cache, set this field to a negative value.

statPrefixstring

prefix to add to stats emitted by the plugin.

fieldSeparatorstring

Stats api squashes dimensions in a single string. The squashed string is parsed at prometheus scrape time to recover dimensions. The following 2 fields set the field and value separators {key: value} –> key{valueseparator}value{fieldseparator}

valueSeparatorstring

default: “==”

disableHostHeaderFallbackbool

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.

tcpReportingDurationgoogle.protobuf.Duration

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

metricsMetricConfig[]

Metric overrides.

definitionsMetricDefinition[]

Metric definitions.

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

Thanks for your feedback!