-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat: add otel support #25862
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
xBlaz3kx
wants to merge
2
commits into
evcc-io:master
Choose a base branch
from
xBlaz3kx:feat/observability
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+217
−8
Draft
feat: add otel support #25862
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,32 @@ | ||
| package otel | ||
|
|
||
| import ( | ||
| "net/http" | ||
|
|
||
| "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp" | ||
| "go.opentelemetry.io/otel/propagation" | ||
| ) | ||
|
|
||
| // HTTPMiddleware returns an HTTP middleware that instruments HTTP requests | ||
| func HTTPMiddleware(next http.Handler) http.Handler { | ||
| return otelhttp.NewHandler(next, "", | ||
| otelhttp.WithSpanNameFormatter(func(operation string, r *http.Request) string { | ||
| return r.Method + " " + r.URL.Path | ||
| }), | ||
| ) | ||
| } | ||
|
|
||
| // HTTPClient returns an HTTP client with OpenTelemetry instrumentation | ||
| func HTTPClient(base http.RoundTripper) http.RoundTripper { | ||
| if base == nil { | ||
| base = http.DefaultTransport | ||
| } | ||
|
|
||
| return otelhttp.NewTransport( | ||
| base, | ||
| otelhttp.WithPropagators(propagation.NewCompositeTextMapPropagator( | ||
| propagation.TraceContext{}, | ||
| propagation.Baggage{}, | ||
| )), | ||
| ) | ||
| } |
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,117 @@ | ||
| package otel | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/evcc-io/evcc/util" | ||
| "go.opentelemetry.io/otel" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp" | ||
| "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.24.0" | ||
| ) | ||
|
|
||
| var ( | ||
| log = util.NewLogger("otel") | ||
| ) | ||
|
|
||
| // Config holds OpenTelemetry configuration | ||
| type Config struct { | ||
| Enabled bool `json:"enabled"` | ||
| Endpoint string `json:"endpoint"` | ||
| Protocol string `json:"protocol"` // "grpc" or "http" | ||
| Insecure bool `json:"insecure"` | ||
| } | ||
|
|
||
| // Init initializes OpenTelemetry tracing | ||
| func Init(ctx context.Context, cfg Config) error { | ||
| if !cfg.Enabled { | ||
| return nil | ||
| } | ||
|
|
||
| if cfg.Endpoint == "" { | ||
| return fmt.Errorf("otel endpoint is required when enabled") | ||
| } | ||
|
|
||
| var exporter sdktrace.SpanExporter | ||
| var err error | ||
|
|
||
| // Default to grpc if protocol not specified | ||
| protocol := cfg.Protocol | ||
| switch protocol { | ||
| case "http": | ||
| opts := []otlptracehttp.Option{ | ||
| otlptracehttp.WithEndpoint(cfg.Endpoint), | ||
| } | ||
| if cfg.Insecure { | ||
| opts = append(opts, otlptracehttp.WithInsecure()) | ||
| } | ||
| exporter, err = otlptracehttp.New(ctx, opts...) | ||
| default: | ||
| protocol = "grpc" | ||
| opts := []otlptracegrpc.Option{ | ||
| otlptracegrpc.WithEndpoint(cfg.Endpoint), | ||
| } | ||
| if cfg.Insecure { | ||
| opts = append(opts, otlptracegrpc.WithInsecure()) | ||
| } | ||
| exporter, err = otlptracegrpc.New(ctx, opts...) | ||
| } | ||
|
|
||
| if err != nil { | ||
| return fmt.Errorf("failed to create otel exporter: %w", err) | ||
| } | ||
|
|
||
| res, err := resource.New(ctx, | ||
| resource.WithAttributes( | ||
| semconv.ServiceName("evcc"), | ||
| semconv.ServiceVersion(util.FormattedVersion()), | ||
| ), | ||
| ) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to create otel resource: %w", err) | ||
| } | ||
|
|
||
| tp := sdktrace.NewTracerProvider( | ||
| sdktrace.WithBatcher(exporter), | ||
| sdktrace.WithResource(res), | ||
| sdktrace.WithSampler(sdktrace.AlwaysSample()), | ||
| ) | ||
|
|
||
| otel.SetTracerProvider(tp) | ||
| otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator( | ||
| propagation.TraceContext{}, | ||
| propagation.Baggage{}, | ||
| )) | ||
|
|
||
| log.INFO.Printf("OpenTelemetry tracing enabled: endpoint=%s, protocol=%s", cfg.Endpoint, protocol) | ||
| return nil | ||
| } | ||
|
|
||
| // Shutdown gracefully shuts down the tracer provider | ||
| func Shutdown(ctx context.Context) error { | ||
| tp := otel.GetTracerProvider() | ||
| if tp == nil { | ||
| return nil | ||
| } | ||
|
|
||
| // Check if it's an SDK tracer provider that supports Shutdown | ||
| sdkTracerProvider, ok := tp.(*sdktrace.TracerProvider) | ||
| if !ok { | ||
| return nil | ||
| } | ||
|
|
||
| ctx, cancel := context.WithTimeout(ctx, 5*time.Second) | ||
| defer cancel() | ||
|
|
||
| if err := sdkTracerProvider.Shutdown(ctx); err != nil { | ||
| return fmt.Errorf("failed to shutdown otel tracer provider: %w", err) | ||
| } | ||
|
|
||
| log.INFO.Println("OpenTelemetry tracing shutdown complete") | ||
| return nil | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.