Envoy integration for Grafana Cloud

Before you begin

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:

yaml Copy

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

Install Envoy integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find Envoy and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Envoy metrics to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your Envoy setup.

Configuration snippets for Grafana Alloy

Simple mode

These snippets are configured to scrape a single Envoy server with Grafana Alloy running locally.

Copy and paste the following snippets into your Grafana Alloy configuration file.

Metrics snippets

river Copy

discovery.relabel "metrics_integrations_envoy" {
  targets = [{
    __address__ = "localhost:9901",
  }]

  rule {
    target_label = "instance"
    replacement  = constants.hostname
  }
}

prometheus.scrape "metrics_integrations_envoy" {
  targets      = discovery.relabel.metrics_integrations_envoy.output
  forward_to   = [prometheus.remote_write.grafana_cloud.receiver]
  job_name     = "integrations/envoy"
  metrics_path = "/stats/prometheus"
}

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your Envoy nodes, copy and paste the snippets to your configuration file and follow subsequent instructions.

Advanced metrics snippets

river Copy

discovery.relabel "metrics_integrations_envoy" {
  targets = [{
    __address__ = "localhost:9901",
  }]

  rule {
    target_label = "instance"
    replacement  = constants.hostname
  }
}

prometheus.scrape "metrics_integrations_envoy" {
  targets      = discovery.relabel.metrics_integrations_envoy.output
  forward_to   = [prometheus.remote_write.grafana_cloud.receiver]
  job_name     = "integrations/envoy"
  metrics_path = "/stats/prometheus"
}

To monitor an Envoy instance, you must use a discovery.relabel component to discover your Envoy Prometheus endpoint and apply appropriate labels, followed by a prometheus.scrape component to scrape it.

Configure the following properties within the discovery.relabel component:

• __address__: change this from localhost:8080 to the host and port of the Envoy Prometheus metrics endpoint.
• constants.hostname: the snippets set the instance label to your Grafana Alloy server hostname using the constants.hostname variable. If you are running Grafana Alloy outside of your Jenkins server host, change the variable to a value that uniquely identifies it.

If you have multiple Jenkins servers to scrape, configure one discovery.relabel for each and scrape them by including each under targets within the prometheus.scrape component.

Before you begin

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:

yaml Copy

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

Install Envoy integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find Envoy and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Envoy metrics to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your Envoy setup.

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 provided snippet to your agent configuration file.

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

Configuration snippets for Grafana Agent

Below metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:

yaml Copy

    - job_name: integrations/envoy
      metrics_path: /stats/prometheus
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
      static_configs:
        - targets: ['localhost:9901']

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the Envoy integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

yaml Copy

integrations:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/envoy
      metrics_path: /stats/prometheus
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
      static_configs:
        - targets: ['localhost:9901']
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal