Go agent configuration

Server-side configuration is available with Go agent versions 2.7.0 or higher. This allows you to configure certain settings in the UI. This applies your changes automatically to all agents even if they run across multiple hosts. Where available, this document includes the UI labels for server-side config under individual config options as the Server-side label.

You must still call newrelic.NewApplication() in your application process following the steps described in the in-process configuration. Configuration options set server-side will overwrite those set locally. Since not all configuration options are available server side, you may want to still update your newrelic.Config struct.

You configure your Go agent from the local in process newrelic.Config struct. This struct can be accessed when calling newrelic.NewApplication().

1. Add the following in the main function or in an init block:

   app, err := newrelic.NewApplication(
       newrelic.ConfigAppName("Your Application Name"),
       newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
   )

   Copy

2. Update values on the newrelic.Config struct to configure your application using newrelic.ConfigOptions. These are functions that accept a pointer to the newrelic.Config struct. Add additional newrelic.ConfigOptions to further configure your application. For example, you can use one of the predefined options to do common configurations:

   app, err := newrelic.NewApplication(
       newrelic.ConfigAppName("Your Application Name"),
       newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
       // add debug level logging to stdout
       newrelic.ConfigDebugLogger(os.Stdout),
   )

   Copy

3. Or, you can create your own newrelic.ConfigOption to do more complex configurations:

   app, err := newrelic.NewApplication(
       newrelic.ConfigAppName("Your Application Name"),
       newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
       newrelic.ConfigDebugLogger(os.Stdout),
       func(config *newrelic.Config) {
           // add more specific configuration of the agent within a custom ConfigOption
           config.HighSecurity = true
           config.CrossApplicationTracer.Enabled = false
       },
   )

   Copy

Specifies your New Relic license key, used to associate your app's metrics with a New Relic account. The license and the app name are both set as part of the New Relic installation process.

This is the application name used to aggregate data in the New Relic UI. You set both the license and the app name as part of the New Relic installation process.

To report data to multiple apps at the same time, specify a list of names separated with a semicolon. Do not put a space before the semicolon itself. For example:

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("YOUR_APP_NAME;APP_GROUP_1;ALL_APPS"),
    newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
)

When true, the agent sends data from your app to the New Relic collector.

To turn off New Relic monitoring, set this to false.

For example:

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
    func(config *newrelic.Config) {
        config.Enabled = false
    },
)

This can be useful for installing New Relic in a development environment or for troubleshooting purposes. When Enabled is set to false:

• The New Relic Go agent will not communicate with the New Relic collector.
• The agent will not spawn goroutines.
• The license key is not required during installation.

Add tags.

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
    func(config *newrelic.Config) {
        config.Labels = map[string]string{
            "Env":    "Dev",
            "Label2": "label2",
            "Label3": "label3",
            "Label4": "label4",
        }
    },
)

You can use the Logger interface to write Go log files to a specific location or logging system.

High security mode enforces certain security settings and prevents them from being overridden, so that the agent sends no sensitive data. High security mode does the following:

• Turns SSL on

• Turns off reporting of error message strings

• Turns off reporting of custom events

  This setting must match the corresponding account setting in the UI. For example:

  app, err := newrelic.NewApplication(
      newrelic.ConfigAppName("Your Application Name"),
      newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
      func(config *newrelic.Config) {
          config.HighSecurity = true
      },
  )

  Copy

  The agent communicates with New Relic via HTTPS by default, and New Relic requires HTTPS for all traffic to APM and our REST API.

Controls whether HTTPS or HTTP is used to send data to New Relic. The agent communicates with New Relic via HTTPS by default (which uses TLS protocol), and New Relic requires HTTPS for all traffic to APM and the New Relic REST API.

This sets the hostname displayed in the APM UI. This is an optional configuration.

This customizes http.Client communication with New Relic collectors. This can be used to configure a proxy.

When true, the agent captures runtime statistics.

When true, the agent sends custom events to New Relic. This setting is overridden by HighSecurity, which disables custom events.

To disable custom events, place the following in your Go app after the New Relic config is initiated:

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
    func(config *newrelic.Config) {
        config.CustomInsightsEvents.Enabled = false
    },
)

When true, the agent collects transaction events.

TransactionEvents.Attributes is a struct with three fields:

Enabled bool
Include []string
Exclude []string

Use TransactionEvents.Attributes.Enabled to turn attribute collection on or off for transaction events. Use Include and Exclude to include or exclude specific attributes.

An example of excluding an attribute slice named allAgentAttributeNames from transaction events:

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
    func(config *newrelic.Config) {
        config.TransactionEvents.Attributes.Exclude = allAgentAttributeNames
    },
)

Defines the maximum number of transaction events per minute to be sent to New Relic, up to the default maximum of 10,000 transaction events.

When false, the agent collects no errors or error traces.

When true, the agent collects error analytic events.

This controls which HTTP response codes are ignored as errors.

Response codes that are greater than or equal to 100 and strictly less than 400 are ignored by default and never have to be specified when calling this function. Response codes 0, 5, and 404 are included on the list by default, but must be specified when adding to the ignore list.

This function's default form is:

