forked from newrelic/go-agent
-
Notifications
You must be signed in to change notification settings - Fork 0
/
collector.go
334 lines (283 loc) · 9.02 KB
/
collector.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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
// Copyright 2020 New Relic Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
package internal
import (
"encoding/json"
"errors"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"os"
"regexp"
"strconv"
"time"
"github.com/newrelic/go-agent/internal/logger"
)
const (
// ProcotolVersion is the protocol version used to communicate with NR
// backend.
ProcotolVersion = 17
userAgentPrefix = "NewRelic-Go-Agent/"
// Methods used in collector communication.
cmdPreconnect = "preconnect"
cmdConnect = "connect"
cmdMetrics = "metric_data"
cmdCustomEvents = "custom_event_data"
cmdTxnEvents = "analytic_event_data"
cmdErrorEvents = "error_event_data"
cmdErrorData = "error_data"
cmdTxnTraces = "transaction_sample_data"
cmdSlowSQLs = "sql_trace_data"
cmdSpanEvents = "span_event_data"
)
// RpmCmd contains fields specific to an individual call made to RPM.
type RpmCmd struct {
Name string
Collector string
RunID string
Data []byte
RequestHeadersMap map[string]string
MaxPayloadSize int
}
// RpmControls contains fields which will be the same for all calls made
// by the same application.
type RpmControls struct {
License string
Client *http.Client
Logger logger.Logger
AgentVersion string
}
// RPMResponse contains a NR endpoint response.
//
// Agent Behavior Summary:
//
// on connect/preconnect:
// 410 means shutdown
// 200, 202 mean success (start run)
// all other response codes and errors mean try after backoff
//
// on harvest:
// 410 means shutdown
// 401, 409 mean restart run
// 408, 429, 500, 503 mean save data for next harvest
// all other response codes and errors discard the data and continue the current harvest
type RPMResponse struct {
statusCode int
body []byte
// Err indicates whether or not the call was successful: newRPMResponse
// should be used to avoid mismatch between statusCode and Err.
Err error
disconnectSecurityPolicy bool
}
func newRPMResponse(statusCode int) RPMResponse {
var err error
if statusCode != 200 && statusCode != 202 {
err = fmt.Errorf("response code: %d", statusCode)
}
return RPMResponse{statusCode: statusCode, Err: err}
}
// IsDisconnect indicates that the agent should disconnect.
func (resp RPMResponse) IsDisconnect() bool {
return resp.statusCode == 410 || resp.disconnectSecurityPolicy
}
// IsRestartException indicates that the agent should restart.
func (resp RPMResponse) IsRestartException() bool {
return resp.statusCode == 401 ||
resp.statusCode == 409
}
// ShouldSaveHarvestData indicates that the agent should save the data and try
// to send it in the next harvest.
func (resp RPMResponse) ShouldSaveHarvestData() bool {
switch resp.statusCode {
case 408, 429, 500, 503:
return true
default:
return false
}
}
func rpmURL(cmd RpmCmd, cs RpmControls) string {
var u url.URL
u.Host = cmd.Collector
u.Path = "agent_listener/invoke_raw_method"
u.Scheme = "https"
query := url.Values{}
query.Set("marshal_format", "json")
query.Set("protocol_version", strconv.Itoa(ProcotolVersion))
query.Set("method", cmd.Name)
query.Set("license_key", cs.License)
if len(cmd.RunID) > 0 {
query.Set("run_id", cmd.RunID)
}
u.RawQuery = query.Encode()
return u.String()
}
func collectorRequestInternal(url string, cmd RpmCmd, cs RpmControls) RPMResponse {
compressed, err := compress(cmd.Data)
if nil != err {
return RPMResponse{Err: err}
}
if l := compressed.Len(); l > cmd.MaxPayloadSize {
return RPMResponse{Err: fmt.Errorf("Payload size for %s too large: %d greater than %d", cmd.Name, l, cmd.MaxPayloadSize)}
}
req, err := http.NewRequest("POST", url, compressed)
if nil != err {
return RPMResponse{Err: err}
}
req.Header.Add("Accept-Encoding", "identity, deflate")
req.Header.Add("Content-Type", "application/octet-stream")
req.Header.Add("User-Agent", userAgentPrefix+cs.AgentVersion)
req.Header.Add("Content-Encoding", "gzip")
for k, v := range cmd.RequestHeadersMap {
req.Header.Add(k, v)
}
resp, err := cs.Client.Do(req)
if err != nil {
return RPMResponse{Err: err}
}
defer resp.Body.Close()
r := newRPMResponse(resp.StatusCode)
// Read the entire response, rather than using resp.Body as input to json.NewDecoder to
// avoid the issue described here:
// https://github.com/google/go-github/pull/317
// https://ahmetalpbalkan.com/blog/golang-json-decoder-pitfalls/
// Also, collector JSON responses are expected to be quite small.
body, err := ioutil.ReadAll(resp.Body)
if nil == r.Err {
r.Err = err
}
r.body = body
return r
}
// CollectorRequest makes a request to New Relic.
func CollectorRequest(cmd RpmCmd, cs RpmControls) RPMResponse {
url := rpmURL(cmd, cs)
if cs.Logger.DebugEnabled() {
cs.Logger.Debug("rpm request", map[string]interface{}{
"command": cmd.Name,
"url": url,
"payload": JSONString(cmd.Data),
})
}
resp := collectorRequestInternal(url, cmd, cs)
if cs.Logger.DebugEnabled() {
if err := resp.Err; err != nil {
cs.Logger.Debug("rpm failure", map[string]interface{}{
"command": cmd.Name,
"url": url,
"response": string(resp.body), // Body might not be JSON on failure.
"error": err.Error(),
})
} else {
cs.Logger.Debug("rpm response", map[string]interface{}{
"command": cmd.Name,
"url": url,
"response": JSONString(resp.body),
})
}
}
return resp
}
const (
// NEW_RELIC_HOST can be used to override the New Relic endpoint. This
// is useful for testing.
envHost = "NEW_RELIC_HOST"
)
var (
preconnectHostOverride = os.Getenv(envHost)
preconnectHostDefault = "collector.newrelic.com"
preconnectRegionLicenseRegex = regexp.MustCompile(`(^.+?)x`)
)
func calculatePreconnectHost(license, overrideHost string) string {
if "" != overrideHost {
return overrideHost
}
m := preconnectRegionLicenseRegex.FindStringSubmatch(license)
if len(m) > 1 {
return "collector." + m[1] + ".nr-data.net"
}
return preconnectHostDefault
}
// ConnectJSONCreator allows the creation of the connect payload JSON to be
// deferred until the SecurityPolicies are acquired and vetted.
type ConnectJSONCreator interface {
CreateConnectJSON(*SecurityPolicies) ([]byte, error)
}
type preconnectRequest struct {
SecurityPoliciesToken string `json:"security_policies_token,omitempty"`
HighSecurity bool `json:"high_security"`
}
var (
errMissingAgentRunID = errors.New("connect reply missing agent run id")
)
// ConnectAttempt tries to connect an application.
func ConnectAttempt(config ConnectJSONCreator, securityPoliciesToken string, highSecurity bool, cs RpmControls) (*ConnectReply, RPMResponse) {
preconnectData, err := json.Marshal([]preconnectRequest{{
SecurityPoliciesToken: securityPoliciesToken,
HighSecurity: highSecurity,
}})
if nil != err {
return nil, RPMResponse{Err: fmt.Errorf("unable to marshal preconnect data: %v", err)}
}
call := RpmCmd{
Name: cmdPreconnect,
Collector: calculatePreconnectHost(cs.License, preconnectHostOverride),
Data: preconnectData,
MaxPayloadSize: maxPayloadSizeInBytes,
}
resp := CollectorRequest(call, cs)
if nil != resp.Err {
return nil, resp
}
var preconnect struct {
Preconnect PreconnectReply `json:"return_value"`
}
err = json.Unmarshal(resp.body, &preconnect)
if nil != err {
// Certain security policy errors must be treated as a disconnect.
return nil, RPMResponse{
Err: fmt.Errorf("unable to process preconnect reply: %v", err),
disconnectSecurityPolicy: isDisconnectSecurityPolicyError(err),
}
}
js, err := config.CreateConnectJSON(preconnect.Preconnect.SecurityPolicies.PointerIfPopulated())
if nil != err {
return nil, RPMResponse{Err: fmt.Errorf("unable to create connect data: %v", err)}
}
call.Collector = preconnect.Preconnect.Collector
call.Data = js
call.Name = cmdConnect
resp = CollectorRequest(call, cs)
if nil != resp.Err {
return nil, resp
}
reply, err := ConstructConnectReply(resp.body, preconnect.Preconnect)
if nil != err {
return nil, RPMResponse{Err: err}
}
// Note: This should never happen. It would mean the collector
// response is malformed. This exists merely as extra defensiveness.
if "" == reply.RunID {
return nil, RPMResponse{Err: errMissingAgentRunID}
}
return reply, resp
}
// ConstructConnectReply takes the body of a Connect reply, in the form of bytes, and a
// PreconnectReply, and converts it into a *ConnectReply
func ConstructConnectReply(body []byte, preconnect PreconnectReply) (*ConnectReply, error) {
var reply struct {
Reply *ConnectReply `json:"return_value"`
}
reply.Reply = ConnectReplyDefaults()
err := json.Unmarshal(body, &reply)
if nil != err {
return nil, fmt.Errorf("unable to parse connect reply: %v", err)
}
reply.Reply.PreconnectReply = preconnect
reply.Reply.AdaptiveSampler = NewAdaptiveSampler(
time.Duration(reply.Reply.SamplingTargetPeriodInSeconds)*time.Second,
reply.Reply.SamplingTarget,
time.Now())
reply.Reply.rulesCache = newRulesCache(txnNameCacheLimit)
return reply.Reply, nil
}