Menu

Caution

Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana Agentbreadcrumb arrow Grafana Agent Flowbreadcrumb arrow Referencebreadcrumb arrow Componentsbreadcrumb arrow prometheus.exporter.github
Open source

prometheus.exporter.github

The prometheus.exporter.github component embeds github_exporter for collecting statistics from GitHub.

Usage

river 
prometheus.exporter.github "LABEL" {
}

Arguments

The following arguments can be used to configure the exporter’s behavior. All arguments are optional. Omitted fields take their default values.

NameTypeDescriptionDefaultRequired
api_urlstringThe full URI of the GitHub API.https://api.github.comno
repositorieslist(string)GitHub repositories for which to collect metrics.no
organizationslist(string)GitHub organizations for which to collect metrics.no
userslist(string)A list of GitHub users for which to collect metrics.no
api_tokensecretAPI token to use to authenticate against GitHub.no
api_token_filestringFile containing API token to use to authenticate against GitHub.no

GitHub uses an aggressive rate limit for unauthenticated requests based on IP address. To allow more API requests, it is recommended to configure either api_token or api_token_file to authenticate against GitHub.

When provided, api_token_file takes precedence over api_token.

Exported fields

The following fields are exported and can be referenced by other components.

NameTypeDescription
targetslist(map(string))The targets that can be used to collect github metrics.

For example, the targets can either be passed to a prometheus.relabel component to rewrite the metric’s label set, or to a prometheus.scrape component that collects the exposed metrics.

Component health

prometheus.exporter.github is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.exporter.github does not expose any component-specific debug information.

Debug metrics

prometheus.exporter.github does not expose any component-specific debug metrics.

Example

This example uses a prometheus.scrape component to collect metrics from prometheus.exporter.github:

river 
prometheus.exporter.github "example" {
  api_token_file = "/etc/github-api-token"
  repositories = ["grafana/agent"]
}

// Configure a prometheus.scrape component to collect github metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.github.example.targets
  forward_to = [ /* ... */ ]
}