Skip to content
This repository has been archived by the owner on Jul 22, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
socheatsok78 committed Jun 28, 2024
1 parent 0d2d4ef commit 4161fbb
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@ The Prometheus monitoring system and time series database customized for Docker
- A standard metrics labeling for Docker Swarm compatible scrape configs (i.e. nodes, services and tasks).
- Provide a Kubernetes compatible labels, this grant us the ability to reuse some of the already existing Grafana Dashboard already built for Kubernetes.

## Deployment
## Features

> WIP
- Automatically discover and scrape the metrics from the Docker Swarm nodes, services and tasks.
- Ability to configure scrape target via Docker object labels.
- Dynamically inject scrape configs from Docker configs.
- Automatically reload the Prometheus configuration when the Docker configs are create/update/remove.

## How to use

Expand Down Expand Up @@ -47,6 +50,19 @@ networks:
external: true
```
## Prometheus Kubernetes compatible labels
Here is a list of Docker Service/Task labels that are mapped to Kubernetes labels.
| Kubernetes | Docker | Scrape config |
| ------------ | ------------------------------------------------------------- | ------------------------------ |
| `namespace` | `__meta_dockerswarm_service_label_com_docker_stack_namespace` | |
| `deployment` | `__meta_dockerswarm_service_name` | |
| `pod` | `dockerswarm_task_name` | `promstack/tasks` |
| `service` | `__meta_dockerswarm_service_name` | `promstack/services-endpoints` |

* **dockerswarm_task_name**: A combination of the service name, slot and task id.

## References

- https://prometheus.io/docs/prometheus/latest/configuration/configuration/
Expand Down

0 comments on commit 4161fbb

Please sign in to comment.