Stats Config

2 minute read

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.

Field	Type	Description	Required
`dimensions`	`map<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
`name`	`string`	(Optional) Metric name to restrict the override to a metric. If not specified, applies to all.	No
`tags_to_remove`	`string[]`	(Optional) A list of tags to remove.	No
`match`	`string`	NOT IMPLEMENTED. (Optional) Conditional enabling the override.	No

MetricDefinition

Field	Type	Description	Required
`name`	`string`	Metric name.	No
`value`	`string`	Metric value expression.	No
`type`	`MetricType`	NOT IMPLEMENTED (Optional) Metric type.	No

PluginConfig

Field	Type	Description	Required
`debug`	`bool`	next id: 7 The following settings should be rarely used. Enable debug for this filter. DEPRECATED.	No
`max_peer_cache_size`	`int32`	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. DEPRECATED.	No
`stat_prefix`	`string`	prefix to add to stats emitted by the plugin. DEPRECATED.	No
`field_separator`	`string`	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}	No
`value_separator`	`string`	default: “==”	No
`disable_host_header_fallback`	`bool`	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_duration`	`Duration`	Optional. Allows configuration of the time between calls out to for TCP metrics reporting. The default duration is `15s`.	No
`metrics`	`MetricConfig[]`	Metric overrides.	No
`definitions`	`MetricDefinition[]`	Metric definitions.	No

MetricType

Name	Description
`COUNTER`
`GAUGE`
`HISTOGRAM`

Was this information useful?

Do you have any suggestions for improvement?

Thanks for your feedback!