github_actions_exporter

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 23, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

README

GitHub Actions Exporter

Prometheus exporter exposing GitHub Actions metrics.

Right now this exporter only expose the one metric which is the WorkFlow execution time.

Other metrics can be added in the future.

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.

You need just to select the Check Run event and the set your secret (that you start your exporter, see below)

gh_webook

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

Testing

Running unit tests
make test

Contributing

Refer to CONTRIBUTING.md.

License

Apache License 2.0, see LICENSE.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL