Merge pull request #476 from overmindtech/more-business-milestones

Added more business milestones to track where failures happen

cmd/tea_ensuretoken.go

@@ -20,6 +20,7 @@ import (
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/viper"
 	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/trace"
 	"golang.org/x/oauth2"
 )
 
@@ -126,16 +127,34 @@ func (m ensureTokenModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		m.title = "Using stored token"
 		m.deviceMessage = ""
 		cmds = append(cmds, m.tokenAvailable(msg.token))
+
+		if cmdSpan != nil {
+			cmdSpan.AddEvent("User Authenticated", trace.WithAttributes(
+				attribute.String("ovm.auth.mechanism", "Token"),
+			))
+		}
 	case tokenReceivedMsg:
 		m.status = taskStatusDone
 		m.title = "Authentication successful, using API key"
 		m.deviceMessage = ""
 		cmds = append(cmds, m.tokenAvailable(msg.token))
+
+		if cmdSpan != nil {
+			cmdSpan.AddEvent("User Authenticated", trace.WithAttributes(
+				attribute.String("ovm.auth.mechanism", "API Key"),
+			))
+		}
 	case tokenStoredMsg:
 		m.status = taskStatusDone
 		m.title = fmt.Sprintf("Authentication successful, token stored locally (%v)", msg.file)
 		m.deviceMessage = ""
 		cmds = append(cmds, m.tokenAvailable(msg.token))
+
+		if cmdSpan != nil {
+			cmdSpan.AddEvent("User Authenticated", trace.WithAttributes(
+				attribute.String("ovm.auth.mechanism", "Browser"),
+			))
+		}
 	case otherError:
 		if msg.id == m.spinner.ID() {
 			m.errors = append(m.errors, fmt.Sprintf("Note: %v", msg.err))

cmd/tea_initialisesources.go

@@ -156,6 +156,10 @@ func (m initialiseSourcesModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 				)
 				cmds = append(cmds, input.Focus())
 			} else {
+				if cmdSpan != nil {
+					cmdSpan.AddEvent("Used stored AWS config")
+				}
+
 				cmds = append(cmds, m.storeConfigCmd(aws_config, aws_profile))
 				cmds = append(cmds, m.startSourcesCmd(aws_config, aws_profile))
 			}
@@ -166,6 +170,10 @@ func (m initialiseSourcesModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		m.awsSourceRunning = true
 		m.stdlibSourceRunning = true
 		m.status = taskStatusDone
+
+		if cmdSpan != nil {
+			cmdSpan.AddEvent("Sources initialised")
+		}
 	case sourceInitialisationFailedMsg:
 		m.status = taskStatusError
 		errorHint := "Error initialising sources"
@@ -259,6 +267,11 @@ func (m initialiseSourcesModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 			}
 		case huh.StateCompleted:
 			m.profileInputFormDone = true
+
+			if cmdSpan != nil {
+				cmdSpan.AddEvent("User provided AWS config")
+			}
+
 			// store the result
 			viper.Set("aws-profile", m.profileInputForm.GetString("aws-profile"))
 			cmds = append(cmds, m.storeConfigCmd(viper.GetString("aws-config"), viper.GetString("aws-profile")))

cmd/tea_plan.go

@@ -10,6 +10,9 @@ import (
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/overmindtech/cli/tracing"
 	"github.com/spf13/viper"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/codes"
+	"go.opentelemetry.io/otel/trace"
 )
 
 type runPlanModel struct {
@@ -110,10 +113,27 @@ func (m runPlanModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 			}))
 
 	case runPlanFinishedMsg:
+		var attrs []attribute.KeyValue
+		var eventName string
+
 		if msg.err != nil {
 			m.taskModel.status = taskStatusError
+
+			// Tracing info
+			attrs = append(attrs, attribute.String("error", msg.err.Error()))
+			eventName = "Terraform plan failed"
 		} else {
 			m.taskModel.status = taskStatusDone
+
+			// Tracing info
+			eventName = "Terraform plan finished"
+		}
+
+		if cmdSpan != nil {
+			cmdSpan.AddEvent(eventName, trace.WithAttributes(attrs...))
+			if msg.err != nil {
+				cmdSpan.SetStatus(codes.Error, msg.err.Error())
+			}
 		}
 	}
 

