Skip to content
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

feat: tracing propagation and service name prioritize envvar #427

Merged
merged 4 commits into from
Sep 19, 2023
Merged

feat: tracing propagation and service name prioritize envvar #427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
17379b1
feat: tracing propagation and service name prioritize envvar
vasconcelosvcd Sep 18, 2023
51f95ee
feat: expose and overwrite otel envvar
vasconcelosvcd Sep 18, 2023
b31a5e5
feat: add new configurations standard
vasconcelosvcd Sep 18, 2023
a41df88
feat: remove outdated comments.
vasconcelosvcd Sep 18, 2023
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
8 changes: 4 additions & 4 deletions configs/service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ grpc_keepalive_max_connection_age: "12h"
grpc_keepalive_max_connection_age_grace: "5m"
grpc_keepalive_time: "1h"
grpc_keepalive_timeout: "20s"
# The following enables OpenCensus Tracing via Cloud Trace
# for the Datastore client library.
# It is EXPERIMENTAL and subject to change or removal without notice.
enable_trace: false

enable_trace: false
enable_grpc_collector: false
trace_service_name: "open-saves"
trace_sample_rate: 0.00
2 changes: 1 addition & 1 deletion internal/app/server/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func Run(ctx context.Context, network string, cfg *config.ServiceConfig) error {
grpc.UnaryInterceptor(otelgrpc.UnaryServerInterceptor()),
grpc.StreamInterceptor(otelgrpc.StreamServerInterceptor()))

tracer, err = tracing.InitTracer(cfg.ServerConfig.TraceSampleRate, cfg.ServerConfig.EnableGRPCCollector, cfg.ServerConfig.EnableHTTPCollector, cfg.Project)
tracer, err = tracing.InitTracer(cfg.ServerConfig.TraceSampleRate, cfg.ServerConfig.EnableGRPCCollector, cfg.ServerConfig.EnableHTTPCollector, cfg.TraceServiceName)
if err != nil {
return err
}
Expand Down
5 changes: 5 additions & 0 deletions internal/pkg/config/loader.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ func Load(path string) (*ServiceConfig, error) {
log.Warningf("cannot bind env var %s to %s", "OPEN_SAVES_CACHE", RedisAddress)
}

if err := viper.BindEnv(TraceServiceName, "OTEL_SERVICE_NAME"); err != nil {
log.Warningf("cannot bind env var %s to %s", "OTEL_SERVICE_NAME", TraceServiceName)
}

// Reads command line arguments, for backward compatibility
pflag.Uint("port", 6000, "The port number to run Open Saves on")
pflag.String("cloud", "gcp", "The public cloud provider you wish to run Open Saves on")
Expand Down Expand Up @@ -99,6 +103,7 @@ func Load(path string) (*ServiceConfig, error) {
ShutdownGracePeriod: viper.GetDuration(ShutdownGracePeriod),
EnableTrace: viper.GetBool(EnableTrace),
TraceSampleRate: viper.GetFloat64(TraceSampleRate),
TraceServiceName: viper.GetString(TraceServiceName),
EnableGRPCCollector: viper.GetBool(TraceEnableGRPCCollector),
EnableHTTPCollector: viper.GetBool(TraceEnableHTTPCollector),
}
Expand Down
5 changes: 2 additions & 3 deletions internal/pkg/config/model.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,9 @@ const (
GRPCKeepAliveTime = "grpc_keepalive_time"
GRPCKeepAliveTimeout = "grpc_keepalive_timeout"

// The following enables OpenCensus Tracing via Cloud Trace
// for the Datastore client library.
// It is EXPERIMENTAL and subject to change or removal without notice.
EnableTrace = "enable_trace"
TraceSampleRate = "trace_sample_rate"
TraceServiceName = "trace_service_name"
TraceEnableGRPCCollector = "trace_enable_grpc_collector"
TraceEnableHTTPCollector = "trace_enable_http_collector"
)
Expand All @@ -72,6 +70,7 @@ type ServerConfig struct {
// See https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/otlp/otlptrace for how to configure the exporters with env variables
EnableTrace bool
TraceSampleRate float64
TraceServiceName string
EnableGRPCCollector bool
EnableHTTPCollector bool
}
Expand Down
6 changes: 4 additions & 2 deletions internal/pkg/tracing/tracing.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import (
"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"
sdkresource "go.opentelemetry.io/otel/sdk/resource"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
semconv "go.opentelemetry.io/otel/semconv/v1.18.0"
)

var ServiceName = "open-saves"
Expand All @@ -23,7 +23,7 @@ func InitTracer(rate float64, enableGRPCCollector bool, enableHTTPCollector bool
sdkresource.WithProcess(),
sdkresource.WithContainer(),
sdkresource.WithHost(),
sdkresource.WithAttributes(semconv.ServiceName(ServiceName)),
sdkresource.WithAttributes(),
)
resource, _ := sdkresource.Merge(
sdkresource.Default(),
Expand All @@ -50,6 +50,8 @@ func InitTracer(rate float64, enableGRPCCollector bool, enableHTTPCollector bool
}

tp := sdktrace.NewTracerProvider(options...)
// enable tracing propagation
otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{}))
otel.SetTracerProvider(tp)

return tp, nil
Expand Down