Add GitHub monitoring mixin with dashboards #64
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Dashboard is currently in JSON and has test data.
Also fixed whitespace causing mixin linting to fail.
Previously, only the repo label was added to the pull request metric. Multiple repositories can have the same repo value - the user label is required to uniquely identify a GitHub repository.
Created a GitHub repository dashboard, which graphs exporter metrics for a given repository. Also created an API usage dashboard to check the if the exporter is running out of requests. The dashboards use Grafonnet, a library for writing Grafana dashboards. Added jsonnet-bundler integration so the Grafonnet package can be fetched.
jb install has to be run before linting as the linter checks the dependency files exist.
Added dashboard descriptions to README and updated running instructions so Jsonnet libraries that are required by the build are installed.
|
Hello @Rucknar, I see that you have previously reviewed PRs and gotten them merged, hoping you can do the same for this one. We are working in earnest to get this exporter embedded in the Grafana Agent and deploy this dashboard as an easily consumable integration on Grafana Cloud. It would be ideal to do so from the master branch, if possible. Thanks! |
|
Actually, I just started to try consuming this in anger, and it needs some minor tweaks. Please standby :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mixins are a collection of configurable, reusable Prometheus rules, alerts and/or Grafana dashboards for a particular system. The idea is that you can use these to set up appropriate monitoring for your systems. (More details here: https://github.com/monitoring-mixins/docs.)
This pull request is an initial attempt at a GitHub mixin, providing a dashboard for repository stats, and another one for tracking the GitHub API usage.
I've added the mixin here as ideally it should live in the repository containing the code which emits the telemetry data (metrics) on which the mixin is based. (A couple of example mixins which do this: node_exporter, kube-state-metrics.)
Changes
pull_request_countmetric. Previously it only had the repo label which isn't enough to uniquely identify a GitHub repository.gofmt, which reformatted a couple of imports in the Go files I edited for this.Screenshots