forked from knative/pkg
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tracing.go
134 lines (113 loc) · 3.63 KB
/
tracing.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
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
Copyright 2019 The Knative Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package config
import (
"errors"
"fmt"
"reflect"
"strconv"
"cloud.google.com/go/compute/metadata"
corev1 "k8s.io/api/core/v1"
)
const (
// ConfigName is the name of the configmap
ConfigName = "config-tracing"
enableKey = "enable"
backendKey = "backend"
zipkinEndpointKey = "zipkin-endpoint"
debugKey = "debug"
sampleRateKey = "sample-rate"
stackdriverProjectIDKey = "stackdriver-project-id"
)
// BackendType specifies the backend to use for tracing
type BackendType string
const (
// None is used for no backend.
None BackendType = "none"
// Stackdriver is used for Stackdriver backend.
Stackdriver BackendType = "stackdriver"
// Zipkin is used for Zipkin backend.
Zipkin BackendType = "zipkin"
)
// Config holds the configuration for tracers
type Config struct {
Backend BackendType
ZipkinEndpoint string
StackdriverProjectID string
Debug bool
SampleRate float64
}
// Equals returns true if two Configs are identical
func (cfg *Config) Equals(other *Config) bool {
return reflect.DeepEqual(other, cfg)
}
// NewTracingConfigFromMap returns a Config given a map corresponding to a ConfigMap
func NewTracingConfigFromMap(cfgMap map[string]string) (*Config, error) {
tc := Config{
Backend: None,
Debug: false,
SampleRate: 0.1,
}
if backend, ok := cfgMap[backendKey]; ok {
switch bt := BackendType(backend); bt {
case Stackdriver, Zipkin, None:
tc.Backend = bt
default:
return nil, fmt.Errorf("unsupported tracing backend value %q", backend)
}
} else {
// For backwards compatibility, parse the enabled flag as Zipkin.
if enable, ok := cfgMap[enableKey]; ok {
enableBool, err := strconv.ParseBool(enable)
if err != nil {
return nil, fmt.Errorf("failed parsing tracing config %q: %v", enableKey, err)
}
if enableBool {
tc.Backend = Zipkin
}
}
}
if endpoint, ok := cfgMap[zipkinEndpointKey]; !ok && tc.Backend == Zipkin {
return nil, errors.New("zipkin tracing enabled without a zipkin endpoint specified")
} else {
tc.ZipkinEndpoint = endpoint
}
if projectID, ok := cfgMap[stackdriverProjectIDKey]; ok {
tc.StackdriverProjectID = projectID
} else if tc.Backend == Stackdriver {
projectID, err := metadata.ProjectID()
if err != nil {
return nil, fmt.Errorf("stackdriver tracing enabled without a project-id specified: %v", err)
}
tc.StackdriverProjectID = projectID
}
if debug, ok := cfgMap[debugKey]; ok {
debugBool, err := strconv.ParseBool(debug)
if err != nil {
return nil, fmt.Errorf("failed parsing tracing config %q", debugKey)
}
tc.Debug = debugBool
}
if sampleRate, ok := cfgMap[sampleRateKey]; ok {
sampleRateFloat, err := strconv.ParseFloat(sampleRate, 64)
if err != nil {
return nil, fmt.Errorf("failed to parse sampleRate in tracing config: %v", err)
}
tc.SampleRate = sampleRateFloat
}
return &tc, nil
}
// NewTracingConfigFromConfigMap returns a Config for the given configmap
func NewTracingConfigFromConfigMap(config *corev1.ConfigMap) (*Config, error) {
return NewTracingConfigFromMap(config.Data)
}