gh-webhook-monitor

Prometheus Metrics Exporter for GitHub Repository Webhook Statuses

Overview

• Exposes metrics on :8080/metrics
• Docker Image: iwilltry42/gh-webhook-monitor

Configuration

Via Environment Variables:

Variable Name	Value Type	Description	Default Value
GWM_GH_APP_ID	int	ID of your GitHub App	-
GWM_GH_APP_PEM	string	Path to the private key PEM file of your GitHub App	-
GWM_GH_APP_INST_ID	int	ID of the Installation of your GitHub App	-
GWM_WAIT_TIME	time.Duration	Time to wait between each loop (important for request limits on the GitHub API)	5m
GWM_REPO_REFRESH_WAIT_TIME	time.Duration	Time to wait before refreshing the list of repositories	1h
GWM_REPOS_FILTER_TEAM_SLUGS	string	Comma-separated list of team slugs to get repositories from	-
GWM_REPOS_INCLUDE	string	Comma-separated list of repositories to check the webhooks for	-
GWM_REPOS_EXCLUDE	string	Comma-separated list of repositories to exclude from checks	-
GWM_WEBHOOKS_FILTER_TARGET_REGEXP	string (regexp)	Regular Expression to filter for specific webhook target URLs (e.g. .*jenkins.*)	-
GWM_DEBUG	string	set to non-empty to enable debug logging	-

Repository Filtering

• Include always has precedence over exclude (TLDR: INCLUDE > EXCLUDE)
  • E.g. a repo that's listed in GWM_REPOS_INCLUDE will be included, even if it's also in GWM_REPOS_EXCLUDE

Process

• If GWM_REPOS_FILTER_TEAM_SLUGS is not empty, an initial list of repositories will be fetched from the respective teams
• From this list, all items will be dropped, which are in the exclusion list created from GWM_REPOS_EXCLUDE
• Then, all items in the inclusion list (GWM_REPOS_INLCUDE) will be added to the final list