Document the requirement to match investigation name and directory

RaphaelBut · RaphaelBut · commit cd8df3b18543 · 2025-02-10T14:07:12.000Z
Backplane takes the investigation name and looks for a directory with
the same name to pull the metadata.yaml
diff --git a/pkg/investigations/mapping/mapping.go b/pkg/investigations/mapping/mapping.go
@@ -12,6 +12,9 @@ import (
 )
 
 // GetInvestigation will return the investigation function for the identified alert
+//
+// Please note that when adding an investigation the name and the directory need to be the same,
+// so that backplane-api can fetch the metadata.yaml
 func GetInvestigation(alertTitle string) *investigation.Investigation {
 	// We currently map to the alert by using the title, we should use the name in the alert note in the future.
 	// This currently isn't feasible yet, as CPD's alertmanager doesn't allow for the field to exist.

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,9 @@ import (`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`// GetInvestigation will return the investigation function for the identified alert`
	`15`	`+//`
	`16`	`+// Please note that when adding an investigation the name and the directory need to be the same,`
	`17`	`+// so that backplane-api can fetch the metadata.yaml`
`15`	`18`	`func GetInvestigation(alertTitle string) *investigation.Investigation {`
`16`	`19`	`// We currently map to the alert by using the title, we should use the name in the alert note in the future.`
`17`	`20`	`// This currently isn't feasible yet, as CPD's alertmanager doesn't allow for the field to exist.`