-
Notifications
You must be signed in to change notification settings - Fork 0
/
telemetry.go
305 lines (247 loc) · 9.12 KB
/
telemetry.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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
package observability
import (
"context"
"crypto/tls"
"crypto/x509"
"flag"
"fmt"
"os"
"runtime"
"time"
"github.com/grafana/pyroscope-go"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
"go.opentelemetry.io/otel/sdk/metric"
"go.opentelemetry.io/otel/sdk/resource"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
"github.com/bloominlabs/baseplate-go/config/env"
"github.com/bloominlabs/baseplate-go/config/filesystem"
)
type PyroscopeLogger struct {
logger zerolog.Logger
}
func (l *PyroscopeLogger) Infof(a string, b ...interface{}) {}
func (l *PyroscopeLogger) Debugf(a string, b ...interface{}) {}
func (l *PyroscopeLogger) Errorf(a string, b ...interface{}) {
l.logger.Error().Msg(fmt.Sprintf(a, b...))
}
type PyroscopeConfig struct {
URL string `toml:"url"`
Token string `toml:"token"`
User string `toml:"user"`
profiler *pyroscope.Profiler
}
func (c *PyroscopeConfig) Start(ctx context.Context, serviceName string) error {
runtime.SetMutexProfileFraction(5)
runtime.SetBlockProfileRate(5)
if c.URL != "" {
p, err := pyroscope.Start(pyroscope.Config{
ApplicationName: serviceName,
// replace this with the address of pyroscope server
ServerAddress: c.URL,
BasicAuthUser: c.User,
BasicAuthPassword: c.Token,
// you can disable logging by setting this to nil
Logger: &PyroscopeLogger{logger: log.Logger},
UploadRate: time.Second * 60,
})
if err != nil {
return err
}
c.profiler = p
}
return nil
}
func (c *PyroscopeConfig) Stop() error {
if c.profiler != nil {
err := c.profiler.Stop()
if err != nil {
return err
}
c.profiler = nil
}
return nil
}
type TelemetryConfig struct {
OTLPAddr string `toml:"addr"`
OTLPCAPath string `toml:"ca_path"`
OTLPCertPath string `toml:"cert_path"`
OTLPKeyPath string `toml:"key_path"`
Insecure bool `toml:"insecure"`
ServiceName string `toml:"service_name"`
MetricsCollectionInterval time.Duration `toml:"metrics_collection_interval"`
Pyroscope PyroscopeConfig `toml:"pyroscope"`
metricsCleanup *func()
tracingCleanup *func()
profilerCleanup *func()
watcher *filesystem.CertificateWatcher
}
func (t *TelemetryConfig) RegisterFlags(f *flag.FlagSet) {
f.StringVar(&t.OTLPAddr, "otlp.addr", env.GetEnvStrDefault("OTLP_ADDR", "localhost:4317"), "hostname:port for OTLP.grpc protocol on remote OTLP receiver")
f.StringVar(&t.OTLPCAPath, "otlp.ca.path", env.GetEnvStrDefault("OTLP_CA_PATH", ""), "Path to certificate authority used to verify outgoing OTLP receiver connections")
f.StringVar(&t.OTLPCertPath, "otlp.cert.path", env.GetEnvStrDefault("OTLP_CERT_PATH", ""), "Path to certificate to encrypt outgoing OTLP receiver connections")
f.StringVar(&t.OTLPKeyPath, "otlp.key.path", env.GetEnvStrDefault("OTLP_KEY_PATH", ""), "Path to private key to encrypt outgoing OTLP receiver connections")
f.StringVar(&t.Pyroscope.URL, "pyroscope.url", env.GetEnvStrDefault("PYROSCOPE_URL", ""), "URL for uploading pyroscope traces")
f.StringVar(&t.Pyroscope.Token, "pyroscope.token", env.GetEnvStrDefault("PYROSCOPE_TOKEN", ""), "Token used for authenticated to pyroscope")
f.StringVar(&t.Pyroscope.User, "pyroscope.user", env.GetEnvStrDefault("PYROSCOPE_USER", ""), "User used for authenticated to pyroscope")
f.StringVar(&t.ServiceName, "service-name", env.GetEnvStrDefault("SERVICE_NAME", ""), "Service name to use for telemetry")
f.DurationVar(&t.MetricsCollectionInterval, "otlp.metrics_collection_interval", env.GetEnvDurDefault("METRICS_COLLECTION_INTERVAL", time.Minute), "User used for authenticated to pyroscope")
f.BoolVar(&t.Insecure, "otlp.insecure", false, "Emit OTLP without needing mTLS certificate")
}
func (t *TelemetryConfig) Merge(o *TelemetryConfig) error {
if o.Pyroscope.URL != "" {
t.Pyroscope.URL = o.Pyroscope.URL
}
if o.Pyroscope.Token != "" {
t.Pyroscope.Token = o.Pyroscope.Token
}
if o.Pyroscope.User != "" {
t.Pyroscope.User = o.Pyroscope.User
}
err := t.Pyroscope.Stop()
if err != nil {
fmt.Errorf("failed to stop pyroscope: %w", err)
}
err = t.Pyroscope.Start(context.Background(), t.ServiceName)
if err != nil {
return fmt.Errorf("failed to start pyroscope: %w", err)
}
return nil
}
func (t *TelemetryConfig) Validate() error {
return nil
}
type TelemetryOptions struct {
resource *resource.Resource
metricOptions []metric.Option
tracingOptions []sdktrace.TracerProviderOption
}
type Option func(*TelemetryOptions) error
func Resource(resource resource.Resource) Option {
return func(o *TelemetryOptions) error {
o.resource = &resource
return nil
}
}
func MetricOptions(metricOptions ...metric.Option) Option {
return func(o *TelemetryOptions) error {
o.metricOptions = metricOptions
return nil
}
}
func TracingOptions(tracingOptions ...sdktrace.TracerProviderOption) Option {
return func(o *TelemetryOptions) error {
o.tracingOptions = tracingOptions
return nil
}
}
func (t *TelemetryOptions) parseOptions(opts ...Option) error {
// Range over each options function and apply it to our API type to
// configure it. Options functions are applied in order, with any
// conflicting options overriding earlier calls.
for _, option := range opts {
err := option(t)
if err != nil {
return err
}
}
return nil
}
// Initialize Metrics + Tracing for the app. NOTE: you must call defer t.Stop() to propely cleanup
func (t *TelemetryConfig) InitializeTelemetry(ctx context.Context, serviceName string, logger zerolog.Logger, options ...Option) error {
if t.ServiceName == "" {
t.ServiceName = serviceName
}
var creds *credentials.TransportCredentials
if t.OTLPCAPath != "" || t.OTLPCertPath != "" || t.OTLPKeyPath != "" {
logger.Debug().Str("caPath", t.OTLPCAPath).Str("certPath", t.OTLPCertPath).Str("keyPath", t.OTLPKeyPath).Msg("detected mTLS credentials")
w, err := filesystem.NewCertificateWatcher(t.OTLPCertPath, t.OTLPKeyPath, logger, time.Second*5)
if err != nil {
return fmt.Errorf("failed to create OTLP certificate watcher: %w", err)
}
t.watcher = w
_, err = t.watcher.Start(ctx)
if err != nil {
return fmt.Errorf("failed to start certificate watcher: %w", err)
}
ca, err := os.ReadFile(t.OTLPCAPath)
if err != nil {
return fmt.Errorf("can't read ca file from %s", t.OTLPCAPath)
}
capool := x509.NewCertPool()
if !capool.AppendCertsFromPEM(ca) {
return fmt.Errorf("can't add CA cert to pool")
}
tlsConfig := &tls.Config{
RootCAs: capool,
GetCertificate: w.GetCertificateFunc(),
}
conf := credentials.NewTLS(tlsConfig)
creds = &conf
} else if t.Insecure {
conf := insecure.NewCredentials()
creds = &conf
}
telemetryOptions := TelemetryOptions{}
telemetryOptions.parseOptions(options...)
if telemetryOptions.resource == nil {
resource, err := WithDefaultResource(ctx, serviceName)
if err != nil {
return fmt.Errorf("failed to create resource: %w", err)
}
telemetryOptions.resource = resource
}
logger.Info().Str("OTLPAddr", t.OTLPAddr).Msg("initializing observability")
logger.Info().Str("OTLPAddr", t.OTLPAddr).Str("type", "metrics").Msg("initializing provider")
metricOpts := WithDefaultMetricOpts(serviceName)
metricOpts = append(metricOpts, metric.WithResource(telemetryOptions.resource))
if len(telemetryOptions.metricOptions) > 0 {
metricOpts = append(metricOpts, telemetryOptions.metricOptions...)
}
metricsCleanup, err := InitMetricsProvider(logger, t.OTLPAddr, creds, t.MetricsCollectionInterval, metricOpts...)
if err != nil {
return fmt.Errorf("failed to initialize metric provider %w", err)
}
t.metricsCleanup = &metricsCleanup
log.Debug().Str("OTLPAddr", t.OTLPAddr).Str("type", "metrics").Msg("initialized provider")
traceOpts := WithDefaultTracingOpts(serviceName)
traceOpts = append(traceOpts, sdktrace.WithResource(telemetryOptions.resource))
if len(telemetryOptions.tracingOptions) > 0 {
traceOpts = append(traceOpts, telemetryOptions.tracingOptions...)
}
log.Info().Str("OTLPAddr", t.OTLPAddr).Str("type", "tracing").Msg("initializing provider")
tracingCleanup, err := InitTraceProvider(logger, serviceName, t.OTLPAddr, creds, t.Pyroscope, traceOpts...)
if err != nil {
log.Fatal().Err(err).Str("OTLPAddr", t.OTLPAddr).Str("type", "tracing").Msg("failed to intialize provider")
}
t.tracingCleanup = &tracingCleanup
log.Debug().Str("OTLPAddr", t.OTLPAddr).Str("type", "tracing").Msg("initialized provider")
log.Info().Str("url", t.Pyroscope.URL).Str("type", "profiling").Msg("initializing provider")
err = t.Pyroscope.Start(ctx, t.ServiceName)
if err != nil {
log.Fatal().Err(err).Str("url", t.Pyroscope.URL).Str("type", "profiling").Msg("failed to intialize provider")
}
log.Info().Str("url", t.Pyroscope.URL).Str("type", "profiling").Msg("done initializing provider")
profilerCleanup := func() {
t.Pyroscope.Stop()
}
t.profilerCleanup = &profilerCleanup
return nil
}
func (t *TelemetryConfig) Shutdown(ctx context.Context, logger zerolog.Logger) error {
if t.metricsCleanup != nil {
(*t.metricsCleanup)()
}
if t.tracingCleanup != nil {
(*t.tracingCleanup)()
}
if t.profilerCleanup != nil {
(*t.profilerCleanup)()
}
if t.watcher != nil {
return t.watcher.Stop()
}
return nil
}