etcd integration for Grafana Cloud
etcd is a distributed key-value store that is designed for distributed systems. This integration enables the agent to send metrics to Grafana Cloud along with a useful pre-built dashboard for visualization.
This integration includes 15 useful alerts and 1 pre-built dashboard to help monitor and visualize etcd metrics.
Before you begin
etcd exposes a Prometheus metrics endpoint enabled by default.
Install etcd integration for Grafana Cloud
- In your Grafana Cloud stack, click Connections in the left-hand menu.
- Find etcd and click its tile to open the integration.
- Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send etcd metrics to your Grafana Cloud instance.
- Click Install to add this integration’s pre-built dashboard and alerts to your Grafana Cloud instance, and you can start monitoring your etcd setup.
Configuration snippets for Grafana Alloy
Simple mode
These snippets are configured to scrape a single etcd instance running locally with default ports.
First, manually copy and append the following snippets into your alloy configuration file.
Metrics snippets
discovery.relabel "metrics_integrations_integrations_etcd" {
targets = [{
__address__ = "localhost:2379",
}]
rule {
target_label = "instance"
replacement = constants.hostname
}
}
prometheus.scrape "metrics_integrations_integrations_etcd" {
targets = discovery.relabel.metrics_integrations_integrations_etcd.output
forward_to = [prometheus.remote_write.metrics_service.receiver]
job_name = "integrations/etcd"
}
Advanced mode
The following snippets provide examples to guide you through the configuration process.
To instruct Grafana Alloy to scrape your etcd instances, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.
Advanced metrics snippets
discovery.relabel "metrics_integrations_integrations_etcd" {
targets = [{
__address__ = "localhost:2379",
}]
rule {
target_label = "instance"
replacement = constants.hostname
}
}
prometheus.scrape "metrics_integrations_integrations_etcd" {
targets = discovery.relabel.metrics_integrations_integrations_etcd.output
forward_to = [prometheus.remote_write.metrics_service.receiver]
job_name = "integrations/etcd"
}
To monitor your etcd instance, you must use a discovery.relabel component to discover your etcd Prometheus endpoint and apply appropriate labels, followed by a prometheus.scrape component to scrape it.
Configure the following properties within each discovery.relabel
component:
__address__
: The address to your etcd Prometheus metrics endpoint.instance
label:constants.hostname
sets theinstance
label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this etcd instance.
If you have multiple etcd servers to scrape, configure one discovery.relabel
for each and scrape them by including each under targets
within the prometheus.scrape
component.
Grafana Agent static configuration (deprecated)
The following section shows configuration for running Grafana Agent in static mode which is deprecated. You should use Grafana Alloy for all new deployments.
Before you begin
etcd exposes a Prometheus metrics endpoint enabled by default.
Install etcd integration for Grafana Cloud
- In your Grafana Cloud stack, click Connections in the left-hand menu.
- Find etcd and click its tile to open the integration.
- Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send etcd metrics to your Grafana Cloud instance.
- Click Install to add this integration’s pre-built dashboard and alerts to your Grafana Cloud instance, and you can start monitoring your etcd setup.
Post-install configuration for the etcd integration
You should instruct Grafana Agent to scrape your etcd nodes.
etcd exposes a /metrics
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:
- job_name: integrations/etcd
relabel_configs:
- replacement: '<your-instance-name>'
target_label: instance
static_configs:
- targets: ['localhost:2379']
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 etcd integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.
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/etcd
relabel_configs:
- replacement: '<your-instance-name>'
target_label: instance
static_configs:
- targets: ['localhost:2379']
global:
scrape_interval: 60s
wal_directory: /tmp/grafana-agent-wal
Dashboards
The etcd integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.
- etcd
Alerts
The etcd integration includes the following useful alerts:
Metrics
The most important metrics provided by the etcd integration, which are used on the pre-built dashboard and Prometheus alerts, are as follows:
- etcd_disk_backend_commit_duration_seconds_bucket
- etcd_disk_wal_fsync_duration_seconds_bucket
- etcd_mvcc_db_total_size_in_bytes
- etcd_mvcc_db_total_size_in_use_in_bytes
- etcd_network_client_grpc_received_bytes_total
- etcd_network_client_grpc_sent_bytes_total
- etcd_network_peer_received_bytes_total
- etcd_network_peer_round_trip_time_seconds_bucket
- etcd_network_peer_sent_bytes_total
- etcd_network_peer_sent_failures_total
- etcd_server_has_leader
- etcd_server_leader_changes_seen_total
- etcd_server_proposals_failed_total
- etcd_server_quota_backend_bytes
- grpc_server_handled_total
- grpc_server_handling_seconds_bucket
- grpc_server_started_total
- process_resident_memory_bytes
- up
Changelog
Cost
By connecting your etcd 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.