github_billing_exporter

command module

v0.1.0 Latest Latest Go to latest Published: Dec 27, 2020 License: Apache-2.0 Imports: 13 Imported by: 0

README ¶

GitHub billing exporter

This expoter exposes Prometheus metrics from GitHub billing API endpoint.

Building and running

Token privileges

Token needs to have access to read billing data.

Build

make

Running

Running using an environment variable:

export GITHUB_ORGS="ORG1,ORG2,..."
export GITHUB_TOKEN="example_token"
./github_billing_exporter

Running using args:

./mysqld_exporter \
--github-orgs="ORG1,ORG2,..." \
--github-token="example_token"

Collectors

There are three collectors (actions, packages and storage) all enabled by default. Disabling collector(s) can be done using environment variable DISABLED_COLLECTORS or arg --disabled-collectors.

List of collectors

Name	Description	Enabled
actions	Exposes billing statistics from `/orgs/{org}/settings/billing/actions`	`true`
packages	Exposes billing statistics from `/orgs/{org}/settings/billing/packages`	`true`
storage	Exposes billing statistics from `/orgs/{org}/settings/billing/shared-storage`	`true`

Environment variables / args reference

Env	Arg	Description	Default	Required
`DISABLED_COLLECTORS`	`--disabled-collectors`	Collectors to disable	`""`	`no`
`GITHUB_ORGS`	`--github-orgs`	GitHub organizations to scrape metrics for	`""`	`yes`
`GITHUB_TOKEN`	`--github-token`	GitHub token with billind read privileges	`""`	`yes`
`LISTEN_ADDRESS`	`--web.listen-address`	Address on which to expose metrics.	`:9999`	`no`
`METRICS_PATH`	`--web.telemetry-path`	Path under which to expose metrics.	`/metrics`	`no`

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

github_billing_exporter.go

Directories ¶

Path	Synopsis
collector

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