config.ErrorCollector.IgnoreStatusCodes = []int{
    0,                   // gRPC OK
    5,                   // gRPC NOT_FOUND
    http.StatusNotFound, // 404
}

You can also add response codes as HTTPs, as http.StatusNotFound above.

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
    func(config *newrelic.Config) {
        config.ErrorCollector.IgnoreStatusCodes = []int{0, 5, 404, 418}
    },
)

ErrorCollector.Attributes is a struct with three fields:

Enabled bool
Include []string
Exclude []string

Use ErrorCollector.Attributes.Enabled to turn attribute collection on or off for errors. Use Include and Exclude to include or exclude specific attributes.

An example of excluding an attribute slice named allAgentAttributeNames from errors:

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
    func(config *newrelic.Config) {
        config.ErrorCollector.Attributes.Exclude = allAgentAttributeNames
    },
)

When true, the agent collects transaction traces (detailed information about slow transactions).

Controls whether the transaction trace threshold is based on Apdex.

• If true, then the trace threshold is four times the Apdex threshold.
• If false, the agent uses Threshold.Duration as the transaction trace threshold.

If Threshold.IsApdexFailing is set to false, the agent uses this duration as the transaction trace threshold.

This is the threshold at which segments will be added to the trace.

TransactionTracer.Segments.Attributes is a struct with three fields:

Enabled bool
Include []string
Exclude []string

Use TransactionTracer.Segments.Attributes.Enabled to turn attribute collection on or off for transaction trace segments. Use Include and Exclude to include or exclude specific attributes.

An example of excluding an attribute slice named allSegmentAttributeNames from traces:

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
    func(config *newrelic.Config) {
        config.TransactionTracer.Segments.Attributes.Exclude = allSegmentAttributeNames
    },
)

This is the threshold at which segments will be given a stack trace in the transaction trace.

TransactionTracer.Attributes is a struct with three fields:

Enabled bool
Include []string
Exclude []string

Use TransactionTracer.Attributes.Enabled to turn attribute collection on or off for transaction traces. Use Include and Exclude to include or exclude specific attributes.

An example of excluding an attribute slice named allAgentAttributeNames from traces:

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
    func(config *newrelic.Config) {
        config.TransactionTracer.Attributes.Exclude = allAgentAttributeNames
    },
)

This enables collection of datastore instance metrics (such as the host and port) for some database drivers. These are reported on transaction traces and as part of slow query data.

Use this to enable collection of the database name on slow query traces and transaction traces. The default value of attribute enabled is true.

When true, the agent collects datastore call query parameters.

Controls whether slow queries are captured.

The agent captures slow query data for queries slower than this.

When true, the agent will add cross application tracing headers in outbound requests, and scan incoming requests for cross application tracing headers.

Distributed tracing and cross application tracing cannot be used simultaneously. The default configuration for the Go agent disables distributed tracing and enables cross application tracing.

Standard tracing is on by default in Go agent versions 3.16.0 and higher. This means the agent will automatically add distributed tracing headers in outbound requests, and scan incoming requests for distributed tracing headers. To disable distributed tracing, set the value to false.

For more information about setting up distributed tracing, see Enable distributed tracing for your Go applications.

Set this to true to exclude the New Relic header that is attached to outbound requests, and instead only rely on W3C Trace Context Headers for distributed tracing. If this is false then both types of headers are used.

When true, the agent will collect span events.

SpanEvents.Attributes is a struct with three fields:

Enabled bool
Include []string
Exclude []string

Use SpanEvents.Attributes.Enabled to enable or disable attribute collection for span events. Use Include and Exclude to include or exclude specific attributes.

An example of excluding an attribute slice named allSpanAttributeNames from traces:

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
    func(config *newrelic.Config) {
        config.TransactionTracer.Segments.Attributes.Exclude = allSpanAttributeNames
    },
)

If true, enables the collection of log events and logging metrics if these sub-feature configurations are also enabled. If false, no logging instrumentation features are enabled.

Configure ApplicationLogging by calling ConfigAppLogEnabled().

app, err := newrelic.NewApplication(
    newrelic.ConfigAppLogEnabled(true),
  )

If true, the agent captures log records emitted by your application and forwards them to New Relic. ApplicationLogging.Enabled must also be true for this setting to take effect.

Enable log forwarding by calling ConfigAppLogForwardingEnabled().

app, err := newrelic.NewApplication(
    newrelic.ConfigAppLogForwardingEnabled(true),
  )

Number of log records to send per minute to New Relic. This setting controls overall memory consumption when using the log forwarding feature.

Configure ApplicationLogging.Forwarding.MaxSamplesStored by calling ConfigAppLogForwardingMaxSamplesStored().

app, err := newrelic.NewApplication(
    newrelic.ConfigAppLogForwardingMaxSamplesStored(1000),
  )

If true, the agent captures metrics related to the log lines being sent up by your application. ApplicationLogging.Enabled must also be true for this setting to take effect.

Configure ApplicationLogging.Metrics.Enabled by calling ConfigAppLogMetricsEnabled().

app, err := newrelic.NewApplication(
    newrelic.ConfigAppLogConfigAppLogMetricsEnabled(true),
  )