https://github.com/patrickap/docker-exporter
A Prometheus metrics collector for containerized environments. ðŸ¤
https://github.com/patrickap/docker-exporter
docker exporter metrics prometheus rust
Last synced: 4 months ago
JSON representation
A Prometheus metrics collector for containerized environments. ðŸ¤
- Host: GitHub
- URL: https://github.com/patrickap/docker-exporter
- Owner: patrickap
- License: mit
- Created: 2024-03-16T22:09:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-04T08:50:27.000Z (5 months ago)
- Last Synced: 2025-02-09T01:09:09.620Z (4 months ago)
- Topics: docker, exporter, metrics, prometheus, rust
- Language: Rust
- Homepage:
- Size: 256 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# docker-exporter
A Prometheus metrics collector for Docker, similar to `node-exporter` but designed for containerized environments, offering a simpler alternative to `cadvisor` with lower resource consumption.
## Available metrics
- `docker_exporter_state_running_boolean`
- `docker_exporter_state_healthy_boolean`
- `docker_exporter_cpu_utilization_percent`
- `docker_exporter_memory_usage_bytes`
- `docker_exporter_memory_limit_bytes`
- `docker_exporter_memory_utilization_percent`
- `docker_exporter_block_io_tx_bytes_total`
- `docker_exporter_block_io_rx_bytes_total`
- `docker_exporter_network_tx_bytes_total`
- `docker_exporter_network_rx_bytes_total`
## Getting started
To get started with Docker-Exporter, follow these steps:
1. Pull the Docker-Exporter image from the official Docker Hub repository and run the container with the specified configurations:
```bash
docker run -d \
--name docker-exporter \
--restart always \
-p 9630:9630 \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
patrickap/docker-exporter:latest
```
Alternatively, you can use Docker Compose:
```yml
version: "3.7"
services:
docker-exporter:
image: patrickap/docker-exporter:latest
restart: always
ports: 9630:9630
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
```
2. The metrics are now available at `localhost:9630/metrics`
## Contribution
To start the local development server, execute `cargo run`. You can access the metrics by navigating to `http://0.0.0.0:9630/metrics` in your browser. To run the tests, use the command `cargo test`. For building and releasing the Docker image, run `just release `, which will automatically increment the version.