---
title: Telegraf Documentation
description: Telegraf plugin for collecting metrics from GitHub
url: https://docs.influxdata.com/telegraf/v1/input-plugins/github/
estimated_tokens: 1546
product: Telegraf
version: v1
---

-   Telegraf v1.11.0+

# GitHub Input Plugin

This plugin gathers information from projects and repositories hosted on [GitHub](https://www.github.com).

Telegraf also contains the [webhook input plugin](/telegraf/v1/plugins/#input-webhooks) which can be used as an alternative method for collecting repository information.

**Introduced in:** Telegraf v1.11.0 **Tags:** applications **OS support:** all

## Global configuration options

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details.

## Configuration

```toml
# Gather repository information from GitHub hosted repositories.
[[inputs.github]]
  ## List of repositories to monitor
  repositories = [
    "influxdata/telegraf",
    "influxdata/influxdb"
  ]

  ## Github API access token.  Unauthenticated requests are limited to 60 per hour.
  # access_token = ""

  ## Github API enterprise url. Github Enterprise accounts must specify their base url.
  # enterprise_base_url = ""

  ## Timeout for HTTP requests.
  # http_timeout = "5s"

  ## List of additional fields to query.
  ## NOTE: Getting those fields might involve issuing additional API-calls, so please
  ##       make sure you do not exceed the rate-limit of GitHub.
  ##
  ## Available fields are:
  ##  - pull-requests -- number of open and closed pull requests (2 API-calls per repository)
  # additional_fields = []
```

## Metrics

-   github\_repository
    -   tags:
        -   name - The repository name
        -   owner - The owner of the repository
        -   language - The primary language of the repository
        -   license - The license set for the repository
    -   fields:
        -   forks (int)
        -   open\_issues (int)
        -   networks (int)
        -   size (int)
        -   subscribers (int)
        -   stars (int)
        -   watchers (int)

When the [internal](/telegraf/v1/plugins/#input-internal) input is enabled:

-   internal\_github
    -   tags:
        -   access\_token - obfuscated reference to access token or “Unauthenticated”
    -   fields:
        -   limit - How many requests you are limited to (per hour)
        -   remaining - How many requests you have remaining (per hour)
        -   blocks - How many requests have been blocked due to rate limit

When specifying `additional_fields` the plugin will collect the specified properties. **NOTE:** Querying this additional fields might require to perform additional API-calls. Please make sure you don’t exceed the query rate-limit by specifying too many additional fields. In the following we list the available options with the required API-calls and the resulting fields

-   “pull-requests” (2 API-calls per repository)
    -   fields:
        -   open\_pull\_requests (int)
        -   closed\_pull\_requests (int)

## Example Output

```text
github_repository,language=Go,license=MIT\ License,name=telegraf,owner=influxdata forks=2679i,networks=2679i,open_issues=794i,size=23263i,stars=7091i,subscribers=316i,watchers=7091i 1563901372000000000
internal_github,access_token=Unauthenticated closed_pull_requests=3522i,rate_limit_remaining=59i,rate_limit_limit=60i,rate_limit_blocks=0i,open_pull_requests=260i 1552653551000000000
```

#### Related

-   [Configure plugins](/telegraf/v1/configure_plugins/)
-   [GitHub Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/github/README.md)