This describes the properties to enable or disable attributes, and the rules that New Relic uses when determining which attributes to include or exclude for a destination. This also includes a summary of the Ruby agent properties that have been deprecated or removed with the release of New Relic agent attributes.
PropertiesUse the following properties to enable or disable attributes:
Type
Boolean
Default
true
Environ variable
NEW_RELIC_ATTRIBUTES_ENABLED
If true
, enables capture of attributes for all destinations.
Type
Boolean
Default
(Dynamic)
Environ variable
NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_ENABLED
If true
, the agent captures attributes from transaction traces.
Type
Boolean
Default
(Dynamic)
Environ variable
NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_ENABLED
If true
, the agent captures attributes from transaction events.
Type
Boolean
Default
(Dynamic)
Environ variable
NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_ENABLED
If true
, the agent captures attributes from error collection.
Type
Boolean
Default
(Dynamic)
Environ variable
NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_ENABLED
If true
, the agent captures attributes from .
Type
Boolean
Default
(Dynamic)
Environ variable
NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_ENABLED
If true
, the agent captures attributes on span events.
Type
Boolean
Default
(Dynamic)
Environ variable
NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_ENABLED
If true
, the agent captures attributes on transaction segments.
Type
Array
Default
[]
Environ variable
NEW_RELIC_ATTRIBUTES_EXCLUDE
Prefix of attributes to exclude from all destinations. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_EXCLUDE
Prefix of attributes to exclude from transaction traces. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_EXCLUDE
Prefix of attributes to exclude from transaction events. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_EXCLUDE
Prefix of attributes to exclude from error collection. Allows *
as wildcard at end.
To prevent error.message collection, instead use the strip_exception_messages configuration.
Type
Array
Default
[]
Environ variable
NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_EXCLUDE
Prefix of attributes to exclude from . Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_EXCLUDE
Prefix of attributes to exclude from span events. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_EXCLUDE
Prefix of attributes to exclude from transaction segments. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_ATTRIBUTES_INCLUDE
Prefix of attributes to include in all destinations. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_INCLUDE
Prefix of attributes to include in transaction traces. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_INCLUDE
Prefix of attributes to include in transaction events. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_INCLUDE
Prefix of attributes to include in error collection. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_INCLUDE
Prefix of attributes to include in browser monitoring. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_INCLUDE
Prefix of attributes to include in span events. Allows *
as wildcard at end.
Type
Array
Default
[]
Environ variable
NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_INCLUDE
Prefix of attributes to include in transaction segments. Allows *
as wildcard at end.
New Relic follows these rules when determining which attributes to include or exclude for a destination.
The attributes.enabled
field trumps all other settings. When false
, no attributes will be reported to New Relic.
Example configuration:
attributes.enabled: false
attributes.include: foo, bar
transaction_tracer.attributes.enabled: true
Example output:
Keys passed in: foo, bar, baz
Keys included for all destinations:
Keys excluded for all destinations: foo, bar, baz
The YOUR_DESTINATION.attributes.enabled
flags take precedence over include and exclude keys.
Example configuration:
transaction_tracer.attributes.enabled: false
attributes.include: one, two
transaction_tracer.attributes.include: three, four
Example output:
Keys passed in: one, two, three, four
Keys included for transaction traces:
Keys excluded for transaction traces: one, two, three, four
If a destination is enabled, all user attributes are sent to that destination by default.
Note: All user attributes default to true
. However, by default, request parameters are disabled for all destinations.
Example configuration:
Example output:
Keys passed in: foo, bar, baz
If the same key is listed in the include and exclude lists, then attributes with the specified key will be excluded.
Example configuration:
attributes.include: foo, bar
attributes.exclude: nerd, bar
Example output:
Keys passed in: foo, bar, nerd
Keys are case-sensitive.
Example configuration:
attributes.exclude: username, UsErNaMe
Example output:
Keys passed in: username, Username, USERNAME, UsErNaMe, userNAME
Keys included: Username, USERNAME, userNAME
Keys excluded: username, UsErNaMe
You can use an asterisk *
at the end of a key as a wildcard. This will match a set of attributes with the same prefix.
Example configuration:
attributes.include: custom*
attributes.exclude: request.parameters.*
Example output:
Keys passed in: custom, custom.key1, custom.key2, request.parameters., request.parameters.foo, request.parameters.bar
Keys included: custom, custom.key1, custom.key2
Keys excluded: request.parameters., request.parameters.foo, request.parameters.bar
If multiple include or exclude attributes affect the same key, the most specific setting will have priority.
Example configuration:
attributes.include: request.parameters.foo
attributes.exclude: request.parameters.*
Example output:
Keys passed in: request.parameters., request.parameters.foo, request.parameters.bar
Keys included: request.parameters.foo
Keys excluded: request.parameters., request.parameters.bar
If the attribute include or exclude is specified on a destination, then it only impacts that destination.
Example configuration:
transaction_events.attributes.exclude: foo
Example output:
Keys included for transaction events:
Keys included for other destinations: foo
Keys excluded for transaction events: foo
URI-related properties
By default, the Ruby agent reports Uniform Resource Identifiers (URIs) to New Relic in several different places, including the following destinations:
request.uri
attribute of error eventshttp.url
attribute of span eventsurl
attribute of slow SQL tracesuri
attribute of external request segmentsNew Relic recommends having these URIs reported, as they can contain useful debugging information. If your URIs contain sensitive data you don't want to report, such as email addresses or account IDs, you can disable URI reporting. To disable URI reporting, add any of the above attribute names to the attributes.exclude
list.
For example, adding the following key to your configuration file will stop the agent from reporting any of the URI-related properties:
Deprecated and removed propertiesThe following properties have been deprecated or removed. Switch to the new attributes configuration for these properties when upgrading your Ruby agent.
Deprecated property
New property
Removed Version
capture_params
attributes.include: request.parameters.*
N/A
resque.capture_params
attributes.include: job.resque.args.*
9.0.0
sidekiq.capture_params
attributes.include: job.sidekiq.args.*
9.0.0
transaction_tracer.capture_attributes
transaction_tracer.attributes.enabled
9.0.0
error_collector.capture_attributes
error_collector.attributes.enabled
9.0.0
browser_monitoring.capture_attributes
browser_monitoring.attributes.enabled
9.0.0
analytics_events.capture_attributes
transaction_events.attributes.enabled
9.0.0
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4