Add opentelemetry tracing instrumentation #1125
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| /* | ||
| Copyright 2025 The Kubernetes Authors. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| // Package tracing provides OpenTelemetry tracing infrastructure for the gateway-api-inference-extension | ||
| package tracing | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "strconv" | ||
| "time" | ||
|
|
||
| "go.opentelemetry.io/otel" | ||
| "go.opentelemetry.io/otel/codes" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc" | ||
| "go.opentelemetry.io/otel/propagation" | ||
| "go.opentelemetry.io/otel/sdk/resource" | ||
| sdktrace "go.opentelemetry.io/otel/sdk/trace" | ||
| semconv "go.opentelemetry.io/otel/semconv/v1.4.0" | ||
| "go.opentelemetry.io/otel/trace" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
| ) | ||
|
|
||
| const ( | ||
| ServiceName = "gateway-api-inference-extension" | ||
|
|
||
| envOTELTracingEnabled = "OTEL_TRACING_ENABLED" | ||
| envOTELExporterEndpoint = "OTEL_EXPORTER_OTLP_ENDPOINT" | ||
| envOTELServiceName = "OTEL_SERVICE_NAME" | ||
| envOTELSamplingRate = "OTEL_SAMPLING_RATE" | ||
|
|
||
| OperationGatewayRequest = "gateway.ext_proc.request" | ||
| OperationRequestOrchestration = "gateway.request_orchestration" | ||
| OperationScheduling = "gateway.scheduling" | ||
|
|
||
| AttrGenAIRequestModel = "gen_ai.request.model" | ||
| AttrOperationOutcome = "operation.outcome" | ||
|
|
||
| OutcomeSuccess = "success" | ||
| OutcomeError = "error" | ||
| ) | ||
|
|
||
| type Config struct { | ||
| Enabled bool | ||
| ExporterEndpoint string | ||
| SamplingRate float64 | ||
| ServiceName string | ||
| } | ||
|
|
||
| func NewConfigFromEnv() *Config { | ||
| config := &Config{ | ||
| Enabled: false, | ||
| ExporterEndpoint: "http://localhost:4317", | ||
| SamplingRate: 0.1, | ||
| ServiceName: ServiceName, | ||
| } | ||
|
|
||
| if enabled := os.Getenv(envOTELTracingEnabled); enabled != "" { | ||
| if enabledBool, err := strconv.ParseBool(enabled); err == nil { | ||
| config.Enabled = enabledBool | ||
| } | ||
| } | ||
|
|
||
| if endpoint := os.Getenv(envOTELExporterEndpoint); endpoint != "" { | ||
| config.ExporterEndpoint = endpoint | ||
| } | ||
|
|
||
| if serviceName := os.Getenv(envOTELServiceName); serviceName != "" { | ||
| config.ServiceName = serviceName | ||
| } | ||
|
|
||
| if samplingRate := os.Getenv(envOTELSamplingRate); samplingRate != "" { | ||
| if rate, err := strconv.ParseFloat(samplingRate, 64); err == nil { | ||
|
There was a problem hiding this comment. Does it make sense to inform the user e.g. by failing during the creation whenever a value is not recognized? |
||
| config.SamplingRate = rate | ||
| } | ||
| } | ||
|
|
||
| return config | ||
| } | ||
|
|
||
| // Initialize sets up OpenTelemetry tracing with the given configuration. | ||
| // It always sets up context propagation, even if tracing is disabled. | ||
| func Initialize(ctx context.Context, config *Config) (func(), error) { | ||
| otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator( | ||
| propagation.TraceContext{}, | ||
| propagation.Baggage{}, | ||
| )) | ||
|
|
||
| if !config.Enabled { | ||
| // Return a no-op shutdown function if tracing is disabled | ||
| return func() {}, nil | ||
| } | ||
|
|
||
| conn, err := grpc.DialContext(ctx, config.ExporterEndpoint, | ||
| grpc.WithTransportCredentials(insecure.NewCredentials()), | ||
| grpc.WithBlock(), | ||
| grpc.WithTimeout(5*time.Second), | ||
|
|
||
| ) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create gRPC connection to collector: %w", err) | ||
| } | ||
|
|
||
| exporter, err := otlptracegrpc.New(ctx, otlptracegrpc.WithGRPCConn(conn)) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create OTLP trace exporter: %w", err) | ||
| } | ||
|
|
||
| res, err := resource.New(ctx, | ||
| resource.WithAttributes( | ||
| semconv.ServiceNameKey.String(config.ServiceName), | ||
| semconv.ServiceVersionKey.String("1.0.0"), | ||
|
There was a problem hiding this comment. Does it make sense to use debug/buildinfo here? |
||
| ), | ||
| ) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create resource: %w", err) | ||
| } | ||
|
|
||
| tp := sdktrace.NewTracerProvider( | ||
| sdktrace.WithBatcher(exporter), | ||
| sdktrace.WithResource(res), | ||
| sdktrace.WithSampler(sdktrace.TraceIDRatioBased(config.SamplingRate)), | ||
| ) | ||
|
|
||
| otel.SetTracerProvider(tp) | ||
|
|
||
| return func() { | ||
| tp.Shutdown(context.Background()) | ||
| }, nil | ||
| } | ||
|
|
||
| func StartSpan(ctx context.Context, name, operation string) (context.Context, trace.Span) { | ||
| tracer := otel.Tracer(ServiceName) | ||
| return tracer.Start(ctx, name) | ||
| } | ||
|
|
||
| func StartGatewaySpan(ctx context.Context, operation string) (context.Context, trace.Span) { | ||
| ctx, span := StartSpan(ctx, operation, operation) | ||
| // TODO: Add common gateway attributes here | ||
| return ctx, span | ||
| } | ||
|
Comment on lines
+150
to
+155
There was a problem hiding this comment. Maybe we want to replace them with something like: func SetGatewayAttributes(span trace.Span, gateway Gateway) {
if gateway == nil {
return
}
span.SetAttributes(
AttrGatewaySomething.String(gateway.Something()),
)
}Allowing a user to set attributes without the need to know the specific Keys? |
||
|
|
||
| func SetSpanError(span trace.Span, err error) { | ||
| span.RecordError(err) | ||
| span.SetStatus(codes.Error, err.Error()) | ||
| } | ||
|
|
||
| func SetSpanSuccess(span trace.Span) { | ||
| span.SetStatus(codes.Ok, "") | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Can we just check the existence of
OTEL_EXPORTER_OTLP_ENDPOINTfor enablement? If the endpoint is specified then it's likely the user wants to enable the feature.