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
`drop`	`bool`	(Optional) If this is set to true, the metric(s) selected by this configuration will not be generated or reported.	No

MetricDefinition

Field	Type	Description	Required
`name`	`string`	Metric name.	No
`value`	`string`	Metric value expression.	No
`type`	`MetricType`	Metric type.	No

PluginConfig

Field	Type	Description	Required
`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 `5s`.	No
`metrics`	`MetricConfig[]`	Metric overrides.	No
`definitions`	`MetricDefinition[]`	Metric definitions.	No
`reporter`	`Reporter`	Proxy deployment type.	No
`rotation_interval`	`Duration`	Metric scope rotation interval. Set to 0 to disable the metric scope rotation. Defaults to 0.	No
`graceful_deletion_interval`	`Duration`	Metric expiry graceful deletion interval. No-op if the metric rotation is disabled. Defaults to 5m. Must be >=1s.	No

MetricType

Name	Description
`COUNTER`
`GAUGE`
`HISTOGRAM`

Reporter

Specifies the proxy deployment type.

Name	Description
`UNSPECIFIED`	Default value is inferred from the listener direction, as either client or server sidecar.
`SERVER_GATEWAY`	Shared server gateway, e.g. “waypoint”.