/docker_state_exporter

Exporter for docker container state

Primary LanguageGoMIT LicenseMIT

Docker State Exporter

Exporter for docker container state

Prometheus exporter for docker container state, written in Go.

One of the best known exporters of docker container information is cAdvisor.
However, cAdvisor does not export the state of the container.

This exporter will only export the container status and the restarts count.

Installation and Usage

The docker_state_exporter listens on HTTP port 8080 by default.

Docker

For Docker run.

sudo docker run -d \
  -v "/var/run/docker.sock:/var/run/docker.sock" \
  -p 8080:8080 \
  $REPO/docker_state_exporter \
  --web.listen-address=:8080

For Docker compose.

---
version: '3.8'

services:
  docker_state_exporter:
    image: $REPO/docker_state_exporter
    volumes:
      - type: bind
        source: /var/run/docker.sock
        target: /var/run/docker.sock
    ports:
      - "8080:8080"

Metrics

This exporter will export the following metrics.

  • container_state_health_status
  • container_state_status
  • container_state_oomkilled
  • container_state_startedat
  • container_state_finishedat
  • container_restartcount

These metrics will be the same as the results of docker inspect.

This exporter also exports the standard Go Collector and Process Collector.

Performance

The polling of docker inspect commands is set to every one second.

TODO: Include container last seen metric - should still show even if container does not exist anymore

Build the go binary and container

git clone https://github.com/AdaptiveConsulting/docker_state_exporter
cd docker_state_exporter
docker build . -t docker_state_exporter_test

Run

sudo docker run -d \
  -v "/var/run/docker.sock:/var/run/docker.sock" \
  -p 8080:8080 \
  docker_state_exporter_test \
  --web.listen-address=:8080