GitHub integration for Grafana Cloud

Before you begin

It is advised that you provide a GitHub personal access token so that the API ratelimit is not reached prematurely.

We strongly recommend that you give it only the strictly mandatory security privileges necessary for monitoring your repositories, which are all read-only, as per the official documentation.

Install GitHub integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find GitHub and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send GitHub metrics to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboards to your Grafana Cloud instance, and you can start monitoring your GitHub setup.

Configuration snippets for Grafana Alloy

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your GitHub instances, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

Advanced integrations snippets

river Copy

prometheus.exporter.github "integrations_github_exporter" {
	repositories = ["grafana/agent"]
	api_token    = "<your github api token>"
}

discovery.relabel "integrations_github_exporter" {
	targets = prometheus.exporter.github.integrations_github_exporter.targets

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}

	rule {
		target_label = "job"
		replacement  = "integrations/github_exporter"
	}
}

prometheus.scrape "integrations_github_exporter" {
	targets    = discovery.relabel.integrations_github_exporter.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/github_exporter"
}

This integrations uses the prometheus.exporter.github component to generate metrics from a GitHub instance.

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. We also recommend that you use the api_token_file parameter to avoid setting the authentication token directly on the agent config file.

For the full array of configuration options, refer to the prometheus.exporter.github component reference documentation.

This exporter must be linked with a discovery.relabel component to apply the necessary relabelings.

For each GitHub instance to be monitored you must create a pair of these components.

Configure the following properties within each discovery.relabel component:

• instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this GitHub instance.

You can then scrape them by including each discovery.relabel under targets within the prometheus.scrape component.

Before you begin

It is advised that you provide a GitHub personal access token so that the API ratelimit is not reached prematurely.

We strongly recommend that you give it only the strictly mandatory security privileges necessary for monitoring your repositories, which are all read-only, as per the official documentation.

Install GitHub integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find GitHub and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send GitHub metrics to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboards to your Grafana Cloud instance, and you can start monitoring your GitHub setup.

Post-install configuration for the GitHub integration

This integration is configured to work with the Github exporter, which is embedded in the Grafana Agent.

Enable the integration by adding the provided snippet to your agent configuration file.

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. We also recommend that you use the api_token_file parameter to avoid setting the authentication token directly on the agent config file.

For a full description of configuration options see how to configure the github_exporter_config block in the agent documentation.

Configuration snippets for Grafana Agent

Below integrations, insert the following lines and change the URLs according to your environment:

yaml Copy

  github_exporter:
    enabled: true
    api_token: '<your github api token>'
    repositories:
    - grafana/agent
    relabel_configs:
    - replacement: '<your-instance-name>'
      target_label: instance

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the GitHub integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

yaml Copy

integrations:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
  github_exporter:
    enabled: true
    api_token: '<your github api token>'
    repositories:
    - grafana/agent
    relabel_configs:
    - replacement: '<your-instance-name>'
      target_label: instance
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal