|
| 1 | +package reconciler |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "encoding/json" |
| 6 | + |
| 7 | + "github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode/keys" |
| 8 | + "github.com/openshift-pipelines/pipelines-as-code/pkg/tracing" |
| 9 | + tektonv1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1" |
| 10 | + "go.opentelemetry.io/otel" |
| 11 | + "go.opentelemetry.io/otel/attribute" |
| 12 | + "go.opentelemetry.io/otel/propagation" |
| 13 | + semconv "go.opentelemetry.io/otel/semconv/v1.37.0" |
| 14 | + "go.opentelemetry.io/otel/trace" |
| 15 | + corev1 "k8s.io/api/core/v1" |
| 16 | + "knative.dev/pkg/apis" |
| 17 | +) |
| 18 | + |
| 19 | +const ( |
| 20 | + applicationLabel = "appstudio.openshift.io/application" |
| 21 | + componentLabel = "appstudio.openshift.io/component" |
| 22 | + stageBuild = "build" |
| 23 | +) |
| 24 | + |
| 25 | + |
| 26 | +// extractSpanContext extracts the trace context from the pipelinerunSpanContext annotation. |
| 27 | +func extractSpanContext(pr *tektonv1.PipelineRun) (context.Context, bool) { |
| 28 | + raw, ok := pr.GetAnnotations()[keys.SpanContextAnnotation] |
| 29 | + if !ok || raw == "" { |
| 30 | + return nil, false |
| 31 | + } |
| 32 | + var carrierMap map[string]string |
| 33 | + if err := json.Unmarshal([]byte(raw), &carrierMap); err != nil { |
| 34 | + return nil, false |
| 35 | + } |
| 36 | + carrier := propagation.MapCarrier(carrierMap) |
| 37 | + prop := propagation.TraceContext{} |
| 38 | + ctx := prop.Extract(context.Background(), carrier) |
| 39 | + sc := trace.SpanContextFromContext(ctx) |
| 40 | + if !sc.IsValid() { |
| 41 | + return nil, false |
| 42 | + } |
| 43 | + return ctx, true |
| 44 | +} |
| 45 | + |
| 46 | +// emitTimingSpans emits wait_duration and execute_duration spans for a completed build PipelineRun. |
| 47 | +func emitTimingSpans(pr *tektonv1.PipelineRun) { |
| 48 | + parentCtx, ok := extractSpanContext(pr) |
| 49 | + if !ok { |
| 50 | + return |
| 51 | + } |
| 52 | + |
| 53 | + tracer := otel.GetTracerProvider().Tracer(tracing.TracerName) |
| 54 | + commonAttrs := buildCommonAttributes(pr) |
| 55 | + |
| 56 | + // Emit waitDuration: creationTimestamp -> status.startTime |
| 57 | + if pr.Status.StartTime != nil { |
| 58 | + _, waitSpan := tracer.Start(parentCtx, "waitDuration", |
| 59 | + trace.WithTimestamp(pr.CreationTimestamp.Time), |
| 60 | + trace.WithAttributes(commonAttrs...), |
| 61 | + ) |
| 62 | + waitSpan.End(trace.WithTimestamp(pr.Status.StartTime.Time)) |
| 63 | + } |
| 64 | + |
| 65 | + // Emit executeDuration: status.startTime -> status.completionTime |
| 66 | + if pr.Status.StartTime != nil && pr.Status.CompletionTime != nil { |
| 67 | + execAttrs := append(commonAttrs, buildExecuteAttributes(pr)...) |
| 68 | + _, execSpan := tracer.Start(parentCtx, "executeDuration", |
| 69 | + trace.WithTimestamp(pr.Status.StartTime.Time), |
| 70 | + trace.WithAttributes(execAttrs...), |
| 71 | + ) |
| 72 | + execSpan.End(trace.WithTimestamp(pr.Status.CompletionTime.Time)) |
| 73 | + } |
| 74 | +} |
| 75 | + |
| 76 | +// buildCommonAttributes returns span attributes common to both timing spans. |
| 77 | +func buildCommonAttributes(pr *tektonv1.PipelineRun) []attribute.KeyValue { |
| 78 | + attrs := []attribute.KeyValue{ |
| 79 | + semconv.K8SNamespaceName(pr.GetNamespace()), |
| 80 | + tracing.TektonPipelineRunNameKey.String(pr.GetName()), |
| 81 | + tracing.TektonPipelineRunUIDKey.String(string(pr.GetUID())), |
| 82 | + tracing.DeliveryStageKey.String(stageBuild), |
| 83 | + tracing.DeliveryApplicationKey.String(pr.GetLabels()[applicationLabel]), |
| 84 | + } |
| 85 | + if component := pr.GetLabels()[componentLabel]; component != "" { |
| 86 | + attrs = append(attrs, tracing.DeliveryComponentKey.String(component)) |
| 87 | + } |
| 88 | + return attrs |
| 89 | +} |
| 90 | + |
| 91 | +// buildExecuteAttributes returns span attributes specific to execute_duration. |
| 92 | +func buildExecuteAttributes(pr *tektonv1.PipelineRun) []attribute.KeyValue { |
| 93 | + cond := pr.Status.GetCondition(apis.ConditionSucceeded) |
| 94 | + success := true |
| 95 | + reason := "" |
| 96 | + if cond != nil { |
| 97 | + reason = cond.Reason |
| 98 | + if cond.Status == corev1.ConditionFalse { |
| 99 | + success = false |
| 100 | + } |
| 101 | + } |
| 102 | + return []attribute.KeyValue{ |
| 103 | + tracing.DeliverySuccessKey.Bool(success), |
| 104 | + tracing.DeliveryReasonKey.String(reason), |
| 105 | + } |
| 106 | +} |
0 commit comments