Data configurationGrafana integrationsIntegrations referenceGitHub integration

GitHub integration for Grafana Cloud

GitHub is a provider of Internet hosting for software development and version control using Git. This integration enables the agent to send metrics to Grafana Cloud along with a useful default dashboard for visualization.

Use the walkthrough in Grafana Cloud to install the GitHub integration.

Post-install configuration for the GitHub integration

In the agent configuration file, you must specify the repositories for which you wish to collect statistics. This can be a combination of specifying entire orgs, or users, and listing repositories explicitly.

Caution: Take the following actions to ensure that your environment is secure. To ensure that the API rate limit is not reached prematurely, provide a GitHub personal access token. Give the token only the strictly mandatory security privileges necessary for monitoring your repositories, which are all read-only. For more information, see the official documentation. Use api_token_file parameter to avoid setting the authentication token directly on the Agent config file.

integrations:
  github_exporter:
    enabled: true
    repositories:
      - grafana/agent
      - grafana/grafana
    organizations:
      - prometheus-community
    users:
      - <your github user name>
    api_token: <your github api token>

For a full description of configuration options, see github_exporter_config in the Agent documentation.