telegraf/plugins/inputs/kubernetes/README.md

1.2 KiB

Kubernetes Input Plugin

The kubernetes plugin uses the docker remote API to gather metrics on running docker containers. You can read Docker's documentation for their remote API here

It then decorates those metrics with the kubernetes labels (and docker labels).

The kubernetes plugin uses the excellent fsouza go-dockerclient library to gather stats. Documentation for the library can be found here and documentation for the stat structure can be found here

Configuration:

# Read metrics about docker containers
[[inputs.kubernetes]]
  # Docker Endpoint
  #   To use TCP, set endpoint = "tcp://[ip]:[port]"
  #   To use environment variables (ie, docker-machine), set endpoint = "ENV"
  endpoint = "unix:///var/run/docker.sock"
  # Only collect metrics for these containers, collect all if empty
  container_names = []

Measurements & Fields:

Please see the docker input plugin for detailed list of measurements.