Grafana Cloud Data configuration Grafana integrations Integrations reference Envoy integration

Envoy integration for Grafana Cloud

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

Pre-install configuration for the Envoy integration

To enable the Prometheus metrics endpoint, you need to activate (Envoy’s admin interface)[https://www.envoyproxy.io/docs/envoy/latest/start/quick-start/admin#admin].

To do so, add the following snippet to your node configuration file:

admin:
  address:
    socket_address:
      address: 0.0.0.0
      port_value: 9901

Install Envoy integration for Grafana Cloud

1. In your Grafana Cloud instance, click Integrations and Connections (lightning bolt icon).
2. Navigate to the Envoy tile and review the prerequisites. Then click Install integration.
3. Once the integration is installed, follow the steps on the Configuration Details page to setup Grafana Agent and start sending Envoy metrics to your Grafana Cloud instance.

Post-install configuration for the Envoy integration

Instruct Grafana Agent to scrape your Envoy nodes.

Envoy exposes a /stats/prometheus endpoint. To scrape it, add the snippet below to your agent configuration file.

Make sure to change targets in the snippet according to your environment.

metrics:
  - name: integrations   
    scrape_configs:
    - job_name: integrations/envoy
      metrics_path: /stats/prometheus
      static_configs:
        - targets: ['localhost:9901']    

Dashboards

The Envoy integration installs the following dashboard in your Grafana Cloud instance to help monitor your metrics.

• Envoy Overview

Metrics

The following metrics are automatically written to your Grafana Cloud instance by connecting your Envoy instance through this integration:

• envoy_cluster_upstream_cx_active
• envoy_cluster_upstream_cx_total
• envoy_cluster_upstream_rq_active
• envoy_cluster_upstream_rq_time_bucket
• envoy_cluster_upstream_rq_time_count
• envoy_cluster_upstream_rq_time_sum
• envoy_cluster_upstream_rq_timeout
• envoy_cluster_upstream_rq_total
• envoy_cluster_upstream_rq_xx
• envoy_cluster_version
• envoy_http_downstream_cx_active
• envoy_http_downstream_rq_active
• envoy_http_downstream_rq_time_bucket
• envoy_http_downstream_rq_time_count
• envoy_http_downstream_rq_time_sum
• envoy_http_downstream_rq_timeout
• envoy_http_downstream_rq_total
• envoy_http_downstream_rq_xx
• envoy_listener_downstream_cx_total
• envoy_server_uptime

Changelog

# 0.0.3 - October 2022

* Adding instructions to enable the Prometheus metrics endpoint

# 0.0.2 - September 2022

* Update mixin to latest version:
  - Update the datasource template variable label to 'Data Source'

# 0.0.1 - October 2021

* Initial release

Cost

By connecting your Envoy instance to Grafana Cloud you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.