https://github.com/livetocode/camunda-prometheus-exporter
A Prometheus exporter for Camunda metrics
https://github.com/livetocode/camunda-prometheus-exporter
Last synced: 10 months ago
JSON representation
A Prometheus exporter for Camunda metrics
- Host: GitHub
- URL: https://github.com/livetocode/camunda-prometheus-exporter
- Owner: livetocode
- License: mit
- Created: 2017-09-18T19:57:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-01T22:50:17.000Z (almost 4 years ago)
- Last Synced: 2025-03-27T11:03:38.527Z (11 months ago)
- Language: Go
- Size: 2.56 MB
- Stars: 12
- Watchers: 2
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# camunda-prometheus-exporter
## Description
This exporter will call the Camunda Rest APIs in order to collect metrics on the running workflows.
It will then create the following Prometheus metrics:
- camunda_metrics_total: Camunda metrics
- camunda_process_instances_total: Number of instances of a specific Process
- camunda_process_failed_jobs_total: Number of failed jobs for a specific Process
- camunda_process_activity_instances_total: Number of instances for a specific activity
- camunda_process_activity_failed_jobs_total: Number of failed jobs for a specific activity
- camunda_history_incidents_total: NNumber of history incidents within a Camunda server
- camunda_history_process_activity_instances_total: Number of instances of a specific activity in the history
- camunda_history_process_activity_canceled_total: umber of canceled activities for a specific activity in the history
- camunda_history_process_activity_finished_total: Number of finished activities for a specific activity in the history
- camunda_history_process_activity_complete_scope_total: Number of CompleteScope activities for a specific activity in the history
- camunda_scrape_requests_total: Number of http requests made to the Camunda APIs.
- camunda_scrape_errors_total: Number of errors while accessing the Camunda APIs
- camunda_scrape_duration_seconds: Duration of a scrape in seconds
Note that each metric will have a **"name"** property containing the Room's name.
## Requirements
You need access to a Camunda server that exposes its engine-rest endpoint
## Build
To create a local docker image, execute:
```
./scripts/build-image.sh
```
## Run
Once you have the image built and your AuthTojen, you can run it in Docker locally for testing it:
```
./scripts/run-image.sh -server http://my.camunda.server:8080
```
And then you can access the metrics:
```
open http://localhost:8080/metrics
```
## Kubernetes
Use the Helm Chart for installing it.
See the [README](charts/camunda-prometheus-exporter/README.md)