github

README

GitHub Input Plugin

Gather repository information from GitHub hosted repositories.

Note: Telegraf also contains the webhook input which can be used as an alternative method for collecting repository information.

Configuration

[[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 input is enabled:

• internal_github
  • tags:
    • access_token - An obfuscated reference to the configured 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

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

Documentation

Index

• type GitHub
  • func (g *GitHub) Description() string
  • func (g *GitHub) Gather(acc telegraf.Accumulator) error
  • func (g *GitHub) SampleConfig() string

Types

type GitHub

type GitHub struct {
	Repositories      []string        `toml:"repositories"`
	AccessToken       string          `toml:"access_token"`
	AdditionalFields  []string        `toml:"additional_fields"`
	EnterpriseBaseURL string          `toml:"enterprise_base_url"`
	HTTPTimeout       config.Duration `toml:"http_timeout"`

	RateLimit       selfstat.Stat
	RateLimitErrors selfstat.Stat
	RateRemaining   selfstat.Stat
	// contains filtered or unexported fields
}

GitHub - plugin main structure

func (*GitHub) Description

func (g *GitHub) Description() string

Description returns the plugin description.

func (*GitHub) Gather

func (g *GitHub) Gather(acc telegraf.Accumulator) error

Gather GitHub Metrics

func (*GitHub) SampleConfig

func (g *GitHub) SampleConfig() string

SampleConfig returns sample configuration for this plugin.