Supported telemetry types
The Envoy CXDOT Collector integration supports these telemetry types:Prerequisites
The Envoy CXDOT Collector integration has the following prerequisites:- Configure Envoy to expose metrics at
/stats/prometheus. - Make the Envoy metrics endpoint reachable from the CXDOT Collector.
Configure
The Envoy integration is enabled by default. You can configure targets either by annotating pods in your Kubernetes cluster or by listing static endpoints in your Helm values. To configure the Envoy CXDOT Collector integration, follow these steps:-
To collect from Envoy pods in Kubernetes, add a CXDOT integration annotation to the
pod template. The annotation key must end with the container name. For example, add
the following annotation to your Envoy workload:
The Collector replaces
${target.host}with the pod IP address and${target.port.admin}with the container port namedadmin. The Collector also discovers Envoy pods that carry theapp.kubernetes.io/name: envoylabel and listen on port8001or9901. A CXDOT integration annotation takes precedence over the label for its container. To stop collecting from a container, setenvoy: {enabled: false}in the annotation. For more information, see autodiscovery. -
Optional: To collect from Envoy proxies outside your Kubernetes cluster, configure
static targets. For example, add the following to the
values.yamlfor your Helm chart:When you configure static targets, this integration instance collects from exactly those targets instead of discovered targets. -
Optional: Configure a second integration instance to collect from both annotated
pods and static targets. For example, add the following to the
values.yamlfor your Helm chart:Theenvoy/edgekey defines a named instance for the static targets. The bareenvoykey continues to discover pods.
Validate
To validate the Envoy CXDOT Collector integration, follow these steps:-
In the Live Telemetry Analyzer, filter for
cxdot.integration.name=envoy. Confirm that the Envoy metric names appear. -
In Metrics Explorer, run the following query:
Confirm that the query returns one time series for each Envoy proxy you expect, with the scraped URL in the
cxdot.integration.targetattribute, and that each reachable proxy reports1. -
In Metrics Explorer, run the following query:
Confirm that every Envoy proxy you expect appears in the results.
Configuration reference
Configure one Envoy integration instance with the following settings. In Helm values, place these settings undercollection.cxdot.integrations.envoy. In a Collector configuration file,
place them under cxdot.integrations.envoy.
Optional settings
-
enabledType:boolean. Optional. Default:true. Whether to enable this Envoy integration instance. If true, the Collector collects metrics from Envoy targets. If false, it doesn’t run this integration instance. -
endpointsType:array of object. Optional. Default:[]. Envoy targets ashost:portvalues or complete HTTP or HTTPS URLs. Forhost:port, the Collector requests/stats/prometheusover HTTP. -
endpoints[].endpointType:string. Required. Envoy target ashost:portor a complete HTTP or HTTPS URL. Forhost:port, the Collector requests/stats/prometheusover HTTP. -
collection_intervalType:duration. Optional. Default:10s. How often the Collector requests metrics from each Envoy target. -
timeoutType:duration. Optional. Default:10s. Maximum time the Collector waits for an Envoy metrics request to complete. -
max_samplesType:integer. Optional. Default:0. Minimum:0. Maximum number of samples accepted from one metric collection. A value of0, the default, means no limit. A collection that exceeds the limit fails and reportsupas0instead of returning an incomplete set of samples. -
follow_redirectsType:boolean. Optional. Default:true. Whether to follow HTTP redirects. If true, the Collector follows redirects. If false, a redirect causes the metric collection to fail. -
metricsType:object. Optional. Settings for collecting and naming Envoy metrics. -
metrics.includeType:array of string. Optional. Default:[]. Metrics to collect, in addition to the default set. Each entry is a regular expression matched against the metric name. -
metrics.excludeType:array of string. Optional. Default:[]. Metrics to drop, matched the same way asinclude. Applied afterwards, so it subtracts from whatincludechose. -
metrics.renameType:object. Optional. Default:{}. Renames metrics, as{old: new}. User-configured renames take precedence over default renames. -
labelsType:object. Optional. Which samples to drop, by label value. -
labels.sample_drop_rulesType:object. Optional. Default:{}. Drops a whole sample when one of its labels matches. Each key is a label name. The value is a list of regular expressions matched against the label’s value. To drop every sample the label appears on with a non-empty value, use".+".