cmd/tea_revlink.go

@@ -11,6 +11,8 @@ import (
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/overmindtech/sdp-go"
 	"github.com/spf13/viper"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/trace"
 )
 
 type revlinkWarmupFinishedMsg struct{}
@@ -110,6 +112,20 @@ func (m revlinkWarmupModel) Update(msg tea.Msg) (revlinkWarmupModel, tea.Cmd) {
 			m.watchdogCancel()
 			m.watchdogCancel = nil
 		}
+
+		if cmdSpan != nil {
+			var attrs []attribute.KeyValue
+
+			if m.currentStatus != nil {
+				attrs = append(attrs,
+					attribute.String("ovm.cli.revlinkWarmupStatus", m.currentStatus.GetStatus()),
+					attribute.Int("ovm.cli.revlinkWarmupItems", int(m.currentStatus.GetItems())),
+					attribute.Int("ovm.cli.revlinkWarmupEdges", int(m.currentStatus.GetEdges())),
+				)
+			}
+
+			cmdSpan.AddEvent("Revlink warmup finished", trace.WithAttributes(attrs...))
+		}
 	default:
 		var taskCmd tea.Cmd
 		m.taskModel, taskCmd = m.taskModel.Update(msg)

cmd/tea_submitplan.go

@@ -724,6 +724,17 @@ func (m submitPlanModel) submitPlanCmd() tea.Msg {
 	}
 	m.processing <- submitPlanUpdateMsg{m.blastRadiusTask.FinishMsg()}
 
+	// Add tracing that the blast radius has finished
+	if cmdSpan != nil {
+		cmdSpan.AddEvent("Blast radius calculation finished", trace.WithAttributes(
+			attribute.Int("ovm.blast_radius.items", int(msg.GetNumItems())),
+			attribute.Int("ovm.blast_radius.edges", int(msg.GetNumEdges())),
+			attribute.String("ovm.blast_radius.state", msg.GetState().String()),
+			attribute.StringSlice("ovm.blast_radius.errors", msg.GetErrors()),
+			attribute.String("ovm.change.uuid", changeUuid.String()),
+		))
+	}
+
 	changeUrl := *m.oi.FrontendUrl
 	changeUrl.Path = fmt.Sprintf("%v/changes/%v/blast-radius", changeUrl.Path, changeUuid)
 	log.WithField("change-url", changeUrl.String()).Info("Change ready")
@@ -737,8 +748,9 @@ func (m submitPlanModel) submitPlanCmd() tea.Msg {
 	///////////////////////////////////////////////////////////////////
 	m.processing <- submitPlanUpdateMsg{m.riskTask.UpdateStatusMsg(taskStatusRunning)}
 	risksErrored := false
+	var riskRes *connect.Response[sdp.GetChangeRisksResponse]
 	for {
-		riskRes, err := client.GetChangeRisks(ctx, &connect.Request[sdp.GetChangeRisksRequest]{
+		riskRes, err = client.GetChangeRisks(ctx, &connect.Request[sdp.GetChangeRisksRequest]{
 			Msg: &sdp.GetChangeRisksRequest{
 				UUID: changeUuid[:],
 			},
@@ -784,6 +796,14 @@ func (m submitPlanModel) submitPlanCmd() tea.Msg {
 		return nil
 	}
 
+	// Submit milestone for tracing
+	if cmdSpan != nil {
+		cmdSpan.AddEvent("Risk calculation finished", trace.WithAttributes(
+			attribute.Int("ovm.risks.count", len(riskRes.Msg.GetChangeRiskMetadata().GetRisks())),
+			attribute.String("ovm.change.uuid", changeUuid.String()),
+		))
+	}
+
 	m.processing <- submitPlanUpdateMsg{m.riskTask.UpdateStatusMsg(taskStatusDone)}
 	m.processing <- submitPlanUpdateMsg{submitPlanFinishedMsg{"Done"}}