Remove investigationName from result.

bergmannf · bergmannf · commit 417d3f4e7e79 · 2025-02-05T11:42:27.000+01:00
The name is already known at the call-site.
diff --git a/cadctl/cmd/investigate/investigate.go b/cadctl/cmd/investigate/investigate.go
@@ -120,17 +120,17 @@ func run(_ *cobra.Command, _ []string) error {
 
 	customerAwsClient, err := managedcloud.CreateCustomerAWSClient(cluster, ocmClient)
 	if err != nil {
-		ccamResources := &investigation.Resources{Cluster: cluster, ClusterDeployment: clusterDeployment, AwsClient: customerAwsClient, OcmClient: ocmClient, PdClient: pdClient, AdditionalResources: map[string]interface{}{"alertType": alertInvestigation.Name, "error": err}}
+		ccamResources := &investigation.Resources{Cluster: cluster, ClusterDeployment: clusterDeployment, AwsClient: customerAwsClient, OcmClient: ocmClient, PdClient: pdClient, AdditionalResources: map[string]interface{}{"error": err}}
 		result, err := ccam.Investigate(ccamResources)
-		updateMetrics(&result)
+		updateMetrics(alertInvestigation.Name, &result)
 		return err
 	}
 
 	investigationResources := &investigation.Resources{Cluster: cluster, ClusterDeployment: clusterDeployment, AwsClient: customerAwsClient, OcmClient: ocmClient, PdClient: pdClient}
 
 	logging.Infof("Starting investigation for %s", alertInvestigation.Name)
 	result, err := alertInvestigation.Run(investigationResources)
-	updateMetrics(&result)
+	updateMetrics(alertInvestigation.Name, &result)
 	return err
 }
 
@@ -176,14 +176,14 @@ func clusterRequiresInvestigation(cluster *cmv1.Cluster, pdClient *pagerduty.Sdk
 	return true, nil
 }
 
