Skip to content

Latest commit

 

History

History
 
 

etcd

README.md

Etcd Integration

Etcd Dashboard

Overview

Collect Etcd metrics to:

  • Monitor the health of your Etcd cluster.
  • Know when host configurations may be out of sync.
  • Correlate the performance of Etcd with the rest of your applications.

Setup

Installation

The Etcd check is included in the Datadog Agent package, so you don't need to install anything else on your Etcd instance(s).

Configuration

Host

To configure this check for an Agent running on a host:

Metric collection
  1. Edit the etcd.d/conf.yaml file, in the conf.d/ folder at the root of your Agent's configuration directory to start collecting your Etcd performance data. See the sample etcd.d/conf.yaml for all available configuration options.
  2. Restart the Agent
Log collection

  1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

    logs_enabled: true

  2. Uncomment and edit this configuration block at the bottom of your etcd.d/conf.yaml:

    logs:
  - type: file
    path: "<LOG_FILE_PATH>"
    source: etcd
    service: "<SERVICE_NAME>"

    Change the path and service parameter values based on your environment. See the sample etcd.d/conf.yaml for all available configuration options.

  3. Restart the Agent.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Metric collection
Parameter Value
<INTEGRATION_NAME> etcd
<INIT_CONFIG> blank or {}
<INSTANCE_CONFIG> {"prometheus_url": "http://%%host%%:2379/metrics"}
Log collection

Collecting logs is disabled by default in the Datadog Agent. To enable it, see Kubernetes log collection.

Parameter Value
<LOG_CONFIG> {"source": "etcd", "service": "<SERVICE_NAME>"}

Validation

Run the Agent's status subcommand and look for etcd under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Etcd metrics are tagged with etcd_state:leader or etcd_state:follower, depending on the node status, so you can easily aggregate metrics by status.

Events

The Etcd check does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.

Further Reading