|
| 1 | +/* |
| 2 | +Copyright 2025 The Flux authors |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package notifier |
| 18 | + |
| 19 | +import ( |
| 20 | + "context" |
| 21 | + "crypto/sha256" |
| 22 | + "crypto/tls" |
| 23 | + "encoding/base64" |
| 24 | + "fmt" |
| 25 | + "net/http" |
| 26 | + "net/url" |
| 27 | + "slices" |
| 28 | + |
| 29 | + "go.opentelemetry.io/otel/attribute" |
| 30 | + "go.opentelemetry.io/otel/codes" |
| 31 | + "go.opentelemetry.io/otel/exporters/otlp/otlptrace" |
| 32 | + "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp" |
| 33 | + "go.opentelemetry.io/otel/sdk/resource" |
| 34 | + sdktrace "go.opentelemetry.io/otel/sdk/trace" |
| 35 | + semconv "go.opentelemetry.io/otel/semconv/v1.34.0" |
| 36 | + "go.opentelemetry.io/otel/trace" |
| 37 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 38 | + "sigs.k8s.io/controller-runtime/pkg/log" |
| 39 | + |
| 40 | + eventv1 "github.com/fluxcd/pkg/apis/event/v1beta1" |
| 41 | + |
| 42 | + apiv1beta3 "github.com/fluxcd/notification-controller/api/v1beta3" |
| 43 | +) |
| 44 | + |
| 45 | +// Context key |
| 46 | +type alertMetadataContextKey struct{} |
| 47 | + |
| 48 | +func WithAlertMetadata(ctx context.Context, metadata metav1.ObjectMeta) context.Context { |
| 49 | + return context.WithValue(ctx, alertMetadataContextKey{}, metadata) |
| 50 | +} |
| 51 | + |
| 52 | +func GetAlertMetadata(ctx context.Context) (metav1.ObjectMeta, bool) { |
| 53 | + metadata, ok := ctx.Value(alertMetadataContextKey{}).(metav1.ObjectMeta) |
| 54 | + return metadata, ok |
| 55 | +} |
| 56 | + |
| 57 | +type OTLPTracer struct { |
| 58 | + tracerExporter *otlptrace.Exporter |
| 59 | +} |
| 60 | + |
| 61 | +func NewOTLPTracer(ctx context.Context, urlStr string, proxyURL string, headers map[string]string, tlsConfig *tls.Config, username string, password string) (*OTLPTracer, error) { |
| 62 | + // Set up OTLP exporter options |
| 63 | + httpOptions := []otlptracehttp.Option{ |
| 64 | + otlptracehttp.WithEndpointURL(urlStr), |
| 65 | + } |
| 66 | + |
| 67 | + // Add headers if available |
| 68 | + if len(headers) > 0 { |
| 69 | + // Add authentication header, if it doesn't exist yet |
| 70 | + if headers["Authorization"] == "" { |
| 71 | + // If username is not set, password is considered as token |
| 72 | + if username == "" { |
| 73 | + headers["Authorization"] = "Bearer " + password |
| 74 | + } else if username != "" && password != "" { |
| 75 | + auth := base64.StdEncoding.EncodeToString([]byte(username + ":" + password)) |
| 76 | + headers["Authorization"] = "Basic " + auth |
| 77 | + } |
| 78 | + } |
| 79 | + httpOptions = append(httpOptions, otlptracehttp.WithHeaders(headers)) |
| 80 | + } |
| 81 | + |
| 82 | + // Add TLS config if available |
| 83 | + if tlsConfig != nil { |
| 84 | + httpOptions = append(httpOptions, otlptracehttp.WithTLSClientConfig(tlsConfig)) |
| 85 | + } |
| 86 | + |
| 87 | + // Add proxy if available |
| 88 | + if proxyURL != "" { |
| 89 | + proxyURLparsed, err := url.Parse(proxyURL) |
| 90 | + if err != nil { |
| 91 | + return nil, fmt.Errorf("failed to proxy URL - %s: %w", proxyURL, err) |
| 92 | + } else { |
| 93 | + if username != "" && password != "" { |
| 94 | + proxyURLparsed.User = url.UserPassword(username, password) |
| 95 | + } |
| 96 | + httpOptions = append(httpOptions, otlptracehttp.WithProxy(func(*http.Request) (*url.URL, error) { |
| 97 | + return proxyURLparsed, nil |
| 98 | + })) |
| 99 | + } |
| 100 | + } |
| 101 | + |
| 102 | + exporter, err := otlptracehttp.New(ctx, httpOptions...) |
| 103 | + if err != nil { |
| 104 | + return nil, err |
| 105 | + } |
| 106 | + |
| 107 | + log.FromContext(ctx).Info("Successfully created OTEL tracerExporter") |
| 108 | + return &OTLPTracer{ |
| 109 | + tracerExporter: exporter, |
| 110 | + }, nil |
| 111 | +} |
| 112 | + |
| 113 | +// Post implements the notifier.Interface |
| 114 | +func (t *OTLPTracer) Post(ctx context.Context, event eventv1.Event) error { |
| 115 | + // Skip Git commit status update event. |
| 116 | + if event.HasMetadata(eventv1.MetaCommitStatusKey, eventv1.MetaCommitStatusUpdateValue) { |
| 117 | + return nil |
| 118 | + } |
| 119 | + |
| 120 | + logger := log.FromContext(ctx).WithValues( |
| 121 | + "event", event.Reason, |
| 122 | + "object", fmt.Sprintf("%s/%s/%s", event.InvolvedObject.Kind, event.InvolvedObject.Namespace, event.InvolvedObject.Name), |
| 123 | + "severity", event.Severity, |
| 124 | + ) |
| 125 | + logger.Info("OTEL Post function called", "event", event.Reason) |
| 126 | + |
| 127 | + alert, ok := GetAlertMetadata(ctx) |
| 128 | + if !ok { |
| 129 | + return fmt.Errorf("alert metadata not found in context") |
| 130 | + } |
| 131 | + |
| 132 | + // Extract revision from event metadata |
| 133 | + revision := getRevision(event.Metadata) |
| 134 | + |
| 135 | + // Create TraceProvider |
| 136 | + tp := sdktrace.NewTracerProvider( |
| 137 | + sdktrace.WithSpanProcessor(sdktrace.NewSimpleSpanProcessor(t.tracerExporter)), |
| 138 | + sdktrace.WithResource( |
| 139 | + resource.NewWithAttributes( |
| 140 | + semconv.SchemaURL, |
| 141 | + semconv.ServiceName(fmt.Sprintf("%s/%s", alert.GetNamespace(), alert.GetName())), |
| 142 | + semconv.ServiceNamespace(alert.GetNamespace()), |
| 143 | + semconv.ServiceInstanceID(string(alert.GetUID())), |
| 144 | + ), |
| 145 | + ), |
| 146 | + ) |
| 147 | + |
| 148 | + // Generate traceID |
| 149 | + logger.V(1).Info("Generating trace IDs", "alertUID", string(alert.UID), "revision", revision) |
| 150 | + var traceID trace.TraceID |
| 151 | + traceIDStr := generateID(string(alert.UID), revision) |
| 152 | + copy(traceID[:], traceIDStr[:16]) |
| 153 | + |
| 154 | + // Determine span relationship based on Flux object hierarchy |
| 155 | + var spanCtx context.Context = createSpanContext(ctx, event, traceID) |
| 156 | + |
| 157 | + // Skip if it's HelmRepository kind object (no considered as main source for tracing) |
| 158 | + if event.InvolvedObject.Kind != "HelmRepository" { |
| 159 | + logger.Info("Processing OTEL notification", "alert", alert.Name) |
| 160 | + |
| 161 | + } else { |
| 162 | + logger.Info("OTEL notification skipped", "alert", alert.Name) |
| 163 | + return nil |
| 164 | + } |
| 165 | + |
| 166 | + // Create single span with proper attributes |
| 167 | + span := processSpan(tp, spanCtx, event) |
| 168 | + // Set status based on event severity |
| 169 | + if event.Severity == eventv1.EventSeverityError { |
| 170 | + span.SetStatus(codes.Error, event.Message) |
| 171 | + } else { |
| 172 | + span.SetStatus(codes.Ok, event.Message) |
| 173 | + } |
| 174 | + |
| 175 | + defer span.End() |
| 176 | + |
| 177 | + serviceName := fmt.Sprintf("%s: %s/%s", apiv1beta3.AlertKind, alert.Namespace, alert.Name) |
| 178 | + logger.Info("Successfully sent trace to OTLP endpoint", |
| 179 | + "alert", serviceName, |
| 180 | + ) |
| 181 | + |
| 182 | + return nil |
| 183 | +} |
| 184 | + |
| 185 | +func createSpanContext(ctx context.Context, event eventv1.Event, traceID trace.TraceID) context.Context { |
| 186 | + kind := event.InvolvedObject.Kind |
| 187 | + |
| 188 | + spanContext := trace.NewSpanContext(trace.SpanContextConfig{ |
| 189 | + TraceID: traceID, |
| 190 | + TraceFlags: trace.FlagsSampled, |
| 191 | + Remote: true, |
| 192 | + }) |
| 193 | + // Root spans: Sources that start the deployment flow |
| 194 | + if isSource(kind) { |
| 195 | + return trace.ContextWithSpanContext(context.Background(), |
| 196 | + spanContext.WithTraceFlags(spanContext.TraceFlags())) |
| 197 | + } |
| 198 | + |
| 199 | + // Child spans: Everything else inherits from the same trace |
| 200 | + return trace.ContextWithSpanContext(ctx, |
| 201 | + spanContext.WithTraceFlags(spanContext.TraceFlags())) |
| 202 | +} |
| 203 | + |
| 204 | +func processSpan(tracerProvider *sdktrace.TracerProvider, ctx context.Context, event eventv1.Event) trace.Span { |
| 205 | + // Build span attributes including metadata |
| 206 | + eventAttrs := []attribute.KeyValue{ |
| 207 | + attribute.String("object.uid", string(event.InvolvedObject.UID)), |
| 208 | + attribute.String("object.kind", event.InvolvedObject.Kind), |
| 209 | + attribute.String("object.name", event.InvolvedObject.Name), |
| 210 | + attribute.String("object.namespace", event.InvolvedObject.Namespace), |
| 211 | + } |
| 212 | + |
| 213 | + // Add event metadata as span attributes |
| 214 | + for k, v := range event.Metadata { |
| 215 | + eventAttrs = append(eventAttrs, attribute.String(k, v)) |
| 216 | + } |
| 217 | + |
| 218 | + // Create tracer and start tracing |
| 219 | + spanName := fmt.Sprintf("%s: %s/%s", event.InvolvedObject.Kind, event.InvolvedObject.Namespace, event.InvolvedObject.Name) |
| 220 | + tracer := tracerProvider.Tracer("flux:notification-controller") |
| 221 | + _, span := tracer.Start(ctx, spanName, |
| 222 | + trace.WithAttributes(eventAttrs...), |
| 223 | + trace.WithTimestamp(event.Timestamp.Time)) |
| 224 | + |
| 225 | + return span |
| 226 | +} |
| 227 | + |
| 228 | +// Build the revision ID based on the event metadata |
| 229 | +func getRevision(event_metadata map[string]string) string { |
| 230 | + var revision string = "unknown" |
| 231 | + |
| 232 | + // OCIRepositories does populate the following metadata |
| 233 | + // which it's the same revision as some other sources |
| 234 | + // <app-version>@<oci-digest> -> <version>@<algorithm>:<checksum> |
| 235 | + ociDigest, hasOCI := event_metadata["oci-digest"] |
| 236 | + appVersion, hasApp := event_metadata["app-version"] |
| 237 | + |
| 238 | + if hasOCI && hasApp { |
| 239 | + revision = appVersion + "@" + ociDigest |
| 240 | + } else if rev, hasRev := event_metadata["revision"]; hasRev { |
| 241 | + revision = rev |
| 242 | + } |
| 243 | + |
| 244 | + return revision |
| 245 | +} |
| 246 | + |
| 247 | +// Generate IDs based on: UID + revision |
| 248 | +func generateID(UID string, revision string) []byte { |
| 249 | + input := fmt.Sprintf("%s:%s", UID, revision) |
| 250 | + hash := sha256.Sum256([]byte(input)) |
| 251 | + return hash[:] |
| 252 | +} |
| 253 | + |
| 254 | +// Discriminates if an object kind is a source |
| 255 | +func isSource(kind string) bool { |
| 256 | + sourceKinds := []string{"GitRepository", "HelmChart", "OCIRepository", "Bucket"} |
| 257 | + return slices.Contains(sourceKinds, kind) |
| 258 | +} |
0 commit comments