Skip to main content

Envoy collector

Envoy is an L7 proxy and communication bus designed for large modern service oriented architectures.

This module will monitor one or more Envoy servers, depending on your configuration.

Metrics

All metrics have "envoy." prefix.

MetricScopeDimensionsUnits
server_stategloballive, draining, pre_initializing, initializingstate
server_connections_countglobalconnectionsconnections
server_parent_connections_countglobalconnectionsconnections
server_memory_allocated_sizeglobalallocatedbytes
server_memory_heap_sizeglobalheapbytes
server_memory_physical_sizeglobalphysicalbytes
server_uptimeglobaluptimeseconds
cluster_manager_cluster_countglobalactive, not_activeclusters
cluster_manager_cluster_changes_rateglobaladded, modified, removedclusters/s
cluster_manager_cluster_updates_rateglobalclusterupdates/s
cluster_manager_cluster_updated_via_merge_rateglobalvia_mergeupdates/s
cluster_manager_update_merge_cancelled_rateglobalmerge_cancelledupdates/s
cluster_manager_update_out_of_merge_window_rateglobalout_of_merge_windowupdates/s
cluster_membership_endpoints_countglobalhealthy, degraded, excludedendpoints
cluster_membership_changes_rateglobalmembershipchanges/s
cluster_membership_updates_rateglobalsuccess, failure, empty, no_rebuildupdates/s
cluster_upstream_cx_active_countglobalactiveconnections
cluster_upstream_cx_rateglobalcreatedconnections/s
cluster_upstream_cx_http_rateglobalhttp1, http2, http3connections/s
cluster_upstream_cx_destroy_rategloballocal, remoteconnections/s
cluster_upstream_cx_connect_fail_rateglobalfailedconnections/s
cluster_upstream_cx_connect_timeout_rateglobaltimeoutconnections/s
cluster_upstream_cx_bytes_rateglobalreceived, sentbytes/s
cluster_upstream_cx_bytes_buffered_sizeglobalreceived, sendbytes
cluster_upstream_rq_active_countglobalactiverequests
cluster_upstream_rq_rateglobalrequestsrequests/s
cluster_upstream_rq_failed_rateglobalcancelled, maintenance_mode, timeout, max_duration_reached, per_try_timeout, reset_local, reset_remoterequests/s
cluster_upstream_rq_pending_active_countglobalactive_pendingrequests
cluster_upstream_rq_pending_rateglobalpendingrequests/s
cluster_upstream_rq_pending_failed_rateglobaloverflow, failure_ejectrequests/s
cluster_upstream_rq_retry_rateglobalrequestretries/s
cluster_upstream_rq_retry_success_rateglobalsuccessretries/s
cluster_upstream_rq_retry_backoff_rateglobalexponential, ratelimitedretries/s
listener_manager_listeners_countglobalactive, warming, draininglisteners
listener_manager_listener_changes_rateglobaladded, modified, removed, stoppedlisteners/s
listener_manager_listener_object_events_rateglobalcreate_success, create_failure, in_place_updatedobjects/s
listener_admin_downstream_cx_active_countglobalactiveconnections
listener_admin_downstream_cx_rateglobalcreatedconnections/s
listener_admin_downstream_cx_destroy_rateglobaldestroyedconnections/s
listener_admin_downstream_cx_transport_socket_connect_timeout_rateglobaltimeoutconnections/s
listener_admin_downstream_cx_rejected_rateglobaloverflow, overload, global_overflowconnections/s
listener_admin_downstream_listener_filter_remote_close_rateglobalclosedconnections/s
listener_admin_downstream_listener_filter_error_rateglobalreaderrors/s
listener_admin_downstream_pre_cx_active_countglobalactivesockets
listener_admin_downstream_pre_cx_timeout_rateglobaltimeoutsockets/s
listener_downstream_cx_active_countglobalactiveconnections
listener_downstream_cx_rateglobalcreatedconnections/s
listener_downstream_cx_destroy_rateglobaldestroyedconnections/s
listener_downstream_cx_transport_socket_connect_timeout_rateglobaltimeoutconnections/s
listener_downstream_cx_rejected_rateglobaloverflow, overload, global_overflowconnections/s
listener_downstream_listener_filter_remote_close_rateglobalclosedconnections/s
listener_downstream_listener_filter_error_rateglobalreaderrors/s
listener_downstream_pre_cx_active_countglobalactivesockets
listener_downstream_pre_cx_timeout_rateglobaltimeoutsockets/s

Configuration

Edit the go.d/envoy.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/envoy.conf

Needs only url to server's /stats/prometheus endpoint. Here is an example for 2 servers:

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

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

For all available options please see module configuration file.

Troubleshooting

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

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