prometheus.exporter.github
The prometheus.exporter.github component embeds
github_exporter for collecting statistics from GitHub.
Usage
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.
| Name | Type | Description | Default | Required |
|---|---|---|---|---|
api_url | string | The full URI of the GitHub API. | https://api.github.com | no |
repositories | list(string) | GitHub repositories for which to collect metrics. | no | |
organizations | list(string) | GitHub organizations for which to collect metrics. | no | |
users | list(string) | A list of GitHub users for which to collect metrics. | no | |
api_token | secret | API token to use to authenticate against GitHub. | no | |
api_token_file | string | File 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.
| Name | Type | Description |
|---|---|---|
targets | list(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:
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 = [ /* ... */ ]
}