ddtrace/tracer: add support for various environment variables (#696)

This PR adds support for the following environment variables: DD_<INTEGRATION>_ANALYTICS_ENABLED which enables analytics for the named integration, DD_RUNTIME_METRICS_ENABLED which enables runtime metrics for the tracer DD_TRACE_DEBUG which enables debug mode for the tracer.
DataDog · Jul 22, 2020 · 6d7c52c · 6d7c52c
1 parent bf1cbc5
commit 6d7c52c
Show file tree

Hide file tree

Showing 33 changed files with 239 additions and 42 deletions.
diff --git a/contrib/Shopify/sarama/option.go b/contrib/Shopify/sarama/option.go
@@ -8,6 +8,7 @@ package sarama
 import (
 	"math"
 
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 	"gopkg.in/DataDog/dd-trace-go.v1/internal/globalconfig"
 )
 
@@ -24,7 +25,11 @@ func defaults(cfg *config) {
 		cfg.consumerServiceName = svc
 	}
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_SARAMA_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 }
 
 // An Option is used to customize the config for the sarama tracer.

diff --git a/contrib/aws/aws-sdk-go/aws/option.go b/contrib/aws/aws-sdk-go/aws/option.go
@@ -7,6 +7,8 @@ package aws
 
 import (
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 type config struct {
@@ -19,7 +21,11 @@ type Option func(*config)
 
 func defaults(cfg *config) {
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_AWS_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 }
 
 // WithServiceName sets the given service name for the dialled connection.

diff --git a/contrib/bradfitz/gomemcache/memcache/option.go b/contrib/bradfitz/gomemcache/memcache/option.go
@@ -7,6 +7,8 @@ package memcache
 
 import (
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 const (
@@ -25,7 +27,11 @@ type ClientOption func(*clientConfig)
 func defaults(cfg *clientConfig) {
 	cfg.serviceName = serviceName
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_MEMCACHE_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 }
 
 // WithServiceName sets the given service name for the dialled connection.

diff --git a/contrib/confluentinc/confluent-kafka-go/kafka/option.go b/contrib/confluentinc/confluent-kafka-go/kafka/option.go
@@ -9,6 +9,7 @@ import (
 	"context"
 	"math"
 
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 	"gopkg.in/DataDog/dd-trace-go.v1/internal/globalconfig"
 )
 
@@ -30,6 +31,9 @@ func newConfig(opts ...Option) *config {
 		// analyticsRate: globalconfig.AnalyticsRate(),
 		analyticsRate: math.NaN(),
 	}
+	if internal.BoolEnv("DD_TRACE_KAFKA_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	}
 	if svc := globalconfig.ServiceName(); svc != "" {
 		cfg.consumerServiceName = svc
 	}

diff --git a/contrib/database/sql/option.go b/contrib/database/sql/option.go
@@ -7,6 +7,8 @@ package sql
 
 import (
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 type config struct {
@@ -26,7 +28,11 @@ type RegisterOption = Option
 func defaults(cfg *config) {
 	// default cfg.serviceName set in Register based on driver name
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_SQL_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 }
 
 // WithServiceName sets the given service name when registering a driver,

diff --git a/contrib/emicklei/go-restful/option.go b/contrib/emicklei/go-restful/option.go
@@ -8,6 +8,7 @@ package restful
 import (
 	"math"
 
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 	"gopkg.in/DataDog/dd-trace-go.v1/internal/globalconfig"
 )
 
@@ -17,9 +18,13 @@ type config struct {
 }
 
 func newConfig() *config {
+	rate := globalconfig.AnalyticsRate()
+	if internal.BoolEnv("DD_TRACE_RESTFUL_ANALYTICS_ENABLED", false) {
+		rate = 1.0
+	}
 	return &config{
 		serviceName:   "go-restful",
-		analyticsRate: globalconfig.AnalyticsRate(),
+		analyticsRate: rate,
 	}
 }
 

diff --git a/contrib/garyburd/redigo/option.go b/contrib/garyburd/redigo/option.go
@@ -7,6 +7,8 @@ package redigo // import "gopkg.in/DataDog/dd-trace-go.v1/contrib/garyburd/redig
 
 import (
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 type dialConfig struct {
@@ -20,7 +22,11 @@ type DialOption func(*dialConfig)
 func defaults(cfg *dialConfig) {
 	cfg.serviceName = "redis.conn"
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_REDIGO_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 }
 
 // WithServiceName sets the given service name for the dialled connection.

diff --git a/contrib/gin-gonic/gin/option.go b/contrib/gin-gonic/gin/option.go
@@ -10,6 +10,7 @@ import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 	"gopkg.in/DataDog/dd-trace-go.v1/internal/globalconfig"
 )
 
@@ -19,8 +20,12 @@ type config struct {
 }
 
 func newConfig() *config {
+	rate := globalconfig.AnalyticsRate()
+	if internal.BoolEnv("DD_TRACE_GIN_ANALYTICS_ENABLED", false) {
+		rate = 1.0
+	}
 	return &config{
-		analyticsRate: globalconfig.AnalyticsRate(),
+		analyticsRate: rate,
 		resourceNamer: defaultResourceNamer,
 	}
 }

diff --git a/contrib/globalsign/mgo/option.go b/contrib/globalsign/mgo/option.go
@@ -8,6 +8,8 @@ package mgo
 import (
 	"context"
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 type mongoConfig struct {
@@ -17,11 +19,15 @@ type mongoConfig struct {
 }
 
 func newConfig() *mongoConfig {
+	rate := math.NaN()
+	if internal.BoolEnv("DD_TRACE_GIN_ANALYTICS_ENABLED", false) {
+		rate = 1.0
+	}
 	return &mongoConfig{
 		serviceName: "mongodb",
 		ctx:         context.Background(),
 		// analyticsRate: globalconfig.AnalyticsRate(),
-		analyticsRate: math.NaN(),
+		analyticsRate: rate,
 	}
 }
 

diff --git a/contrib/go-chi/chi/option.go b/contrib/go-chi/chi/option.go
@@ -9,6 +9,7 @@ import (
 	"math"
 
 	"gopkg.in/DataDog/dd-trace-go.v1/ddtrace"
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 	"gopkg.in/DataDog/dd-trace-go.v1/internal/globalconfig"
 )
 
@@ -26,7 +27,11 @@ func defaults(cfg *config) {
 	if svc := globalconfig.ServiceName(); svc != "" {
 		cfg.serviceName = svc
 	}
-	cfg.analyticsRate = globalconfig.AnalyticsRate()
+	if internal.BoolEnv("DD_TRACE_CHI_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = globalconfig.AnalyticsRate()
+	}
 }
 
 // WithServiceName sets the given service name for the router.

diff --git a/contrib/go-redis/redis/option.go b/contrib/go-redis/redis/option.go
@@ -7,6 +7,8 @@ package redis // import "gopkg.in/DataDog/dd-trace-go.v1/contrib/go-redis/redis"
 
 import (
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 type clientConfig struct {
@@ -20,7 +22,11 @@ type ClientOption func(*clientConfig)
 func defaults(cfg *clientConfig) {
 	cfg.serviceName = "redis.client"
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_REDIS_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 }
 
 // WithServiceName sets the given service name for the client.

diff --git a/contrib/go.mongodb.org/mongo-driver/mongo/option.go b/contrib/go.mongodb.org/mongo-driver/mongo/option.go
@@ -7,6 +7,8 @@ package mongo
 
 import (
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 type config struct {
@@ -20,7 +22,11 @@ type Option func(*config)
 func defaults(cfg *config) {
 	cfg.serviceName = "mongo"
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_MONGO_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 }
 
 // WithServiceName sets the given service name for the dialled connection.

diff --git a/contrib/gocql/gocql/option.go b/contrib/gocql/gocql/option.go
@@ -7,6 +7,8 @@ package gocql
 
 import (
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 type queryConfig struct {
@@ -21,7 +23,11 @@ type WrapOption func(*queryConfig)
 func defaults(cfg *queryConfig) {
 	cfg.serviceName = "gocql.query"
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_GOCQL_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 }
 
 // WithServiceName sets the given service name for the returned query.

diff --git a/contrib/gomodule/redigo/option.go b/contrib/gomodule/redigo/option.go
@@ -7,6 +7,8 @@ package redigo // import "gopkg.in/DataDog/dd-trace-go.v1/contrib/gomodule/redig
 
 import (
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 type dialConfig struct {
@@ -20,7 +22,11 @@ type DialOption func(*dialConfig)
 func defaults(cfg *dialConfig) {
 	cfg.serviceName = "redis.conn"
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_REDIGO_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 }
 
 // WithServiceName sets the given service name for the dialled connection.

diff --git a/contrib/google.golang.org/api/option.go b/contrib/google.golang.org/api/option.go
@@ -8,6 +8,8 @@ package api
 import (
 	"context"
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 type config struct {
@@ -18,10 +20,14 @@ type config struct {
 }
 
 func newConfig(options ...Option) *config {
+	rate := math.NaN()
+	if internal.BoolEnv("DD_TRACE_GOOGLE_API_ANALYTICS_ENABLED", false) {
+		rate = 1.0
+	}
 	cfg := &config{
 		ctx: context.Background(),
 		// analyticsRate: globalconfig.AnalyticsRate(),
-		analyticsRate: math.NaN(),
+		analyticsRate: rate,
 	}
 	for _, opt := range options {
 		opt(cfg)

diff --git a/contrib/google.golang.org/grpc.v12/option.go b/contrib/google.golang.org/grpc.v12/option.go
@@ -7,6 +7,8 @@ package grpc
 
 import (
 	"math"
+
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 )
 
 type interceptorConfig struct {
@@ -21,7 +23,11 @@ type InterceptorOption func(*interceptorConfig)
 func defaults(cfg *interceptorConfig) {
 	// cfg.serviceName default set in interceptor
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_GRPC_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 }
 
 // WithServiceName sets the given service name for the intercepted client.

diff --git a/contrib/google.golang.org/grpc/option.go b/contrib/google.golang.org/grpc/option.go
@@ -8,6 +8,7 @@ package grpc
 import (
 	"math"
 
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 	"gopkg.in/DataDog/dd-trace-go.v1/internal/globalconfig"
 
 	"google.golang.org/grpc/codes"
@@ -58,7 +59,11 @@ func defaults(cfg *config) {
 	cfg.traceStreamMessages = true
 	cfg.nonErrorCodes = map[codes.Code]bool{codes.Canceled: true}
 	// cfg.analyticsRate = globalconfig.AnalyticsRate()
-	cfg.analyticsRate = math.NaN()
+	if internal.BoolEnv("DD_TRACE_GRPC_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = math.NaN()
+	}
 	cfg.ignoredMetadata = map[string]struct{}{
 		"x-datadog-trace-id":          {},
 		"x-datadog-parent-id":         {},

diff --git a/contrib/gorilla/mux/option.go b/contrib/gorilla/mux/option.go
@@ -11,6 +11,7 @@ import (
 
 	"gopkg.in/DataDog/dd-trace-go.v1/ddtrace"
 	"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
+	"gopkg.in/DataDog/dd-trace-go.v1/internal"
 	"gopkg.in/DataDog/dd-trace-go.v1/internal/globalconfig"
 )
 
@@ -26,7 +27,11 @@ type routerConfig struct {
 type RouterOption func(*routerConfig)
 
 func defaults(cfg *routerConfig) {
-	cfg.analyticsRate = globalconfig.AnalyticsRate()
+	if internal.BoolEnv("DD_TRACE_MUX_ANALYTICS_ENABLED", false) {
+		cfg.analyticsRate = 1.0
+	} else {
+		cfg.analyticsRate = globalconfig.AnalyticsRate()
+	}
 	cfg.serviceName = "mux.router"
 	if svc := globalconfig.ServiceName(); svc != "" {
 		cfg.serviceName = svc