Skip to main content

Envoy

Plugin: go.d.plugin Module: envoy

Overview

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.

Default Behavior

Auto-Detection

By default, it detects Envoy instances running on localhost.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Envoy instance

Envoy exposes metrics in Prometheus format. All metric labels are added to charts.

This scope has no labels.

Metrics:

MetricDimensionsUnit
envoy.server_statelive, draining, pre_initializing, initializingstate
envoy.server_connections_countconnectionsconnections
envoy.server_parent_connections_countconnectionsconnections
envoy.server_memory_allocated_sizeallocatedbytes
envoy.server_memory_heap_sizeheapbytes
envoy.server_memory_physical_sizephysicalbytes
envoy.server_uptimeuptimeseconds
envoy.cluster_manager_cluster_countactive, not_activeclusters
envoy.cluster_manager_cluster_changes_rateadded, modified, removedclusters/s
envoy.cluster_manager_cluster_updates_rateclusterupdates/s
envoy.cluster_manager_cluster_updated_via_merge_ratevia_mergeupdates/s
envoy.cluster_manager_update_merge_cancelled_ratemerge_cancelledupdates/s
envoy.cluster_manager_update_out_of_merge_window_rateout_of_merge_windowupdates/s
envoy.cluster_membership_endpoints_counthealthy, degraded, excludedendpoints
envoy.cluster_membership_changes_ratemembershipchanges/s
envoy.cluster_membership_updates_ratesuccess, failure, empty, no_rebuildupdates/s
envoy.cluster_upstream_cx_active_countactiveconnections
envoy.cluster_upstream_cx_ratecreatedconnections/s
envoy.cluster_upstream_cx_http_ratehttp1, http2, http3connections/s
envoy.cluster_upstream_cx_destroy_ratelocal, remoteconnections/s
envoy.cluster_upstream_cx_connect_fail_ratefailedconnections/s
envoy.cluster_upstream_cx_connect_timeout_ratetimeoutconnections/s
envoy.cluster_upstream_cx_bytes_ratereceived, sentbytes/s
envoy.cluster_upstream_cx_bytes_buffered_sizereceived, sendbytes
envoy.cluster_upstream_rq_active_countactiverequests
envoy.cluster_upstream_rq_raterequestsrequests/s
envoy.cluster_upstream_rq_failed_ratecancelled, maintenance_mode, timeout, max_duration_reached, per_try_timeout, reset_local, reset_remoterequests/s
envoy.cluster_upstream_rq_pending_active_countactive_pendingrequests
envoy.cluster_upstream_rq_pending_ratependingrequests/s
envoy.cluster_upstream_rq_pending_failed_rateoverflow, failure_ejectrequests/s
envoy.cluster_upstream_rq_retry_raterequestretries/s
envoy.cluster_upstream_rq_retry_success_ratesuccessretries/s
envoy.cluster_upstream_rq_retry_backoff_rateexponential, ratelimitedretries/s
envoy.listener_manager_listeners_countactive, warming, draininglisteners
envoy.listener_manager_listener_changes_rateadded, modified, removed, stoppedlisteners/s
envoy.listener_manager_listener_object_events_ratecreate_success, create_failure, in_place_updatedobjects/s
envoy.listener_admin_downstream_cx_active_countactiveconnections
envoy.listener_admin_downstream_cx_ratecreatedconnections/s
envoy.listener_admin_downstream_cx_destroy_ratedestroyedconnections/s
envoy.listener_admin_downstream_cx_transport_socket_connect_timeout_ratetimeoutconnections/s
envoy.listener_admin_downstream_cx_rejected_rateoverflow, overload, global_overflowconnections/s
envoy.listener_admin_downstream_listener_filter_remote_close_rateclosedconnections/s
envoy.listener_admin_downstream_listener_filter_error_ratereaderrors/s
envoy.listener_admin_downstream_pre_cx_active_countactivesockets
envoy.listener_admin_downstream_pre_cx_timeout_ratetimeoutsockets/s
envoy.listener_downstream_cx_active_countactiveconnections
envoy.listener_downstream_cx_ratecreatedconnections/s
envoy.listener_downstream_cx_destroy_ratedestroyedconnections/s
envoy.listener_downstream_cx_transport_socket_connect_timeout_ratetimeoutconnections/s
envoy.listener_downstream_cx_rejected_rateoverflow, overload, global_overflowconnections/s
envoy.listener_downstream_listener_filter_remote_close_rateclosedconnections/s
envoy.listener_downstream_listener_filter_error_ratereaderrors/s
envoy.listener_downstream_pre_cx_active_countactivesockets
envoy.listener_downstream_pre_cx_timeout_ratetimeoutsockets/s

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

No action required.

Configuration

File

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 config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/envoy.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.1no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
urlServer URL.http://127.0.0.1:9091/stats/prometheusyes
timeoutHTTP request timeout.1no
usernameUsername for basic HTTP authentication.no
passwordPassword for basic HTTP authentication.no
proxy_urlProxy URL.no
proxy_usernameUsername for proxy basic HTTP authentication.no
proxy_passwordPassword for proxy basic HTTP authentication.no
methodHTTP request method.GETno
bodyHTTP request body.no
headersHTTP request headers.no
not_follow_redirectsRedirect handling policy. Controls whether the client follows redirects.nono
tls_skip_verifyServer certificate chain and hostname validation policy. Controls whether the client performs this check.nono
tls_caCertification authority that the client uses when verifying the server's certificates.no
tls_certClient TLS certificate.no
tls_keyClient TLS key.no

Examples

Basic

A basic example configuration.

jobs:
- name: local
url: http://127.0.0.1:9901/stats/prometheus

HTTP authentication

Basic HTTP authentication.

Config
jobs:
- name: local
url: http://127.0.0.1:9901/stats/prometheus
username: username
password: password

HTTPS with self-signed certificate

Do not validate server certificate chain and hostname.

Config
jobs:
- name: local
url: https://127.0.0.1:9901/stats/prometheus
tls_skip_verify: yes

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

Config
jobs:
- name: local
url: http://127.0.0.1:9901/stats/prometheus

- name: remote
url: http://192.0.2.1:9901/stats/prometheus

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

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

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m envoy

Getting Logs

If you're encountering problems with the envoy collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep envoy

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep envoy /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep envoy

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.