feat(operator): store trace IDs for each phase of AppVersion

Signed-off-by: Florian Bacher <[email protected]>
keptn · Nov 22, 2022 · cd2f8cb · cd2f8cb
1 parent 3eb47d0
commit cd2f8cb
Show file tree

Hide file tree

Showing 11 changed files with 378 additions and 149 deletions.
diff --git a/operator/api/v1alpha1/common/phases.go b/operator/api/v1alpha1/common/phases.go
@@ -1,6 +1,10 @@
 package common
 
-import "strings"
+import (
+	"strings"
+
+	"go.opentelemetry.io/otel/propagation"
+)
 
 type KeptnPhase KeptnPhaseType
 
@@ -47,3 +51,13 @@ var (
 	PhaseCompleted              = KeptnPhaseType{LongName: "Completed", ShortName: "Completed"}
 	PhaseCancelled              = KeptnPhaseType{LongName: "Cancelled", ShortName: "Cancelled"}
 )
+
+type PhaseTraceID map[string]propagation.MapCarrier
+
+func (pid PhaseTraceID) SetPhaseTraceID(phase string, carrier propagation.MapCarrier) {
+	pid[phase] = carrier
+}
+
+func (pid PhaseTraceID) GetPhaseTraceID(phase string) propagation.MapCarrier {
+	return pid[phase]
+}
diff --git a/operator/api/v1alpha1/keptnappversion_types.go b/operator/api/v1alpha1/keptnappversion_types.go
@@ -52,13 +52,14 @@ type KeptnAppVersionStatus struct {
 	// +kubebuilder:default:=Pending
 	PostDeploymentEvaluationStatus common.KeptnState `json:"postDeploymentEvaluationStatus,omitempty"`
 	// +kubebuilder:default:=Pending
-	WorkloadOverallStatus              common.KeptnState  `json:"workloadOverallStatus,omitempty"`
-	WorkloadStatus                     []WorkloadStatus   `json:"workloadStatus,omitempty"`
-	CurrentPhase                       string             `json:"currentPhase,omitempty"`
-	PreDeploymentTaskStatus            []TaskStatus       `json:"preDeploymentTaskStatus,omitempty"`
-	PostDeploymentTaskStatus           []TaskStatus       `json:"postDeploymentTaskStatus,omitempty"`
-	PreDeploymentEvaluationTaskStatus  []EvaluationStatus `json:"preDeploymentEvaluationTaskStatus,omitempty"`
-	PostDeploymentEvaluationTaskStatus []EvaluationStatus `json:"postDeploymentEvaluationTaskStatus,omitempty"`
+	WorkloadOverallStatus              common.KeptnState                 `json:"workloadOverallStatus,omitempty"`
+	WorkloadStatus                     []WorkloadStatus                  `json:"workloadStatus,omitempty"`
+	CurrentPhase                       string                            `json:"currentPhase,omitempty"`
+	PreDeploymentTaskStatus            []TaskStatus                      `json:"preDeploymentTaskStatus,omitempty"`
+	PostDeploymentTaskStatus           []TaskStatus                      `json:"postDeploymentTaskStatus,omitempty"`
+	PreDeploymentEvaluationTaskStatus  []EvaluationStatus                `json:"preDeploymentEvaluationTaskStatus,omitempty"`
+	PostDeploymentEvaluationTaskStatus []EvaluationStatus                `json:"postDeploymentEvaluationTaskStatus,omitempty"`
+	PhaseTraceIDs                      map[string]propagation.MapCarrier `json:"phaseTraceIDs,omitempty"`
 	// +kubebuilder:default:=Pending
 	Status common.KeptnState `json:"status,omitempty"`
 
@@ -373,5 +374,11 @@ func (a *KeptnAppVersion) CancelRemainingPhases(phase common.KeptnPhaseType) {
 	a.Status.PostDeploymentStatus = common.StateCancelled
 	a.Status.PostDeploymentEvaluationStatus = common.StateCancelled
 	a.Status.Status = common.StateFailed
+}
 
+func (a *KeptnAppVersion) SetPhaseTraceID(phase string, carrier propagation.MapCarrier) {
+	if a.Status.PhaseTraceIDs == nil {
+		a.Status.PhaseTraceIDs = map[string]propagation.MapCarrier{}
+	}
+	a.Status.PhaseTraceIDs[phase] = carrier
 }
diff --git a/operator/api/v1alpha1/keptnworkloadinstance_types.go b/operator/api/v1alpha1/keptnworkloadinstance_types.go
@@ -50,14 +50,15 @@ type KeptnWorkloadInstanceStatus struct {
 	// +kubebuilder:default:=Pending
 	PostDeploymentEvaluationStatus common.KeptnState `json:"postDeploymentEvaluationStatus,omitempty"`
 	// +kubebuilder:default:=Pending
-	PostDeploymentStatus               common.KeptnState  `json:"postDeploymentStatus,omitempty"`
-	PreDeploymentTaskStatus            []TaskStatus       `json:"preDeploymentTaskStatus,omitempty"`
-	PostDeploymentTaskStatus           []TaskStatus       `json:"postDeploymentTaskStatus,omitempty"`
-	PreDeploymentEvaluationTaskStatus  []EvaluationStatus `json:"preDeploymentEvaluationTaskStatus,omitempty"`
-	PostDeploymentEvaluationTaskStatus []EvaluationStatus `json:"postDeploymentEvaluationTaskStatus,omitempty"`
-	StartTime                          metav1.Time        `json:"startTime,omitempty"`
-	EndTime                            metav1.Time        `json:"endTime,omitempty"`
-	CurrentPhase                       string             `json:"currentPhase,omitempty"`
+	PostDeploymentStatus               common.KeptnState                 `json:"postDeploymentStatus,omitempty"`
+	PreDeploymentTaskStatus            []TaskStatus                      `json:"preDeploymentTaskStatus,omitempty"`
+	PostDeploymentTaskStatus           []TaskStatus                      `json:"postDeploymentTaskStatus,omitempty"`
+	PreDeploymentEvaluationTaskStatus  []EvaluationStatus                `json:"preDeploymentEvaluationTaskStatus,omitempty"`
+	PostDeploymentEvaluationTaskStatus []EvaluationStatus                `json:"postDeploymentEvaluationTaskStatus,omitempty"`
+	StartTime                          metav1.Time                       `json:"startTime,omitempty"`
+	EndTime                            metav1.Time                       `json:"endTime,omitempty"`
+	CurrentPhase                       string                            `json:"currentPhase,omitempty"`
+	PhaseTraceIDs                      map[string]propagation.MapCarrier `json:"phaseTraceIDs,omitempty"`
 	// +kubebuilder:default:=Pending
 	Status common.KeptnState `json:"status,omitempty"`
 }
@@ -411,3 +412,10 @@ func (w *KeptnWorkloadInstance) CancelRemainingPhases(phase common.KeptnPhaseTyp
 	w.Status.PostDeploymentEvaluationStatus = common.StateCancelled
 	w.Status.Status = common.StateFailed
 }
+
+func (w *KeptnWorkloadInstance) SetPhaseTraceID(phase string, carrier propagation.MapCarrier) {
+	if w.Status.PhaseTraceIDs == nil {
+		w.Status.PhaseTraceIDs = map[string]propagation.MapCarrier{}
+	}
+	w.Status.PhaseTraceIDs[phase] = carrier
+}
diff --git a/operator/api/v1alpha1/zz_generated.deepcopy.go b/operator/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/operator/config/crd/bases/lifecycle.keptn.sh_keptnappversions.yaml b/operator/config/crd/bases/lifecycle.keptn.sh_keptnappversions.yaml
@@ -117,6 +117,14 @@ spec:
               endTime:
                 format: date-time
                 type: string
+              phaseTraceIDs:
+                additionalProperties:
+                  additionalProperties:
+                    type: string
+                  description: MapCarrier is a TextMapCarrier that uses a map held
+                    in memory as a storage medium for propagated key-value pairs.
+                  type: object
+                type: object
               postDeploymentEvaluationStatus:
                 default: Pending
                 type: string

diff --git a/operator/config/crd/bases/lifecycle.keptn.sh_keptnworkloadinstances.yaml b/operator/config/crd/bases/lifecycle.keptn.sh_keptnworkloadinstances.yaml
@@ -134,6 +134,14 @@ spec:
               endTime:
                 format: date-time
                 type: string
+              phaseTraceIDs:
+                additionalProperties:
+                  additionalProperties:
+                    type: string
+                  description: MapCarrier is a TextMapCarrier that uses a map held
+                    in memory as a storage medium for propagated key-value pairs.
+                  type: object
+                type: object
               postDeploymentEvaluationStatus:
                 default: Pending
                 type: string