GitHub data source plugin for Grafana
The GitHub data source plugin for Grafana lets you to query the GitHub API in Grafana so you can visualize your GitHub repositories and projects.
Watch this video to learn more about setting up the Grafana GitHub data source plugin:
With Grafana Play, you can explore and see how it works, learning from practical examples to accelerate your development. This feature can be seen on GitHub data source plugin demo.
Query types
The plugin supports the following query types:
- Commits
- Issues
- Contributors
- Tags
- Releases
- Pull requests
- Labels
- Repositories
- Milestones
- Packages
- Vulnerabilities
- Projects
- Stargazers
- Workflows
- Workflow usage
Supported features
With the plugin you can:
- Visualize queries
- Use template variables
- Configure Annotations
- Cache queries
Caching
Caching on this plugin is always enabled.
Note
To work around GitHub’s rate limiting, the plugin caches requests aggressively.
This can mean that it takes up to five minutes for a new pull request, commit, or issue to show up in a query.
Requirements
To use the GitHub data source plugin, you will need:
- A free GitHub or a GitHub Enterprise account.
- Any of the following Grafana editions:
- Grafana OSS server.
- A Grafana Cloud stack.
- An on-premise Grafana Enterprise server with an activated license.
Get started
- To start using the plugin, you need to generate an access token, then install and configure the plugin. To do this, refer to Setup.
- To use variable and macros, for creating a dynamic dashboard, refer to Variables and Macros.
- To annotate the data by displaying the GitHub resources on the dashboard, refer to Annotations.
- To quickly visualize GitHub data in Grafana, refer to Sample dashboards.
Get the most out of the plugin
- Add Annotations
- Configure and use Templates and variables
- Add Transformations
Report issues
Use the official GitHub repository to report issues, bugs, and feature requests.