https://github.com/release-engineering/pipeline-run-prometheus-counter
A simple app that allows a pipeline (e.g. Tekton, Jenkins) to increment a pipeline run counter for Prometheus
https://github.com/release-engineering/pipeline-run-prometheus-counter
Last synced: 11 months ago
JSON representation
A simple app that allows a pipeline (e.g. Tekton, Jenkins) to increment a pipeline run counter for Prometheus
- Host: GitHub
- URL: https://github.com/release-engineering/pipeline-run-prometheus-counter
- Owner: release-engineering
- License: gpl-3.0
- Created: 2021-03-11T20:43:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-31T16:52:46.000Z (about 5 years ago)
- Last Synced: 2025-03-04T08:45:12.289Z (over 1 year ago)
- Language: Python
- Size: 34.2 KB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pipeline Run Prometheus Counter
[](https://quay.io/repository/factory2/pipeline-run-prometheus-counter)
Expose counter metrics for various pipeline runs for the Prometheus text format.
This is useful if you have a pipeline such as Tekton or Jenkins and you need
to keep track of success and/or failure rates of Pipeline runs in Prometheus.
These pipeline runs are stored in a simple SQLite database.
## HTTP Endpoints
You may view the Prometheus metrics at the `/metrics` endpoint. The ouput
will be in the following format:
```text
# HELP car_factory_pipeline_run_total The total number of car_factory pipeline runs.
# TYPE pipeline_tests_pipeline_run_total counter
car_factory_pipeline_run_total{status="success"} 1
car_factory_pipeline_run_total{status="failure"} 1
```
To add a pipeline run, submit a POST request to the `/metrics` endpoint with
the `name` and `success` properties. For example:
```json
{
"name": "car_factory",
"success": true
}
```
When authentication is enabled, you must also pass in the header
`Authorization: PRPC ` (excluding the `<` and `>`).
## Configuration
The path to the SQLite database is configured by the `PRPC_DB_PATH`
environment variable. This defaults to `prpc.db` in the current directory of
execution.
To enable authentication based on a pre-shared key, you may set the `PRPC_PSK` environment
variable with the desired pre-shared key.
## Dependency Management
To manage dependencies, this project uses [pip-tools](https://github.com/jazzband/pip-tools) so that
the production dependencies are pinned and the hashes of the dependencies are verified during
installation.
The unpinned dependencies are recorded in `setup.py`, and to generate the `requirements.txt` file,
run `pip-compile --generate-hashes --output-file=requirements.txt`. This is only necessary when
adding a new package. To upgrade a package, use the `-P` argument of the `pip-compile` command.
When installing the dependencies in a production environment, run
`pip install --require-hashes -r requirements.txt`. Alternatively, you may use
`pip-sync requirements.txt`, which will make sure your virtualenv only has the packages listed in
`requirements.txt`.
To ensure the pinned dependencies are not vulnerable, this project uses
[safety](https://github.com/pyupio/safety), which runs on every pull-request.