prometheus.exporter.github
The prometheus.exporter.github
component embeds the github_exporter
for collecting statistics from GitHub.
Usage
prometheus.exporter.github "<LABEL>" {
}
Arguments
You can use the following arguments with prometheus.exporter.github
:
GitHub uses an aggressive rate limit for unauthenticated requests based on IP address.
To allow more API requests, we recommend that you configure either api_token
or api_token_file
to authenticate against GitHub.
When provided, api_token_file
takes precedence over api_token
.
Blocks
The prometheus.exporter.github
component doesn’t support any blocks. You can configure this component with arguments.
Exported fields
The following fields are exported and can be referenced by other components.
For example, the targets
can either be passed to a discovery.relabel
component to rewrite the targets’ label sets or to a prometheus.scrape
component that collects the exposed metrics.
The exported targets use the configured in-memory traffic address specified by the run command.
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
doesn’t expose any component-specific debug information.
Debug metrics
prometheus.exporter.github
doesn’t expose any component-specific debug metrics.
Example
The following 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/alloy"]
}
// Configure a prometheus.scrape component to collect github metrics.
prometheus.scrape "demo" {
targets = prometheus.exporter.github.example.targets
forward_to = [prometheus.remote_write.demo.receiver]
}
prometheus.remote_write "demo" {
endpoint {
url = "<PROMETHEUS_REMOTE_WRITE_URL>"
basic_auth {
username = "<USERNAME>"
password = "<PASSWORD>"
}
}
}
Replace the following:
<PROMETHEUS_REMOTE_WRITE_URL>
: The URL of the Prometheusremote_write
compatible server to send metrics to.<USERNAME>
: The username to use for authentication to theremote_write
API.<PASSWORD>
: The password to use for authentication to theremote_write
API.
Compatible components
prometheus.exporter.github
has exports that can be consumed by the following components:
- Components that consume Targets
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.