Skip to content

Commit a2cde88

Browse files
authored
Prepare release 0.1.0 (#3)
1 parent 026ee88 commit a2cde88

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
![GitHub_headerImage](https://user-images.githubusercontent.com/3262610/221191767-73b8a8d9-9f8b-440e-8ab6-75cb3c82f2bc.png)
22

3-
This GitHub action allows you to instrument a pipeline and track number of runs and their duration; the data is then exported to a prometheus aggregation gateway, like [prom-aggregation-gateway](https://github.com/zapier/prom-aggregation-gateway).
3+
This GitHub action allows you to instrument a pipeline and track number of runs and their duration; the data is then exported to a prometheus aggregation gateway, such as one of these:
4+
5+
- [Prometheus Pushgateway](https://github.com/prometheus/pushgateway)
6+
- [Gravel Gateway](https://github.com/sinkingpoint/prometheus-gravel-gateway/tree/master)
7+
- [Prometheus Aggregation Gateway](https://github.com/zapier/prom-aggregation-gateway)
8+
49
Due to limitations of GitHub actions, tracking success rate is only possible via api, so it is outside the scope of this action (for now).
510

611
## Usage
@@ -11,9 +16,10 @@ Just add the action as a step to your job, and provide the url of the prometheus
1116
steps:
1217
- uses: autometrics-dev/instrument-pipeline@v0
1318
with:
14-
pushgateway: http://pushgateway.example.com/metrics
19+
pushgateway: http://pushgateway.example.com
20+
gatewaytype: prometheus
1521
- uses: actions/checkout@v3
16-
- uses: actions/setup-node@v3
22+
- uses: actions/setup-node@v4
1723
with:
1824
node-version: 20
1925
- run: npm install
@@ -26,7 +32,13 @@ Now every time the action runs, it will send the duration (and increase the run
2632
2733
### `pushgateway`
2834

29-
**Required** The url of the prometheus aggregation gateway, with the `/metrics` endpoint.
35+
**Required**
36+
37+
URL to the aggregation gateway, for example `http://localhost:9091`.
38+
39+
### `gatewaytype`
40+
41+
Type of the aggregation gateway, one of `prometheus`, `gravel`, or `zapier`. Currently only changes the url format in case of prometheus.
3042

3143
### `buckets`
3244

scripts/simulate-build.js

-5
This file was deleted.

0 commit comments

Comments
 (0)