Documentation Grafana Cloud Instrument and send data Grafana Alloy Reference Components prometheus prometheus.exporter.github

prometheus.exporter.github

The prometheus.exporter.github component embeds the github_exporter for collecting statistics from GitHub.

Usage

Alloy Copy

prometheus.exporter.github "<LABEL>" {
}

Arguments

You can use the following arguments with prometheus.exporter.github:

Authentication

GitHub uses an aggressive rate limit for unauthenticated requests based on IP address. To allow more API requests, we recommend that you configure either token or GitHub App authentication.

• Token authentication: Set api_token or api_token_file with a personal access token or classic token.
• GitHub App authentication: Set github_app_id, github_app_installation_id, and github_app_key_path to authenticate as a GitHub App.

When provided, api_token_file takes precedence over api_token.

You can’t use both token authentication and GitHub App authentication simultaneously.

Blocks

The prometheus.exporter.github component doesn’t support any blocks. You can configure this component with arguments.

Exported fields

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.

Examples

The following examples demonstrate token authentication and GitHub App authentication.

Token authentication

The following example uses a prometheus.scrape component to collect metrics from prometheus.exporter.github:

Alloy Copy

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 Prometheus remote_write compatible server to send metrics to.
• <USERNAME>: The username to use for authentication to the remote_write API.
• <PASSWORD>: The password to use for authentication to the remote_write API.

GitHub App authentication

The following example uses GitHub App authentication to collect metrics:

Alloy Copy

prometheus.exporter.github "example" {
  repositories                 = ["grafana/alloy"]
  github_app_id                = 123456
  github_app_installation_id   = 789012
  github_app_key_path          = "/etc/github-app-key.pem"
}

// 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 Prometheus remote_write compatible server to send metrics to.
• <USERNAME>: The username to use for authentication to the remote_write API.
• <PASSWORD>: The password to use for authentication to the remote_write API.

Compatible components

prometheus.exporter.github has exports that can be consumed by the following components:

• Components that consume Targets