OSD-29424 - Update PD incident title after investigation

Author: tnierman

cadctl/cmd/investigate/investigate.go

@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"strings"
 
 	cmv1 "github.com/openshift-online/ocm-sdk-go/clustersmgmt/v1"
 	investigations "github.com/openshift/configuration-anomaly-detection/pkg/investigations"
@@ -47,6 +48,8 @@ var (
 	payloadPath  = "./payload.json"
 )
 
+const pagerdutyTitlePrefix = "[CAD Investigated]"
+
 func init() {
 	InvestigateCmd.Flags().StringVarP(&payloadPath, "payload-path", "p", payloadPath, "the path to the payload")
 	InvestigateCmd.Flags().StringVarP(&logging.LogLevelString, "log-level", "l", "", "the log level [debug,info,warn,error,fatal], default = info")
@@ -151,8 +154,11 @@ func run(cmd *cobra.Command, _ []string) error {
 	logging.Infof("Starting investigation for %s", alertInvestigation.Name())
 	result, err := alertInvestigation.Run(investigationResources)
 	updateMetrics(alertInvestigation.Name(), &result)
+	if err != nil {
+		return err
+	}
 
-	return err
+	return updateIncidentTitle(pdClient)
 }
 
 func handleCADFailure(err error, resources *investigation.Resources, pdClient *pagerduty.SdkClient) {
@@ -231,3 +237,16 @@ func updateMetrics(investigationName string, result *investigation.Investigation
 		metrics.Inc(metrics.LimitedSupportSet, append([]string{investigationName}, result.LimitedSupportSet.Labels...)...)
 	}
 }
+
+func updateIncidentTitle(pdClient *pagerduty.SdkClient) error {
+	currentTitle := pdClient.GetTitle()
+	if strings.Contains(currentTitle, pagerdutyTitlePrefix) {
+		return nil
+	}
+	newTitle := fmt.Sprintf("[CAD Investigated] %s", currentTitle)
+	err := pdClient.UpdateIncidentTitle(newTitle)
+	if err != nil {
+		return fmt.Errorf("failed to update PagerDuty incident title: %w", err)
+	}
+	return nil
+}

pkg/pagerduty/mock/pagerdutymock.go

@@ -51,6 +51,7 @@ type Client interface {
 	GetServiceID() string
 	EscalateIncidentWithNote(notes string) error
 	EscalateIncident() error
+	UpdateIncidentTitle(title string) error
 }
 
 // SdkClient will hold all the required fields for any SdkClient Operation
@@ -228,22 +229,22 @@ func (c *SdkClient) SetIncidentData(incidentData *IncidentData) {
 	c.incidentData = incidentData
 }
 
-// GetServiceID returns the event type of the webhook
+// GetServiceID returns the ID of the pagerduty service containing the client's incident
 func (c *SdkClient) GetServiceID() string {
 	return c.incidentData.ServiceID
 }
 
-// GetServiceName returns the event type of the webhook
+// GetServiceName returns the pagerduty service containing the client's incident
 func (c *SdkClient) GetServiceName() string {
 	return c.incidentData.ServiceSummary
 }
 
-// GetTitle returns the event type of the webhook
+// GetTitle returns the title of the client's incident
 func (c *SdkClient) GetTitle() string {
 	return c.incidentData.IncidentTitle
 }
 
-// GetIncidentID returns the event type of the webhook
+// GetIncidentID returns the ID of the client's incident
 func (c *SdkClient) GetIncidentID() string {
 	return c.incidentData.IncidentID
 }
@@ -541,3 +542,18 @@ func (c *SdkClient) EscalateIncident() error {
 	}
 	return nil
 }
+
+func (c *SdkClient) UpdateIncidentTitle(title string) error {
+	o := []sdk.ManageIncidentsOptions{
+		{
+			ID:    c.GetIncidentID(),
+			Title: title,
+		},
+	}
+
+	err := c.updateIncident(o)
+	if err != nil {
+		return fmt.Errorf("failed to update incident: %w", err)
+	}
+	return nil
+}