Skip to content

fix(telemetry): improve setup #15776

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.

Sign up for GitHub

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

Merged
sigma merged 1 commit into from
May 8, 2025
Merged

fix(telemetry): improve setup #15776

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions devnet-sdk/telemetry/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ import (
)

const (
serviceNameEnvVar = "OTEL_SERVICE_NAME"
serviceVersionEnvVar = "OTEL_SERVICE_VERSION"
)
serviceNameEnvVar = "OTEL_SERVICE_NAME"
serviceVersionEnvVar = "OTEL_SERVICE_VERSION"
tracesEndpointEnvVar = "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT"
metricsEndpointEnvVar = "OTEL_EXPORTER_OTLP_METRICS_ENDPOINT"

var (
serviceName = envOrDefault(serviceNameEnvVar, "devstack")
serviceVersion = envOrDefault(serviceVersionEnvVar, "0.0.0")
defaultServiceName = "devstack"
defaultServiceVersion = "0.0.0"
)

func envOrDefault(key, def string) string {
Expand All @@ -25,17 +25,23 @@ func envOrDefault(key, def string) string {
}

func SetupOpenTelemetry(ctx context.Context, opts ...otelconfig.Option) (context.Context, func(), error) {
defaultOpts := []otelconfig.Option{
otelconfig.WithServiceName(envOrDefault(serviceNameEnvVar, defaultServiceName)),
otelconfig.WithServiceVersion(envOrDefault(serviceVersionEnvVar, defaultServiceVersion)),
otelconfig.WithPropagators(defaultPropagators),
}

// do not use localhost:4317 by default, we want telemetry to be opt-in and
// explicit.
if os.Getenv("OTEL_EXPORTER_OTLP_TRACES_ENDPOINT") == "" {
return ctx, func() {}, nil
// The caller is still able to override this by passing in their own opts.
if os.Getenv(tracesEndpointEnvVar) == "" {
defaultOpts = append(defaultOpts, otelconfig.WithTracesEnabled(false))
}
if os.Getenv(metricsEndpointEnvVar) == "" {
defaultOpts = append(defaultOpts, otelconfig.WithMetricsEnabled(false))
}

opts = append([]otelconfig.Option{
otelconfig.WithServiceName(serviceName),
otelconfig.WithServiceVersion(serviceVersion),
otelconfig.WithPropagators(defaultPropagators),
}, opts...)
opts = append(defaultOpts, opts...)
otelShutdown, err := otelconfig.ConfigureOpenTelemetry(opts...)
if err != nil {
return ctx, nil, err
Expand Down