Skip to content

Latest commit

 

History

History
74 lines (45 loc) · 1.75 KB

README.md

File metadata and controls

74 lines (45 loc) · 1.75 KB
Raw

GitHub Actions Exporter

Prometheus exporter exposing GitHub Actions metrics.

Getting Started

This exporter receives webhook events from GitHub.

If you want to collect metrics from a GitHub repository you will need to create a webhook in your GitHub repo or a GitHub App.

You need just to select the workflow_job event and set the webhook secret.

The webhook will call /gh_event path on your endpoint by default. You can change this with the --web.gh-webhook-path option.

gh_webook

Also it optionally collects the Action Billing metrics, for that you will need to setup a GitHub API Access Token.

When configuring for an organization Access tokens must have the repo or admin:org scope. When configuring for an user Access tokens must have the user scope.

Prerequisites

To run this project, you will need a working Go environment.

Installing

go get -u github.com/cpanato/github_actions_exporter

Building

Build the sources with

make build

Run the binary

./github_actions_exporter --gh.github-webhook-token="MY_TOKEN" --gh.github-api-token="Accesstoken" --gh.github-org="honk_org"

Testing

Running unit tests

make test

Manual testing

cd example/
export WEBHOOK_SECRET="..."
export GITHUB_TOKEN="..."
export GITHUB_ORG="..."
docker-compose up --build

Open Prometheus at http://localhost:9090 and explore the available metrics.

Contributing

Refer to CONTRIBUTING.md.

License

Apache License 2.0, see LICENSE.