GitHub Metrics for Monitoring

GitHub is a code hosting platform for software development and version control and collaboration using the popular Git. GitHub lets individuals and teams working on software projects manage their code.

Why use the GitHub Telegraf Plugin?

When you are working on a team using GitHub, getting notified of new commits and change in your repository and their associated branches can help you understand the state of your projects. The GitHub Telegraf plugin can collect metrics on open issues, forks, stars, etc. to help you do just that. Collect these metrics in your InfluxDB instance along with other project metrics, performance metrics, or even Google Lighthouse metrics, and you can start to have the confidence that your software projects are not just tracking to your schedule, that they are also living up to the high performance standards you demand.

How to use the GitHub Telegraf Plugin

Configure the GitHub Telegraf plugin to collect your repository information from GitHub by listing your repos' name, API access token, API enterprise URL, timeouts, and any fields that you wish to query. Point the Telegraf plugin to your InfluxDB instance and build dashboards and alerts to show your projects status.

Note: You can also use the Webhook Telegraf input as an alternative method for collecting repository information.

Key GitHub metrics to use for monitoring

Some of the important GitHub metrics that you should proactively monitor include:

• 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)

If you also use the Internal Telegraf plugin, you can collect additional metrics from your GitHub repo:

• 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

Project URL   Documentation