-func updateMetrics(result *investigation.InvestigationResult) {
+func updateMetrics(investigationName string, result *investigation.InvestigationResult) {
 	if result.ServiceLogSent.Performed {
-		metrics.Inc(metrics.ServicelogSent, append([]string{result.InvestigationName}, result.ServiceLogSent.Labels...)...)
+		metrics.Inc(metrics.ServicelogSent, append([]string{investigationName}, result.ServiceLogSent.Labels...)...)
 	}
 	if result.ServiceLogPrepared.Performed {
-		metrics.Inc(metrics.ServicelogPrepared, append([]string{result.InvestigationName}, result.ServiceLogPrepared.Labels...)...)
+		metrics.Inc(metrics.ServicelogPrepared, append([]string{investigationName}, result.ServiceLogPrepared.Labels...)...)
 	}
 	if result.LimitedSupportSet.Performed {
-		metrics.Inc(metrics.LimitedSupportSet, append([]string{result.InvestigationName}, result.LimitedSupportSet.Labels...)...)
+		metrics.Inc(metrics.LimitedSupportSet, append([]string{investigationName}, result.LimitedSupportSet.Labels...)...)
 	}
 }
diff --git a/pkg/investigations/ccam/ccam.go b/pkg/investigations/ccam/ccam.go
@@ -24,11 +24,6 @@ func Investigate(r *investigation.Resources) (investigation.InvestigationResult,
 	cluster := r.Cluster
 	ocmClient := r.OcmClient
 	pdClient := r.PdClient
-	alertType, ok := r.AdditionalResources["alertType"].(string)
-	if !ok {
-		return result, fmt.Errorf("Missing required CCAM field 'alertType'")
-	}
-	result.InvestigationName = alertType
 	bpError, ok := r.AdditionalResources["error"].(error)
 	if !ok {
 		return result, fmt.Errorf("Missing required CCAM field 'error'")
diff --git a/pkg/investigations/ccam/ccam_test.go b/pkg/investigations/ccam/ccam_test.go
@@ -16,8 +16,7 @@ func TestEvaluateRandomError(t *testing.T) {
 		OcmClient:         nil,
 		PdClient:          nil,
 		AdditionalResources: map[string]interface{}{
-			"alertType": "",
-			"error":     errors.New("timeout"),
+			"error": errors.New("timeout"),
 		},
 	}
 	_, err := Investigate(&input)
diff --git a/pkg/investigations/chgm/chgm.go b/pkg/investigations/chgm/chgm.go
@@ -22,8 +22,6 @@ import (
 )
 
 var (
-	investigationName = "ClusterHasGoneMissing"
-
 	chgmSL = ocm.ServiceLog{
 		Severity:     "Critical",
 		Summary:      "Action required: cluster not checking in",
@@ -40,7 +38,7 @@ var (
 
 // Investigate runs the investigation for a triggered chgm pagerduty event
 func Investigate(r *investigation.Resources) (investigation.InvestigationResult, error) {
-	result := investigation.InvestigationResult{InvestigationName: investigationName}
+	result := investigation.InvestigationResult{}
 	notes := notewriter.New("CHGM", logging.RawLogger)
 
 	// 1. Check if the user stopped instances
diff --git a/pkg/investigations/cpd/cpd.go b/pkg/investigations/cpd/cpd.go
@@ -10,11 +10,8 @@ import (
 	"github.com/openshift/configuration-anomaly-detection/pkg/ocm"
 )
 
-var (
-	investigationName = "ClusterProvisioningDelay"
-	// https://raw.githubusercontent.com/openshift/managed-notifications/master/osd/aws/InstallFailed_NoRouteToInternet.json
-	byovpcRoutingSL = &ocm.ServiceLog{Severity: "Major", Summary: "Installation blocked: Missing route to internet", Description: "Your cluster's installation is blocked because of the missing route to internet in the route table(s) associated with the supplied subnet(s) for cluster installation. Please review and validate the routes by following documentation and re-install the cluster: https://docs.openshift.com/container-platform/latest/installing/installing_aws/installing-aws-vpc.html#installation-custom-aws-vpc-requirements_installing-aws-vpc.", InternalOnly: false, ServiceName: "SREManualAction"}
-)
+// https://raw.githubusercontent.com/openshift/managed-notifications/master/osd/aws/InstallFailed_NoRouteToInternet.json
+var byovpcRoutingSL = &ocm.ServiceLog{Severity: "Major", Summary: "Installation blocked: Missing route to internet", Description: "Your cluster's installation is blocked because of the missing route to internet in the route table(s) associated with the supplied subnet(s) for cluster installation. Please review and validate the routes by following documentation and re-install the cluster: https://docs.openshift.com/container-platform/latest/installing/installing_aws/installing-aws-vpc.html#installation-custom-aws-vpc-requirements_installing-aws-vpc.", InternalOnly: false, ServiceName: "SREManualAction"}
 
 // Investigate runs the investigation for a triggered CPD pagerduty event
 // Currently what this investigation does is:
@@ -27,7 +24,7 @@ var (
 // The reasoning for this is that we don't fully trust network verifier yet.
 // In the future, we want to automate service logs based on the network verifier output.
 func Investigate(r *investigation.Resources) (investigation.InvestigationResult, error) {
-	result := investigation.InvestigationResult{InvestigationName: investigationName}
+	result := investigation.InvestigationResult{}
 	notes := notewriter.New("CPD", logging.RawLogger)
 
 	if r.Cluster.Status().State() == "ready" {
diff --git a/pkg/investigations/investigation.go b/pkg/investigations/investigation.go
@@ -15,7 +15,6 @@ type InvestigationStep struct {
 }
 
 type InvestigationResult struct {
-	InvestigationName  string
 	LimitedSupportSet  InvestigationStep
 	ServiceLogPrepared InvestigationStep
 	ServiceLogSent     InvestigationStep

Original file line number	Diff line number	Diff line change
`@@ -120,17 +120,17 @@ func run(_ *cobra.Command, _ []string) error {`
`120`	`120`
`121`	`121`	`customerAwsClient, err := managedcloud.CreateCustomerAWSClient(cluster, ocmClient)`
`122`	`122`	`if err != nil {`
`123`		`- ccamResources := &investigation.Resources{Cluster: cluster, ClusterDeployment: clusterDeployment, AwsClient: customerAwsClient, OcmClient: ocmClient, PdClient: pdClient, AdditionalResources: map[string]interface{}{"alertType": alertInvestigation.Name, "error": err}}`
	`123`	`+ ccamResources := &investigation.Resources{Cluster: cluster, ClusterDeployment: clusterDeployment, AwsClient: customerAwsClient, OcmClient: ocmClient, PdClient: pdClient, AdditionalResources: map[string]interface{}{"error": err}}`
`124`	`124`	`result, err := ccam.Investigate(ccamResources)`
`125`		`- updateMetrics(&result)`
	`125`	`+ updateMetrics(alertInvestigation.Name, &result)`
`126`	`126`	`return err`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`investigationResources := &investigation.Resources{Cluster: cluster, ClusterDeployment: clusterDeployment, AwsClient: customerAwsClient, OcmClient: ocmClient, PdClient: pdClient}`
`130`	`130`
`131`	`131`	`logging.Infof("Starting investigation for %s", alertInvestigation.Name)`
`132`	`132`	`result, err := alertInvestigation.Run(investigationResources)`
`133`		`- updateMetrics(&result)`
	`133`	`+ updateMetrics(alertInvestigation.Name, &result)`
`134`	`134`	`return err`
`135`	`135`	`}`
`136`	`136`
`@@ -176,14 +176,14 @@ func clusterRequiresInvestigation(cluster cmv1.Cluster, pdClient pagerduty.Sdk`
`176`	`176`	`return true, nil`
`177`	`177`	`}`
`178`	`178`
`179`		`-func updateMetrics(result *investigation.InvestigationResult) {`
	`179`	`+func updateMetrics(investigationName string, result *investigation.InvestigationResult) {`
`180`	`180`	`if result.ServiceLogSent.Performed {`
`181`		`- metrics.Inc(metrics.ServicelogSent, append([]string{result.InvestigationName}, result.ServiceLogSent.Labels...)...)`
	`181`	`+ metrics.Inc(metrics.ServicelogSent, append([]string{investigationName}, result.ServiceLogSent.Labels...)...)`
`182`	`182`	`}`
`183`	`183`	`if result.ServiceLogPrepared.Performed {`
`184`		`- metrics.Inc(metrics.ServicelogPrepared, append([]string{result.InvestigationName}, result.ServiceLogPrepared.Labels...)...)`
	`184`	`+ metrics.Inc(metrics.ServicelogPrepared, append([]string{investigationName}, result.ServiceLogPrepared.Labels...)...)`
`185`	`185`	`}`
`186`	`186`	`if result.LimitedSupportSet.Performed {`
`187`		`- metrics.Inc(metrics.LimitedSupportSet, append([]string{result.InvestigationName}, result.LimitedSupportSet.Labels...)...)`
	`187`	`+ metrics.Inc(metrics.LimitedSupportSet, append([]string{investigationName}, result.LimitedSupportSet.Labels...)...)`
`188`	`188`	`}`
`189`	`189`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,6 @@ type InvestigationStep struct {`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`type InvestigationResult struct {`
`18`		`- InvestigationName string`
`19`	`18`	`LimitedSupportSet InvestigationStep`
`20`	`19`	`ServiceLogPrepared InvestigationStep`
`21`	`20`	`ServiceLogSent InvestigationStep`