sourcegraph/monitoring/definitions/github_proxy.go

package definitions

import (
	"time"

	"github.com/sourcegraph/sourcegraph/monitoring/monitoring"
)

func GitHubProxy() *monitoring.Container {
	return &monitoring.Container{
		Name:        "github-proxy",
		Title:       "GitHub Proxy",
		Description: "Proxies all requests to github.com, keeping track of and managing rate limits.",
		Groups: []monitoring.Group{
			{
				Title: "GitHub API monitoring",
				Rows: []monitoring.Row{
					{
						{
							Name:              "github_core_rate_limit_remaining",
							Description:       "remaining calls to GitHub before hitting the rate limit",
							Query:             `src_github_rate_limit_remaining{resource="core"}`,
							DataMayNotExist:   true,
							Critical:          monitoring.Alert().LessOrEqual(500).For(5 * time.Minute),
							PanelOptions:      monitoring.PanelOptions().LegendFormat("calls remaining"),
							Owner:             monitoring.ObservableOwnerCloud,
							PossibleSolutions: `Try restarting the pod to get a different public IP.`,
						},
						{
							Name:              "github_search_rate_limit_remaining",
							Description:       "remaining calls to GitHub search before hitting the rate limit",
							Query:             `src_github_rate_limit_remaining{resource="search"}`,
							DataMayNotExist:   true,
							Warning:           monitoring.Alert().LessOrEqual(5),
							PanelOptions:      monitoring.PanelOptions().LegendFormat("calls remaining"),
							Owner:             monitoring.ObservableOwnerCloud,
							PossibleSolutions: `Try restarting the pod to get a different public IP.`,
						},
					},
				},
			},
			{
				Title:  "Container monitoring (not available on server)",
				Hidden: true,
				Rows: []monitoring.Row{
					{
						sharedContainerCPUUsage("github-proxy", monitoring.ObservableOwnerCloud),
						sharedContainerMemoryUsage("github-proxy", monitoring.ObservableOwnerCloud),
					},
					{
						sharedContainerRestarts("github-proxy", monitoring.ObservableOwnerCloud),
						sharedContainerFsInodes("github-proxy", monitoring.ObservableOwnerCloud),
					},
				},
			},
			{
				Title:  "Provisioning indicators (not available on server)",
				Hidden: true,
				Rows: []monitoring.Row{
					{
						sharedProvisioningCPUUsageLongTerm("github-proxy", monitoring.ObservableOwnerCloud),
						sharedProvisioningMemoryUsageLongTerm("github-proxy", monitoring.ObservableOwnerCloud),
					},
					{
						sharedProvisioningCPUUsageShortTerm("github-proxy", monitoring.ObservableOwnerCloud),
						sharedProvisioningMemoryUsageShortTerm("github-proxy", monitoring.ObservableOwnerCloud),
					},
				},
			},
			{
				Title:  "Golang runtime monitoring",
				Hidden: true,
				Rows: []monitoring.Row{
					{
						sharedGoGoroutines("github-proxy", monitoring.ObservableOwnerCloud),
						sharedGoGcDuration("github-proxy", monitoring.ObservableOwnerCloud),
					},
				},
			},
			{
				Title:  "Kubernetes monitoring (ignore if using Docker Compose or server)",
				Hidden: true,
				Rows: []monitoring.Row{
					{
						sharedKubernetesPodsAvailable("github-proxy", monitoring.ObservableOwnerCloud),
					},
				},
			},
		},
	}
}