https://github.com/logzio/telegraf-docker-collector-metrics
https://github.com/logzio/telegraf-docker-collector-metrics
integration
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/logzio/telegraf-docker-collector-metrics
- Owner: logzio
- License: apache-2.0
- Created: 2022-05-17T15:32:10.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-04-06T10:53:31.000Z (2 months ago)
- Last Synced: 2025-04-06T11:29:25.286Z (2 months ago)
- Topics: integration
- Language: Python
- Homepage:
- Size: 38.1 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Metrics Collector
To simplify shipping metrics from one or many sources, we created Telegraf Docker Metrics Collector. Telegraf Docker Metrics Collector is a container that runs Telegraf collector.
## 1. Pull the Docker image
```sh
docker pull logzio/docker-metrics-collector:latest
```
## 2. Run the collector
```sh
docker run --name docker-metrics-collector \
--env METRICS_TOKEN="<>" \
--env LOGZIO_LISTENER="<>" \
-v /var/run/docker.sock:/var/run/docker.sock \
logzio/docker-metrics-collector:latest
```
If you prefer to store these environment variables in an [`.env` file](./docker.env), run the following command:
```sh
docker run -d --env-file=docker.env -v /var/run/docker.sock:/var/run/docker.sock logzio/docker-metrics-collector:latest
```
| Name | Description |
|---------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| METRICS_TOKEN | **Required**. Your Logz.io metrics account token. Replace <> with the token of the account you want to ship to. |
| LOGZIO_LISTENER | **Default**: `https://listener.logz.io:8053`. Your Logz.io listener address followed by port `8053`. |
| DOCKER_ENDPOINT | **Default**: default: `unix:///var/run/docker.sock`. Address to reach the required Docker Daemon. |
| TIMEOUT | **Default**: `5s`. The request timeout for any Docker Daemon query. |
| INCLUDE_CONTAINERS | **Default**: `nil`. A list of strings, or [globs](https://github.com/gobwas/glob) whose referent container image names will be among the queried containers. (For example:`containerNameToInclude1,containerNameToInclude2`) |
| EXCLUDE_CONTAINERS | **Default**: `nil`. A list of strings, or [globs](https://github.com/gobwas/glob) whose referent container image names will not be among the queried containers. For example:`containerNameToExclude1,containerNameToExclude2`) |
| GLOBAL_TAGS | **Default**: `nil`. A Comma separated list of key-value pairs that will be added to every metriric. For example - `key1=value1,key2=value2` |
### 3. Check Logz.io for your metrics
Give your metrics a few minutes to get from your system to ours,
and then open [Logz.io](https://app.logz.io/#/dashboard/metrics).
### Metrics list
Click here to view full list of metrics:
- `docker_container_blkio_io_service_bytes_recursive_read`
- `docker_container_blkio_io_service_bytes_recursive_write`
- `docker_container_cpu_throttling_periods`
- `docker_container_cpu_throttling_throttled_periods`
- `docker_container_cpu_throttling_throttled_time`
- `docker_container_cpu_usage_in_kernelmode`
- `docker_container_cpu_usage_in_usermode`
- `docker_container_cpu_usage_percent`
- `docker_container_cpu_usage_system`
- `docker_container_cpu_usage_total`
- `docker_container_mem_active_anon`
- `docker_container_mem_active_file`
- `docker_container_mem_inactive_anon`
- `docker_container_mem_inactive_file`
- `docker_container_mem_limit`
- `docker_container_mem_max_usage`
- `docker_container_mem_pgfault`
- `docker_container_mem_pgmajfault`
- `docker_container_mem_unevictable`
- `docker_container_mem_usage`
- `docker_container_mem_usage_percent`
- `docker_container_net_rx_bytes`
- `docker_container_net_rx_dropped`
- `docker_container_net_rx_errors`
- `docker_container_net_rx_packets`
- `docker_container_net_tx_bytes`
- `docker_container_net_tx_dropped`
- `docker_container_net_tx_errors`
- `docker_container_net_tx_packets`
- `docker_container_status_exitcode`
- `docker_container_status_finished_at`
- `docker_container_status_oomkilled`
- `docker_container_status_pid`
- `docker_container_status_started_at`
- `docker_container_status_uptime_ns`
- `docker_memory_total`
- `docker_n_containers`
- `docker_n_containers_paused`
- `docker_n_containers_running`
- `docker_n_containers_stopped`
- `docker_n_cpusdocker_n_goroutines`
- `docker_n_images`
- `docker_n_listener_events`
- `docker_n_used_file_descriptors`
## Changelog
- **2.0.0**:
- **Breaking Change**: replace `EXCLUDED_IMAGES` with `EXCLUDE_CONTAINERS`.
- Added `INCLUDE_CONTAINERS` to filter in containers by container name.
- **1.1.1**:
- Bug fix `GLOBAL_TAGS` uses key as both key and value.
- **1.1.0**:
- Allow attaching tags to metrics with `GLOBAL_TAGS` env var.
- **1.0.1**:
- Bug fix `EXCLUDED_IMAGES` on container start.
- **1.0.0**:
- Initial Release
## License
Licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.