Project: Netdata (Observability and Analysis / Observability)
File: envoy.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/envoy/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/envoy/metadata.yaml" sidebar_label: "Envoy" learn_status: "Published" learnrelpath: "Collecting Metrics/Web Servers and Web Proxies" most_popular: True message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/envoy.svg" width="150"/> Plugin: go.d.plugin Module: envoy <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors Envoy proxies. It collects server, cluster, and listener metrics. This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. By default, it detects Envoy instances running on localhost. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. Envoy exposes metrics in Prometheus format. All metric labels are added to charts. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | envoy.serverstate | live, draining, preinitializing, initializing | state | | envoy.serverconnectionscount | connections | connections | | envoy.serverparentconnections_count | connections | connections | | envoy.servermemoryallocated_size | allocated | bytes | | envoy.servermemoryheap_size | heap | bytes | | envoy.servermemoryphysical_size | physical | bytes | | envoy.server_uptime | uptime | seconds | | envoy.clustermanagerclustercount | active, notactive | clusters | | envoy.clustermanagerclusterchangesrate | added, modified, removed | clusters/s | | envoy.clustermanagerclusterupdatesrate | cluster | updates/s | | envoy.clustermanagerclusterupdatedviamergerate | via_merge | updates/s | | envoy.clustermanagerupdatemergecancelledrate | mergecancelled | updates/s | | envoy.clustermanagerupdateoutofmergewindowrate | outofmergewindow | updates/s | | envoy.clustermembershipendpoints_count | healthy, degraded, excluded | endpoints | | envoy.clustermembershipchanges_rate | membership | changes/s | | envoy.clustermembershipupdatesrate | success, failure, empty, norebuild | updates/s | | envoy.clusterupstreamcxactivecount | active | connections | | envoy.clusterupstreamcx_rate | created | connections/s | | envoy.clusterupstreamcxhttprate | http1, http2, http3 | connections/s | | envoy.clusterupstreamcxdestroyrate | local, remote | connections/s | | envoy.clusterupstreamcxconnectfail_rate | failed | connections/s | | envoy.clusterupstreamcxconnecttimeout_rate | timeout | connections/s | | envoy.clusterupstreamcxbytesrate | received, sent | bytes/s | | envoy.clusterupstreamcxbytesbuffered_size | received, send | bytes | | envoy.clusterupstreamrqactivecount | active | requests | | envoy.clusterupstreamrq_rate | requests | requests/s | | envoy.clusterupstreamrqfailedrate | cancelled, maintenancemode, timeout, maxdurationreached, pertrytimeout, resetlocal, reset_remote | requests/s | | envoy.clusterupstreamrqpendingactivecount | activepending | requests | | envoy.clusterupstreamrqpendingrate | pending | requests/s | | envoy.clusterupstreamrqpendingfailedrate | overflow, failureeject | requests/s | | envoy.clusterupstreamrqretryrate | request | retries/s | | envoy.clusterupstreamrqretrysuccess_rate | success | retries/s | | envoy.clusterupstreamrqretrybackoff_rate | exponential, ratelimited | retries/s | | envoy.listenermanagerlisteners_count | active, warming, draining | listeners | | envoy.listenermanagerlistenerchangesrate | added, modified, removed, stopped | listeners/s | | envoy.listenermanagerlistenerobjecteventsrate | createsuccess, createfailure, inplace_updated | objects/s | | envoy.listeneradmindownstreamcxactive_count | active | connections | | envoy.listeneradmindownstreamcxrate | created | connections/s | | envoy.listeneradmindownstreamcxdestroy_rate | destroyed | connections/s | | envoy.listeneradmindownstreamcxtransportsocketconnecttimeoutrate | timeout | connections/s | | envoy.listeneradmindownstreamcxrejectedrate | overflow, overload, globaloverflow | connections/s | | envoy.listeneradmindownstreamlistenerfilterremoteclose_rate | closed | connections/s | | envoy.listeneradmindownstreamlistenerfiltererrorrate | read | errors/s | | envoy.listeneradmindownstreamprecxactivecount | active | sockets | |

| timeout | sockets/s | | envoy.listenerdownstreamcxactivecount | active | connections | | envoy.listenerdownstreamcx_rate | created | connections/s | | envoy.listenerdownstreamcxdestroyrate | destroyed | connections/s | | envoy.listenerdownstreamcxtransportsocketconnecttimeout_rate | timeout | connections/s | | envoy.listenerdownstreamcxrejectedrate | overflow, overload, global_overflow | connections/s | | envoy.listenerdownstreamlistenerfilterremotecloserate | closed | connections/s | | envoy.listenerdownstreamlistenerfiltererror_rate | read | errors/s | | envoy.listenerdownstreamprecxactive_count | active | sockets | | envoy.listenerdownstreamprecxtimeout_rate | timeout | sockets/s | There are no alerts configured by default for this integration. No action required. The configuration file name for this integration is `go.d/envoy.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/envoy.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 1 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | url | Server URL. | http://127.0.0.1:9091/stats/prometheus | yes | | timeout | HTTP request timeout. | 1 | no | | username | Username for basic HTTP authentication. | | no | | password | Password for basic HTTP authentication. | | no | | proxy_url | Proxy URL. | | no | | proxy_username | Username for proxy basic HTTP authentication. | | no | | proxy_password | Password for proxy basic HTTP authentication. | | no | | method | HTTP request method. | GET | no | | body | HTTP request body. | | no | | headers | HTTP request headers. | | no | | notfollowredirects | Redirect handling policy. Controls whether the client follows redirects. | no | no | | tlsskipverify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no | | tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no | | tls_cert | Client TLS certificate. | | no | | tls_key | Client TLS key. | | no | </details> A basic example configuration. ```yaml jobs: name: local url: http://127.0.0.1:9901/stats/prometheus ``` Basic HTTP authentication. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1:9901/stats/prometheus username: username password: password ``` </details> Do not validate server certificate chain and hostname. <details><summary>Config</summary> ```yaml jobs: name: local url: https://127.0.0.1:9901/stats/prometheus tlsskipverify: yes ``` </details> Note: When you define multiple jobs, their names must be unique. Collecting metrics from local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1:9901/stats/prometheus name: remote url: http://192.0.2.1:9901/stats/prometheus ``` </details> To troubleshoot issues with the `envoy` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m envoy ```