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 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
|
// Copyright 2020 New Relic Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
package newrelic
import (
"encoding/json"
"errors"
"fmt"
"net/http"
"os"
"regexp"
"strings"
"time"
"github.com/newrelic/go-agent/v3/internal"
"github.com/newrelic/go-agent/v3/internal/logger"
"github.com/newrelic/go-agent/v3/internal/sysinfo"
"github.com/newrelic/go-agent/v3/internal/utilization"
)
// Config contains Application and Transaction behavior settings.
type Config struct {
// AppName is used by New Relic to link data across servers.
//
// https://docs.newrelic.com/docs/apm/new-relic-apm/installation-configuration/naming-your-application
AppName string
// License is your New Relic license key.
//
// https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/license-key
License string
// Logger controls Go Agent logging.
//
// See https://github.com/newrelic/go-agent/blob/master/GUIDE.md#logging
// for more examples and logging integrations.
Logger Logger
// Enabled controls whether the agent will communicate with the New Relic
// servers and spawn goroutines. Setting this to be false is useful in
// testing and staging situations.
Enabled bool
// Labels are key value pairs used to roll up applications into specific
// categories.
//
// https://docs.newrelic.com/docs/using-new-relic/user-interface-functions/organize-your-data/labels-categories-organize-apps-monitors
Labels map[string]string
// HighSecurity guarantees that certain agent settings can not be made
// more permissive. This setting must match the corresponding account
// setting in the New Relic UI.
//
// https://docs.newrelic.com/docs/agents/manage-apm-agents/configuration/high-security-mode
HighSecurity bool
// SecurityPoliciesToken enables security policies if set to a non-empty
// string. Only set this if security policies have been enabled on your
// account. This cannot be used in conjunction with HighSecurity.
//
// https://docs.newrelic.com/docs/agents/manage-apm-agents/configuration/enable-configurable-security-policies
SecurityPoliciesToken string
// CustomInsightsEvents controls the behavior of
// Application.RecordCustomEvent.
//
// https://docs.newrelic.com/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-new-relic-apm-agents
CustomInsightsEvents struct {
// Enabled controls whether RecordCustomEvent will collect
// custom analytics events. High security mode overrides this
// setting.
Enabled bool
}
// TransactionEvents controls the behavior of transaction analytics
// events.
TransactionEvents struct {
// Enabled controls whether transaction events are captured.
Enabled bool
// Attributes controls the attributes included with transaction
// events.
Attributes AttributeDestinationConfig
// MaxSamplesStored allows you to limit the number of Transaction
// Events stored/reported in a given 60-second period
MaxSamplesStored int
}
// ErrorCollector controls the capture of errors.
ErrorCollector struct {
// Enabled controls whether errors are captured. This setting
// affects both traced errors and error analytics events.
Enabled bool
// CaptureEvents controls whether error analytics events are
// captured.
CaptureEvents bool
// IgnoreStatusCodes controls which http response codes are
// automatically turned into errors. By default, response codes
// greater than or equal to 400 or less than 100 -- with the exception
// of 0, 5, and 404 -- are turned into errors.
IgnoreStatusCodes []int
// Attributes controls the attributes included with errors.
Attributes AttributeDestinationConfig
// RecordPanics controls whether or not a deferred
// Transaction.End will attempt to recover panics, record them
// as errors, and then re-panic them. By default, this is
// set to false.
RecordPanics bool
}
// TransactionTracer controls the capture of transaction traces.
TransactionTracer struct {
// Enabled controls whether transaction traces are captured.
Enabled bool
// Threshold controls whether a transaction trace will be
// considered for capture. Of the traces exceeding the
// threshold, the slowest trace every minute is captured.
Threshold struct {
// If IsApdexFailing is true then the trace threshold is
// four times the apdex threshold.
IsApdexFailing bool
// If IsApdexFailing is false then this field is the
// threshold, otherwise it is ignored.
Duration time.Duration
}
// Attributes controls the attributes included with transaction
// traces.
Attributes AttributeDestinationConfig
// Segments contains fields which control the behavior of
// transaction trace segments.
Segments struct {
// StackTraceThreshold is the threshold at which
// segments will be given a stack trace in the
// transaction trace. Lowering this setting will
// increase overhead.
StackTraceThreshold time.Duration
// Threshold is the threshold at which segments will be
// added to the trace. Lowering this setting may
// increase overhead. Decrease this duration if your
// transaction traces are missing segments.
Threshold time.Duration
// Attributes controls the attributes included with each
// trace segment.
Attributes AttributeDestinationConfig
}
}
// BrowserMonitoring contains settings which control the behavior of
// Transaction.BrowserTimingHeader.
BrowserMonitoring struct {
// Enabled controls whether or not the Browser monitoring feature is
// enabled.
Enabled bool
// Attributes controls the attributes included with Browser monitoring.
// BrowserMonitoring.Attributes.Enabled is false by default, to include
// attributes in the Browser timing Javascript:
//
// cfg.BrowserMonitoring.Attributes.Enabled = true
Attributes AttributeDestinationConfig
}
// HostDisplayName gives this server a recognizable name in the New
// Relic UI. This is an optional setting.
HostDisplayName string
// Transport customizes communication with the New Relic servers. This may
// be used to configure a proxy.
Transport http.RoundTripper
// Utilization controls the detection and gathering of system
// information.
Utilization struct {
// DetectAWS controls whether the Application attempts to detect
// AWS.
DetectAWS bool
// DetectAzure controls whether the Application attempts to detect
// Azure.
DetectAzure bool
// DetectPCF controls whether the Application attempts to detect
// PCF.
DetectPCF bool
// DetectGCP controls whether the Application attempts to detect
// GCP.
DetectGCP bool
// DetectDocker controls whether the Application attempts to
// detect Docker.
DetectDocker bool
// DetectKubernetes controls whether the Application attempts to
// detect Kubernetes.
DetectKubernetes bool
// These settings provide system information when custom values
// are required.
LogicalProcessors int
TotalRAMMIB int
BillingHostname string
}
// Heroku controls the behavior of Heroku specific features.
Heroku struct {
// UseDynoNames controls if Heroku dyno names are reported as the
// hostname. Default is true.
UseDynoNames bool
// DynoNamePrefixesToShorten allows you to shorten and combine some
// Heroku dyno names into a single value. Ordinarily the agent reports
// dyno names with a trailing dot and process ID (for example,
// worker.3). You can remove this trailing data by specifying the
// prefixes you want to report without trailing data (for example,
// worker.*). Defaults to shortening "scheduler" and "run" dyno names.
DynoNamePrefixesToShorten []string
}
// CrossApplicationTracer controls behavior relating to cross application
// tracing (CAT). In the case where CrossApplicationTracer and
// DistributedTracer are both enabled, DistributedTracer takes precedence.
//
// https://docs.newrelic.com/docs/apm/transactions/cross-application-traces/introduction-cross-application-traces
CrossApplicationTracer struct {
Enabled bool
}
// DistributedTracer controls behavior relating to Distributed Tracing. In
// the case where CrossApplicationTracer and DistributedTracer are both
// enabled, DistributedTracer takes precedence.
//
// https://docs.newrelic.com/docs/apm/distributed-tracing/getting-started/introduction-distributed-tracing
DistributedTracer struct {
Enabled bool
// ExcludeNewRelicHeader allows you to choose whether to insert the New
// Relic Distributed Tracing header on outbound requests, which by
// default is emitted along with the W3C trace context headers. Set
// this value to true if you do not want to include the New Relic
// distributed tracing header in your outbound requests.
//
// Disabling the New Relic header here does not prevent the agent from
// accepting *inbound* New Relic headers.
ExcludeNewRelicHeader bool
}
// SpanEvents controls behavior relating to Span Events. Span Events
// require that DistributedTracer is enabled.
SpanEvents struct {
Enabled bool
// Attributes controls the attributes included on Spans.
Attributes AttributeDestinationConfig
}
// InfiniteTracing controls behavior related to Infinite Tracing tail based
// sampling. InfiniteTracing requires that both DistributedTracer and
// SpanEvents are enabled.
//
// https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/enable-configure/enable-distributed-tracing
InfiniteTracing struct {
// TraceObserver controls behavior of connecting to the Trace Observer.
TraceObserver struct {
// Host is the Trace Observer host to connect to and tells the
// Application to enable Infinite Tracing support. When this field
// is set to an empty string, which is the default, Infinite
// Tracing support is disabled.
Host string
// Port is the Trace Observer port to connect to. The default is
// 443.
Port int
}
// SpanEvents controls the behavior of the span events sent to the
// Trace Observer.
SpanEvents struct {
// QueueSize is the maximum number of span events that may be held
// in memory as they wait to be serialized and sent to the Trace
// Observer. Default value is 10,000. Any span event created when
// the QueueSize limit is reached will be discarded.
QueueSize int
}
}
// DatastoreTracer controls behavior relating to datastore segments.
DatastoreTracer struct {
// InstanceReporting controls whether the host and port are collected
// for datastore segments.
InstanceReporting struct {
Enabled bool
}
// DatabaseNameReporting controls whether the database name is
// collected for datastore segments.
DatabaseNameReporting struct {
Enabled bool
}
QueryParameters struct {
Enabled bool
}
// SlowQuery controls the capture of slow query traces. Slow
// query traces show you instances of your slowest datastore
// segments.
SlowQuery struct {
Enabled bool
Threshold time.Duration
}
}
// Attributes controls which attributes are enabled and disabled globally.
// This setting affects all attribute destinations: Transaction Events,
// Error Events, Transaction Traces and segments, Traced Errors, Span
// Events, and Browser timing header.
Attributes AttributeDestinationConfig
// RuntimeSampler controls the collection of runtime statistics like
// CPU/Memory usage, goroutine count, and GC pauses.
RuntimeSampler struct {
// Enabled controls whether runtime statistics are captured.
Enabled bool
}
// ServerlessMode contains fields which control behavior when running in
// AWS Lambda.
//
// https://docs.newrelic.com/docs/serverless-function-monitoring/aws-lambda-monitoring/get-started/introduction-new-relic-monitoring-aws-lambda
ServerlessMode struct {
// Enabling ServerlessMode will print each transaction's data to
// stdout. No agent goroutines will be spawned in serverless mode, and
// no data will be sent directly to the New Relic backend.
// nrlambda.NewConfig sets Enabled to true.
Enabled bool
// ApdexThreshold sets the Apdex threshold when in ServerlessMode. The
// default is 500 milliseconds. nrlambda.NewConfig populates this
// field using the NEW_RELIC_APDEX_T environment variable.
//
// https://docs.newrelic.com/docs/apm/new-relic-apm/apdex/apdex-measure-user-satisfaction
ApdexThreshold time.Duration
// AccountID, TrustedAccountKey, and PrimaryAppID are used for
// distributed tracing in ServerlessMode. AccountID and
// TrustedAccountKey must be populated for distributed tracing to be
// enabled. nrlambda.NewConfig populates these fields using the
// NEW_RELIC_ACCOUNT_ID, NEW_RELIC_TRUSTED_ACCOUNT_KEY, and
// NEW_RELIC_PRIMARY_APPLICATION_ID environment variables.
AccountID string
TrustedAccountKey string
PrimaryAppID string
}
// Host can be used to override the New Relic endpoint.
Host string
// Error may be populated by the ConfigOptions provided to NewApplication
// to indicate that setup has failed. NewApplication will return this
// error if it is set.
Error error
}
// AttributeDestinationConfig controls the attributes sent to each destination.
// For more information, see:
// https://docs.newrelic.com/docs/agents/manage-apm-agents/agent-data/agent-attributes
type AttributeDestinationConfig struct {
// Enabled controls whether or not this destination will get any
// attributes at all. For example, to prevent any attributes from being
// added to errors, set:
//
// cfg.ErrorCollector.Attributes.Enabled = false
//
Enabled bool
Include []string
// Exclude allows you to prevent the capture of certain attributes. For
// example, to prevent the capture of the request URL attribute
// "request.uri", set:
//
// cfg.Attributes.Exclude = append(cfg.Attributes.Exclude, newrelic.AttributeRequestURI)
//
// The '*' character acts as a wildcard. For example, to prevent the
// capture of all request related attributes, set:
//
// cfg.Attributes.Exclude = append(cfg.Attributes.Exclude, "request.*")
//
Exclude []string
}
// defaultConfig creates a Config populated with default settings.
func defaultConfig() Config {
c := Config{}
c.Enabled = true
c.Labels = make(map[string]string)
c.CustomInsightsEvents.Enabled = true
c.TransactionEvents.Enabled = true
c.TransactionEvents.Attributes.Enabled = true
c.TransactionEvents.MaxSamplesStored = internal.MaxTxnEvents
c.HighSecurity = false
c.ErrorCollector.Enabled = true
c.ErrorCollector.CaptureEvents = true
c.ErrorCollector.IgnoreStatusCodes = []int{
// https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
0, // gRPC OK
5, // gRPC NOT_FOUND
http.StatusNotFound, // 404
}
c.ErrorCollector.Attributes.Enabled = true
c.Utilization.DetectAWS = true
c.Utilization.DetectAzure = true
c.Utilization.DetectPCF = true
c.Utilization.DetectGCP = true
c.Utilization.DetectDocker = true
c.Utilization.DetectKubernetes = true
c.Attributes.Enabled = true
c.RuntimeSampler.Enabled = true
c.TransactionTracer.Enabled = true
c.TransactionTracer.Threshold.IsApdexFailing = true
c.TransactionTracer.Threshold.Duration = 500 * time.Millisecond
c.TransactionTracer.Segments.Threshold = 2 * time.Millisecond
c.TransactionTracer.Segments.StackTraceThreshold = 500 * time.Millisecond
c.TransactionTracer.Attributes.Enabled = true
c.TransactionTracer.Segments.Attributes.Enabled = true
c.BrowserMonitoring.Enabled = true
// browser monitoring attributes are disabled by default
c.BrowserMonitoring.Attributes.Enabled = false
c.CrossApplicationTracer.Enabled = true
c.DistributedTracer.Enabled = false
c.SpanEvents.Enabled = true
c.SpanEvents.Attributes.Enabled = true
c.DatastoreTracer.InstanceReporting.Enabled = true
c.DatastoreTracer.DatabaseNameReporting.Enabled = true
c.DatastoreTracer.QueryParameters.Enabled = true
c.DatastoreTracer.SlowQuery.Enabled = true
c.DatastoreTracer.SlowQuery.Threshold = 10 * time.Millisecond
c.ServerlessMode.ApdexThreshold = 500 * time.Millisecond
c.ServerlessMode.Enabled = false
c.Heroku.UseDynoNames = true
c.Heroku.DynoNamePrefixesToShorten = []string{"scheduler", "run"}
c.InfiniteTracing.TraceObserver.Port = 443
c.InfiniteTracing.SpanEvents.QueueSize = 10000
return c
}
const (
licenseLength = 40
appNameLimit = 3
)
// The following errors will be returned if your Config fails to validate.
var (
errLicenseLen = fmt.Errorf("license length is not %d", licenseLength)
errAppNameMissing = errors.New("string AppName required")
errAppNameLimit = fmt.Errorf("max of %d rollup application names", appNameLimit)
errHighSecurityWithSecurityPolicies = errors.New("SecurityPoliciesToken and HighSecurity are incompatible; please ensure HighSecurity is set to false if SecurityPoliciesToken is a non-empty string and a security policy has been set for your account")
errInfTracingServerless = errors.New("ServerlessMode cannot be used with Infinite Tracing")
)
// validate checks the config for improper fields. If the config is invalid,
// newrelic.NewApplication returns an error.
func (c Config) validate() error {
if c.Enabled && !c.ServerlessMode.Enabled {
if len(c.License) != licenseLength {
return errLicenseLen
}
} else {
// The License may be empty when the agent is not enabled.
if len(c.License) != licenseLength && len(c.License) != 0 {
return errLicenseLen
}
}
if "" == c.AppName && c.Enabled && !c.ServerlessMode.Enabled {
return errAppNameMissing
}
if c.HighSecurity && "" != c.SecurityPoliciesToken {
return errHighSecurityWithSecurityPolicies
}
if strings.Count(c.AppName, ";") >= appNameLimit {
return errAppNameLimit
}
if "" != c.InfiniteTracing.TraceObserver.Host && c.ServerlessMode.Enabled {
return errInfTracingServerless
}
return nil
}
func (c Config) validateTraceObserverConfig() (*observerURL, error) {
configHost := c.InfiniteTracing.TraceObserver.Host
if "" == configHost {
// This is the only instance from which we can return nil, nil.
// If the user requests use of a trace observer, we must either provide
// them with a valid observerURL _or_ alert them to the failure to do so.
return nil, nil
}
if !versionSupports8T {
return nil, errUnsupportedVersion
}
if !c.DistributedTracer.Enabled || !c.SpanEvents.Enabled {
return nil, errSpanOrDTDisabled
}
return &observerURL{
host: fmt.Sprintf("%s:%d", configHost, c.InfiniteTracing.TraceObserver.Port),
secure: configHost != localTestingHost,
}, nil
}
// maxTxnEvents returns the configured maximum number of Transaction Events if it has been configured
// and is less than the default maximum; otherwise it returns the default max.
func (c Config) maxTxnEvents() int {
configured := c.TransactionEvents.MaxSamplesStored
if configured < 0 || configured > internal.MaxTxnEvents {
return internal.MaxTxnEvents
}
return configured
}
func copyDestConfig(c AttributeDestinationConfig) AttributeDestinationConfig {
cp := c
if nil != c.Include {
cp.Include = make([]string, len(c.Include))
copy(cp.Include, c.Include)
}
if nil != c.Exclude {
cp.Exclude = make([]string, len(c.Exclude))
copy(cp.Exclude, c.Exclude)
}
return cp
}
func copyConfigReferenceFields(cfg Config) Config {
cp := cfg
if nil != cfg.Labels {
cp.Labels = make(map[string]string, len(cfg.Labels))
for key, val := range cfg.Labels {
cp.Labels[key] = val
}
}
if nil != cfg.ErrorCollector.IgnoreStatusCodes {
ignored := make([]int, len(cfg.ErrorCollector.IgnoreStatusCodes))
copy(ignored, cfg.ErrorCollector.IgnoreStatusCodes)
cp.ErrorCollector.IgnoreStatusCodes = ignored
}
cp.Attributes = copyDestConfig(cfg.Attributes)
cp.ErrorCollector.Attributes = copyDestConfig(cfg.ErrorCollector.Attributes)
cp.TransactionEvents.Attributes = copyDestConfig(cfg.TransactionEvents.Attributes)
cp.TransactionTracer.Attributes = copyDestConfig(cfg.TransactionTracer.Attributes)
cp.BrowserMonitoring.Attributes = copyDestConfig(cfg.BrowserMonitoring.Attributes)
cp.SpanEvents.Attributes = copyDestConfig(cfg.SpanEvents.Attributes)
cp.TransactionTracer.Segments.Attributes = copyDestConfig(cfg.TransactionTracer.Segments.Attributes)
return cp
}
func transportSetting(t http.RoundTripper) interface{} {
if nil == t {
return nil
}
return fmt.Sprintf("%T", t)
}
func loggerSetting(lg Logger) interface{} {
if nil == lg {
return nil
}
if _, ok := lg.(logger.ShimLogger); ok {
return nil
}
return fmt.Sprintf("%T", lg)
}
const (
// https://source.datanerd.us/agents/agent-specs/blob/master/Custom-Host-Names.md
hostByteLimit = 255
)
type settings Config
func (s settings) MarshalJSON() ([]byte, error) {
c := Config(s)
transport := c.Transport
c.Transport = nil
l := c.Logger
c.Logger = nil
js, err := json.Marshal(c)
if nil != err {
return nil, err
}
fields := make(map[string]interface{})
err = json.Unmarshal(js, &fields)
if nil != err {
return nil, err
}
// The License field is not simply ignored by adding the `json:"-"` tag
// to it since we want to allow consumers to populate Config from JSON.
delete(fields, `License`)
fields[`Transport`] = transportSetting(transport)
fields[`Logger`] = loggerSetting(l)
// Browser monitoring support.
if c.BrowserMonitoring.Enabled {
fields[`browser_monitoring.loader`] = "rum"
}
return json.Marshal(fields)
}
// labels is used for connect JSON formatting.
type labels map[string]string
func (l labels) MarshalJSON() ([]byte, error) {
ls := make([]struct {
Key string `json:"label_type"`
Value string `json:"label_value"`
}, len(l))
i := 0
for key, val := range l {
ls[i].Key = key
ls[i].Value = val
i++
}
return json.Marshal(ls)
}
func configConnectJSONInternal(c Config, pid int, util *utilization.Data, e environment, version string, securityPolicies *internal.SecurityPolicies, metadata map[string]string) ([]byte, error) {
return json.Marshal([]interface{}{struct {
Pid int `json:"pid"`
Language string `json:"language"`
Version string `json:"agent_version"`
Host string `json:"host"`
HostDisplayName string `json:"display_host,omitempty"`
Settings interface{} `json:"settings"`
AppName []string `json:"app_name"`
HighSecurity bool `json:"high_security"`
Labels labels `json:"labels,omitempty"`
Environment environment `json:"environment"`
Identifier string `json:"identifier"`
Util *utilization.Data `json:"utilization"`
SecurityPolicies *internal.SecurityPolicies `json:"security_policies,omitempty"`
Metadata map[string]string `json:"metadata"`
EventData internal.EventHarvestConfig `json:"event_harvest_config"`
}{
Pid: pid,
Language: agentLanguage,
Version: version,
Host: stringLengthByteLimit(util.Hostname, hostByteLimit),
HostDisplayName: stringLengthByteLimit(c.HostDisplayName, hostByteLimit),
Settings: (settings)(c),
AppName: strings.Split(c.AppName, ";"),
HighSecurity: c.HighSecurity,
Labels: c.Labels,
Environment: e,
// This identifier field is provided to avoid:
// https://newrelic.atlassian.net/browse/DSCORE-778
//
// This identifier is used by the collector to look up the real
// agent. If an identifier isn't provided, the collector will
// create its own based on the first appname, which prevents a
// single daemon from connecting "a;b" and "a;c" at the same
// time.
//
// Providing the identifier below works around this issue and
// allows users more flexibility in using application rollups.
Identifier: c.AppName,
Util: util,
SecurityPolicies: securityPolicies,
Metadata: metadata,
EventData: internal.DefaultEventHarvestConfig(c.maxTxnEvents()),
}})
}
const (
// https://source.datanerd.us/agents/agent-specs/blob/master/Connect-LEGACY.md#metadata-hash
metadataPrefix = "NEW_RELIC_METADATA_"
)
func gatherMetadata(env []string) map[string]string {
metadata := make(map[string]string)
for _, pair := range env {
if strings.HasPrefix(pair, metadataPrefix) {
idx := strings.Index(pair, "=")
if idx >= 0 {
metadata[pair[0:idx]] = pair[idx+1:]
}
}
}
return metadata
}
// config exists to avoid adding private fields to Config.
type config struct {
Config
// These fields based on environment variables are located here, rather
// than in appRun, to ensure that they are calculated during
// NewApplication (instead of at each connect) because some customers
// may unset environment variables after startup:
// https://github.com/newrelic/go-agent/issues/127
metadata map[string]string
hostname string
traceObserverURL *observerURL
}
func (c Config) computeDynoHostname(getenv func(string) string) string {
if !c.Heroku.UseDynoNames {
return ""
}
dyno := getenv("DYNO")
if dyno == "" {
return ""
}
for _, prefix := range c.Heroku.DynoNamePrefixesToShorten {
if prefix == "" {
continue
}
if strings.HasPrefix(dyno, prefix+".") {
dyno = prefix + ".*"
break
}
}
return dyno
}
func newInternalConfig(cfg Config, getenv func(string) string, environ []string) (config, error) {
// Copy maps and slices to prevent race conditions if a consumer changes
// them after calling NewApplication.
cfg = copyConfigReferenceFields(cfg)
if err := cfg.validate(); nil != err {
return config{}, err
}
obsURL, err := cfg.validateTraceObserverConfig()
if err != nil {
return config{}, err
}
// Ensure that Logger is always set to avoid nil checks.
if nil == cfg.Logger {
cfg.Logger = logger.ShimLogger{}
}
var hostname string
if host := cfg.computeDynoHostname(getenv); host != "" {
hostname = host
} else if host, err := sysinfo.Hostname(); err == nil {
hostname = host
} else {
hostname = "unknown"
}
return config{
Config: cfg,
metadata: gatherMetadata(environ),
hostname: hostname,
traceObserverURL: obsURL,
}, nil
}
func (c config) createConnectJSON(securityPolicies *internal.SecurityPolicies) ([]byte, error) {
env := newEnvironment()
util := utilization.Gather(utilization.Config{
DetectAWS: c.Utilization.DetectAWS,
DetectAzure: c.Utilization.DetectAzure,
DetectPCF: c.Utilization.DetectPCF,
DetectGCP: c.Utilization.DetectGCP,
DetectDocker: c.Utilization.DetectDocker,
DetectKubernetes: c.Utilization.DetectKubernetes,
LogicalProcessors: c.Utilization.LogicalProcessors,
TotalRAMMIB: c.Utilization.TotalRAMMIB,
BillingHostname: c.Utilization.BillingHostname,
Hostname: c.hostname,
}, c.Logger)
return configConnectJSONInternal(c.Config, os.Getpid(), util, env, Version, securityPolicies, c.metadata)
}
var (
preconnectHostDefault = "collector.newrelic.com"
preconnectRegionLicenseRegex = regexp.MustCompile(`(^.+?)x`)
)
func (c config) preconnectHost() string {
if "" != c.Host {
return c.Host
}
m := preconnectRegionLicenseRegex.FindStringSubmatch(c.License)
if len(m) > 1 {
return "collector." + m[1] + ".nr-data.net"
}
return preconnectHostDefault
}
|