{"id":15927761,"url":"https://github.com/autometrics-dev/instrument-pipeline","last_synced_at":"2025-03-17T23:32:20.646Z","repository":{"id":181815357,"uuid":"660637665","full_name":"autometrics-dev/instrument-pipeline","owner":"autometrics-dev","description":"Export job execution metrics to a Prometheus aggregation gateway","archived":false,"fork":false,"pushed_at":"2024-02-28T23:44:02.000Z","size":190,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-14T21:16:45.625Z","etag":null,"topics":["metrics","opentelemetry","prometheus"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/autometrics-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-30T13:16:49.000Z","updated_at":"2025-03-07T00:35:46.000Z","dependencies_parsed_at":"2024-02-27T14:55:03.591Z","dependency_job_id":"2f0e239d-c12f-478d-8bcb-a7ddb9831545","html_url":"https://github.com/autometrics-dev/instrument-pipeline","commit_stats":{"total_commits":10,"total_committers":2,"mean_commits":5.0,"dds":0.4,"last_synced_commit":"6a36fc47c7a8c7f53b9ec95e2213a80e0feaff35"},"previous_names":["autometrics-dev/instrument-pipeline"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autometrics-dev%2Finstrument-pipeline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autometrics-dev%2Finstrument-pipeline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autometrics-dev%2Finstrument-pipeline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autometrics-dev%2Finstrument-pipeline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/autometrics-dev","download_url":"https://codeload.github.com/autometrics-dev/instrument-pipeline/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243893407,"owners_count":20364895,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["metrics","opentelemetry","prometheus"],"created_at":"2024-10-06T23:04:33.811Z","updated_at":"2025-03-17T23:32:20.345Z","avatar_url":"https://github.com/autometrics-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![GitHub_headerImage](https://user-images.githubusercontent.com/3262610/221191767-73b8a8d9-9f8b-440e-8ab6-75cb3c82f2bc.png)\n\nThis 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:\n\n- [Prometheus Pushgateway](https://github.com/prometheus/pushgateway)\n- [Gravel Gateway](https://github.com/sinkingpoint/prometheus-gravel-gateway/tree/master)\n- [Prometheus Aggregation Gateway](https://github.com/zapier/prom-aggregation-gateway)\n\nDue to limitations of GitHub actions, tracking success rate is only possible via api, so it is outside the scope of this action (for now).\n\n## Usage\n\nJust add the action as a step to your job, and provide the url of the prometheus aggregation gateway as an input:\n\n```yaml\nsteps:\n  - uses: autometrics-dev/instrument-pipeline@v0\n    with:\n      pushgateway: http://pushgateway.example.com\n      gatewaytype: prometheus\n  - uses: actions/checkout@v3\n  - uses: actions/setup-node@v4\n    with:\n      node-version: 20\n  - run: npm install\n  - run: npm run build\n```\n\nNow every time the action runs, it will send the duration (and increase the run counter) of the run to the aggregation gateway.\n\n## Inputs\n\n### `pushgateway`\n\n**Required** \n\nURL to the aggregation gateway, for example `http://localhost:9091`.\n\n### `gatewaytype`\n\nType of the aggregation gateway, one of `prometheus`, `gravel`, or `zapier`. Currently only changes the url format in case of prometheus.\n\n### `buckets`\n\nArray of buckets to use for the histogram. For example, `[0, 1, 2, 5, 10, +Infinity]`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautometrics-dev%2Finstrument-pipeline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautometrics-dev%2Finstrument-pipeline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautometrics-dev%2Finstrument-pipeline/lists"}