-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
instrumentation.go
247 lines (212 loc) · 6.85 KB
/
instrumentation.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
// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you 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 instrumentation
import (
"fmt"
"net"
"net/http"
"net/url"
"os"
"time"
"go.elastic.co/apm/v2"
apmtransport "go.elastic.co/apm/v2/transport"
"github.com/elastic/elastic-agent-libs/config"
"github.com/elastic/elastic-agent-libs/logp"
"github.com/elastic/elastic-agent-libs/transport"
)
// Instrumentation is an interface that can return an APM tracer a net.listener
type Instrumentation interface {
Tracer() *apm.Tracer
Listener() net.Listener
}
type instrumentation struct {
tracer *apm.Tracer
listener net.Listener
}
// Tracer returns the configured tracer
// If there is no configured tracer, it returns the DefaultTracer, which is always closed.
func (t *instrumentation) Tracer() *apm.Tracer {
if t.tracer != nil {
return t.tracer
}
tracer := apm.DefaultTracer()
tracer.Close()
return tracer
}
// Listener is only relevant for APM Server sending tracing data to itself
// APM Server needs this listener to create an ad-hoc tracing server
func (t *instrumentation) Listener() net.Listener {
return t.listener
}
// Config holds config information about self instrumenting the APM Server
type Config struct {
Enabled *bool `config:"enabled"`
Environment *string `config:"environment"`
Hosts urls `config:"hosts"`
Profiling ProfilingConfig `config:"profiling"`
APIKey string `config:"api_key"`
SecretToken string `config:"secret_token"`
}
type urls []*url.URL
func (u *urls) Unpack(c interface{}) error {
if c == nil {
return nil
}
hosts, ok := c.([]interface{})
if !ok {
return fmt.Errorf("hosts must be a list, got: %#v", c)
}
nu := make(urls, len(hosts))
for i, host := range hosts {
h, ok := host.(string)
if !ok {
return fmt.Errorf("host must be a string, got: %#v", host)
}
url, err := url.Parse(h)
if err != nil {
return err
}
nu[i] = url
}
*u = nu
return nil
}
// ProfilingConfig holds config information about self profiling the APM Server
type ProfilingConfig struct {
CPU *CPUProfiling `config:"cpu"`
Heap *HeapProfiling `config:"heap"`
}
// CPUProfiling holds config information about CPU profiling of the APM Server
type CPUProfiling struct {
Enabled bool `config:"enabled"`
Interval time.Duration `config:"interval" validate:"positive"`
Duration time.Duration `config:"duration" validate:"positive"`
}
// IsEnabled indicates whether instrumentation is enabled
func (c *Config) IsEnabled() bool {
return c != nil && c.Enabled != nil && *c.Enabled
}
// IsEnabled indicates whether CPU profiling is enabled
func (p *CPUProfiling) IsEnabled() bool {
return p != nil && p.Enabled
}
// IsEnabled indicates whether heap profiling is enabled
func (p *HeapProfiling) IsEnabled() bool {
return p != nil && p.Enabled
}
// HeapProfiling holds config information about heap profiling of the APM Server
type HeapProfiling struct {
Enabled bool `config:"enabled"`
Interval time.Duration `config:"interval" validate:"positive"`
}
// New configures and returns an instrumentation object for tracing
func New(cfg *config.C, beatName, beatVersion string) (Instrumentation, error) {
if !cfg.HasField("instrumentation") {
return &instrumentation{}, nil
}
instrConfig, err := cfg.Child("instrumentation", -1)
if err != nil {
return &instrumentation{}, nil
}
c := Config{}
if instrConfig == nil {
instrConfig = config.NewConfig()
}
err = instrConfig.Unpack(&c)
if err != nil {
return nil, fmt.Errorf("could not create tracer, err: %v", err)
}
return initTracer(c, beatName, beatVersion)
}
func initTracer(cfg Config, beatName, beatVersion string) (*instrumentation, error) {
logger := logp.NewLogger("tracing")
if !cfg.IsEnabled() {
os.Setenv("ELASTIC_APM_ACTIVE", "false")
logger.Infof("APM instrumentation is disabled")
return &instrumentation{}, nil
} else {
os.Setenv("ELASTIC_APM_ACTIVE", "true")
logger.Infof("APM instrumentation is enabled")
}
if cfg.Profiling.CPU.IsEnabled() {
interval := cfg.Profiling.CPU.Interval
duration := cfg.Profiling.CPU.Duration
logger.Infof("CPU profiling: every %s for %s", interval, duration)
os.Setenv("ELASTIC_APM_CPU_PROFILE_INTERVAL", fmt.Sprintf("%dms", int(interval.Seconds()*1000)))
os.Setenv("ELASTIC_APM_CPU_PROFILE_DURATION", fmt.Sprintf("%dms", int(duration.Seconds()*1000)))
}
if cfg.Profiling.Heap.IsEnabled() {
interval := cfg.Profiling.Heap.Interval
logger.Infof("Heap profiling: every %s", interval)
os.Setenv("ELASTIC_APM_HEAP_PROFILE_INTERVAL", fmt.Sprintf("%dms", int(interval.Seconds()*1000)))
}
var tracerTransport apmtransport.Transport
var tracerListener net.Listener
if cfg.Hosts == nil {
pipeListener := transport.NewPipeListener()
pipeTransport, err := apmtransport.NewHTTPTransport(apmtransport.HTTPTransportOptions{
ServerURLs: []*url.URL{{Scheme: "http", Host: "localhost:8200"}},
})
if err != nil {
return nil, err
}
pipeTransport.Client.Transport = &http.Transport{
DialContext: pipeListener.DialContext,
MaxIdleConns: 100,
IdleConnTimeout: 90 * time.Second,
}
tracerTransport = pipeTransport
// the traceListener will allow APM Server to create an ad-hoc server for tracing
tracerListener = pipeListener
} else {
t, err := apmtransport.NewHTTPTransport(apmtransport.HTTPTransportOptions{
APIKey: cfg.APIKey,
SecretToken: cfg.SecretToken,
ServerURLs: cfg.Hosts,
})
if err != nil {
return nil, err
}
tracerTransport = t
}
var environment string
if cfg.Environment != nil {
environment = *cfg.Environment
}
tracer, err := apm.NewTracerOptions(apm.TracerOptions{
ServiceName: beatName,
ServiceVersion: beatVersion,
ServiceEnvironment: environment,
Transport: tracerTransport,
})
if err != nil {
return nil, err
}
tracer.SetLogger(warningLogger{logger})
return &instrumentation{
tracer: tracer,
listener: tracerListener,
}, nil
}
// warningLogger wraps logp.Logger to allow to be set in the apm.Tracer.
type warningLogger struct {
*logp.Logger
}
// Warningf logs a message at warning level.
func (l warningLogger) Warningf(format string, args ...interface{}) {
l.Warnf(format, args...)
}