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 .
Open source
github_exporter_config
The github_exporter_config
block configures the github_exporter
integration,
which is an embedded version of
github_exporter
. This allows for the collection of metrics from the GitHub api.
We strongly recommend that you configure a separate authentication token for the Agent, and give it only the strictly mandatory
security privileges necessary for monitoring your repositories, as per the official documentation
.
We also recommend that you use api_token_file
parameter, to avoid setting the authentication token directly on the Agent config file.
Full reference of options:
yaml
# Enables the github_exporter integration, allowing the Agent to automatically
# collect metrics for the specified GitHub objects.
[enabled: <boolean> | default = false]
# Sets an explicit value for the instance label when the integration is
# self-scraped. Overrides inferred values.
#
# The default value for this integration is inferred from the hostname portion
# of api_url.
[instance: <string>]
# Automatically collect metrics from this integration. If disabled,
# the github_exporter integration will be run but not scraped and thus not
# remote-written. Metrics for the integration will be exposed at
# /integrations/github_exporter/metrics and can be scraped by an external
# process.
[scrape_integration: <boolean> | default = <integrations_config.scrape_integrations>]
# How often should the metrics be collected? Defaults to
# prometheus.global.scrape_interval.
[scrape_interval: <duration> | default = <global_config.scrape_interval>]
# The timeout before considering the scrape a failure. Defaults to
# prometheus.global.scrape_timeout.
[scrape_timeout: <duration> | default = <global_config.scrape_timeout>]
# Allows for relabeling labels on the target.
relabel_configs:
[- <relabel_config> ... ]
# Relabel metrics coming from the integration, allowing to drop series
# from the integration that you don't care about.
metric_relabel_configs:
[ - <relabel_config> ... ]
# How frequent to truncate the WAL for this integration.
[wal_truncate_frequency: <duration> | default = "60m"]
#
# Exporter-specific configuration options
#
# The full URI of the GitHub API.
[api_url: <string> | default = "https://api.github.com"]
# A list of GitHub repositories for which to collect metrics.
repositories:
[ - <string> ]
# A list of GitHub organizations for which to collect metrics.
organizations:
[ - <string> ]
# A list of GitHub users for which to collect metrics.
users:
[ - <string> ]
# A GitHub authentication token that allows the API to be queried more often.
# Optional, but recommended.
[api_token: <string>]
# A path to a file containing a GitHub authentication token that allows the
# API to be queried more often. If supplied, this supersedes `api_token`
# Optional, but recommended.
[api_token_file: <string>]
Was this page helpful?
Related resources from Grafana Labs
Additional helpful documentation, links, and articles:
Video
Getting started with Grafana dashboard design
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
Video
Building advanced Grafana dashboards
In this webinar, we’ll demo how to build and format Grafana dashboards.
Video
Intro to Alerting with Grafana
Master alerting with Grafana: Navigate the complexities, reduce false positives, and boost reliability for your systems.