artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 17:11:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

monitoring: improve registerObservableOwner and TestOwner docstrings (#59290)

Browse Source 
Probably good to improve the docstrings here in light of https://sourcegraph.slack.com/archives/C03L2R35ENL/p1704240126855279, since hopefully folks will be reading this.
This commit is contained in:
Robert Lin 2024-01-02 20:46:25 -08:00 committed by GitHub
parent cdd48e267e
commit 9db6c3df87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
monitoring/monitoring/owners.go
View File

@ -123,8 +123,19 @@ func (o ObservableOwner) getHandbookPageURL() string {
return "https://" + path.Join("handbook.sourcegraph.com", basePath, o.handbookSlug)
}
// allKnownOwners is used for testing, mapping all known observable owner names
// to their respective definitions - see registerObservableOwner()
var allKnownOwners = make(map[string]ObservableOwner)
// registerObservableOwner should be used over all ObservableOwner declarations.
// It validates the declaration at init time and also registers in allKnownOwners,
// which is used for additional testing on all registered ObservableOwners,
// namely a set of opt-in tests to check external resources associated with
// ObservableOwners:
//
// go test -run TestOwners github.com/sourcegraph/sourcegraph/monitoring/monitoring -update -online
//
// See owners_test.go for more details.
func registerObservableOwner(o ObservableOwner) ObservableOwner {
if err := o.validate(); err != nil {
panic(err)

11
monitoring/monitoring/owners_test.go
View File

@ -19,6 +19,12 @@ import (
"golang.org/x/exp/maps"
)
// onlineCheck flags whether or not checks against external ObservableOwner
// resources like Opsgenie and handbook pages should run:
//
// go test -run TestOwners github.com/sourcegraph/sourcegraph/monitoring/monitoring -update -online
//
// OPSGENIE_API_KEY is required to check Opsgenie resources.
var onlineCheck = flag.Bool("online", false, "Run online checks")
type opsgenieResponderConfig struct {
@ -37,7 +43,8 @@ type notifierConfig struct {
Owners []string `json:"owners"` // owner.opsgenieTeam
}
// TestOwnersOpsgenieTeam checks Opsgenie team details of each owner.
// TestOwnersOpsgenieTeam checks Opsgenie team details of each owner. It also
// outputs usable site-config for 'observability.alerts' in Sourcegraph.com.
func TestOwnersOpsgenieTeam(t *testing.T) {
if !*onlineCheck {
t.Skip("MONITORING_OWNERS_ONLINE_CHECK not set to true, skipping online checks")
@ -104,7 +111,7 @@ func TestOwnersOpsgenieTeam(t *testing.T) {
enc := json.NewEncoder(&data)
enc.SetIndent(" ", " ")
assert.NoError(t, enc.Encode(observabilityAlertsConfig))
// The below can be copy-pasted into
// The below can be copy-pasted into site-config 'observability.alerts':
// https://sourcegraph.sourcegraph.com/search?q=context:global+repo:github.com/sourcegraph/deploy-sourcegraph-cloud+file:overlays/prod/frontend/files/site.json+%22observability.alerts%22:+%5B...%5D&patternType=structural&sm=1&groupBy=repo
autogold.Expect(`[
{