---
title: "GitHub integration | Grafana Cloud documentation"
description: "Learn about GitHub Grafana Cloud integration."
---

> For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt).

# GitHub integration for Grafana Cloud

GitHub is a provider of Internet hosting for software development and version control using Git.

This integration includes 2 pre-built dashboards to help monitor and visualize GitHub metrics.

## Before you begin

It is advised that you provide a GitHub [personal access token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-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](https://docs.github.com/en/rest/reference/permissions-required-for-github-apps).

## 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 Alloy 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

Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```alloy
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](/docs/alloy/latest/reference/components/prometheus.exporter.github/) component to generate metrics from a GitHub instance.

In Alloy 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 in the Alloy config file.

For the full array of configuration options, refer to the [prometheus.exporter.github](/docs/alloy/latest/reference/components/prometheus.exporter.github/) component reference documentation.

This exporter must be linked with a [discovery.relabel](/docs/alloy/latest/reference/components/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](/docs/alloy/latest/reference/components/prometheus.scrape/) component.

## Dashboards

The GitHub integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

- GitHub API Usage
- GitHub Repository Stats

## Metrics

The most important metrics provided by the GitHub integration, which are used on the pre-built dashboards, are as follows:

- github\_rate\_limit
- github\_rate\_remaining
- github\_repo\_forks
- github\_repo\_open\_issues
- github\_repo\_pull\_request\_count
- github\_repo\_size\_kb
- github\_repo\_stars
- github\_repo\_watchers
- up

## Changelog

md ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```md
# 1.0.0 - February 2024

* Update mixin to replace all Angular panels with React based panels.

# 0.0.5 - September 2023

* Update Grafana Agent configuration snippets to include filtered metrics used in gauge panels

# 0.0.4 - August 2023

* New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working.
* New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label.

# 0.0.3 - September 2022

* Update dashboard panels descriptions.

# 0.0.2 - October 2021

* Update mixin to latest version:
  - Update the datasource template variable label to 'Data Source'

# 0.0.1 - August 2021

* Initial release
```

## Cost

By connecting your GitHub instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see [Active series and dpm usage](/docs/grafana-cloud/fundamentals/active-series-and-dpm/) and [Cloud tier pricing](/products/cloud/pricing/).