-
Notifications
You must be signed in to change notification settings - Fork 436
/
option.go
121 lines (105 loc) · 3.43 KB
/
option.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2016 Datadog, Inc.
package gin
import (
"math"
"net/http"
"github.com/DataDog/dd-trace-go/v2/internal"
"github.com/DataDog/dd-trace-go/v2/internal/globalconfig"
"github.com/DataDog/dd-trace-go/v2/internal/namingschema"
"github.com/DataDog/dd-trace-go/v2/internal/normalizer"
"github.com/gin-gonic/gin"
)
const defaultServiceName = "gin.router"
type config struct {
analyticsRate float64
resourceNamer func(c *gin.Context) string
serviceName string
ignoreRequest func(c *gin.Context) bool
headerTags *internal.LockMap
}
func newConfig(serviceName string) *config {
if serviceName == "" {
serviceName = namingschema.ServiceName(defaultServiceName)
}
rate := globalconfig.AnalyticsRate()
if internal.BoolEnv("DD_TRACE_GIN_ANALYTICS_ENABLED", false) {
rate = 1.0
}
return &config{
analyticsRate: rate,
resourceNamer: defaultResourceNamer,
serviceName: serviceName,
ignoreRequest: func(_ *gin.Context) bool { return false },
headerTags: globalconfig.HeaderTagMap(),
}
}
// Option describes options for the Gin integration.
type Option interface {
apply(*config)
}
// OptionFn represents options applicable to Middleware.
type OptionFn func(*config)
func (fn OptionFn) apply(cfg *config) {
fn(cfg)
}
// WithAnalytics enables Trace Analytics for all started spans.
func WithAnalytics(on bool) OptionFn {
return func(cfg *config) {
if on {
cfg.analyticsRate = 1.0
} else {
cfg.analyticsRate = math.NaN()
}
}
}
// WithAnalyticsRate sets the sampling rate for Trace Analytics events
// correlated to started spans.
func WithAnalyticsRate(rate float64) OptionFn {
return func(cfg *config) {
if rate >= 0.0 && rate <= 1.0 {
cfg.analyticsRate = rate
} else {
cfg.analyticsRate = math.NaN()
}
}
}
// WithResourceNamer specifies a function which will be used to obtain a resource name for a given
// gin request, using the request's context.
func WithResourceNamer(namer func(c *gin.Context) string) OptionFn {
return func(cfg *config) {
cfg.resourceNamer = namer
}
}
// WithHeaderTags enables the integration to attach HTTP request headers as span tags.
// Warning:
// Using this feature can risk exposing sensitive data such as authorization tokens to Datadog.
// Special headers can not be sub-selected. E.g., an entire Cookie header would be transmitted, without the ability to choose specific Cookies.
func WithHeaderTags(headers []string) OptionFn {
headerTagsMap := normalizer.HeaderTagSlice(headers)
return func(cfg *config) {
cfg.headerTags = internal.NewLockMap(headerTagsMap)
}
}
// WithIgnoreRequest specifies a function to use for determining if the
// incoming HTTP request tracing should be skipped.
func WithIgnoreRequest(f func(c *gin.Context) bool) OptionFn {
return func(cfg *config) {
cfg.ignoreRequest = f
}
}
func defaultResourceNamer(c *gin.Context) string {
// getName is a hacky way to check whether *gin.Context implements the FullPath()
// method introduced in v1.4.0, falling back to the previous implementation otherwise.
getName := func(req *http.Request, c interface{ HandlerName() string }) string {
if fp, ok := c.(interface {
FullPath() string
}); ok {
return req.Method + " " + fp.FullPath()
}
return c.HandlerName()
}
return getName(c.Request, c)
}