Enabling and disabling attributes (Python)

This describes the configuration settings to enable or disable Python agent attributes, and the rules that our agents use when determining which attributes to include or exclude for a destination.

This also includes a summary of the Python agent configuration settings that have been deprecated with the release of agent attributes.

Configuration settings

Use the following destination settings to open or close the destination to any attribute collection:

Type	Boolean
Default	`true`

Turns on or turns off all attributes.

Type	Boolean
Default	`true`

Turns on or turns off all attributes for transaction traces. If attributes.enabled is false, no attributes will be sent to transaction traces regardless of how this configuration setting is set.

Type:	Boolean
Default:	`true`

Turns on or turns off all attributes for traced errors. If attributes.enabled is false, no attributes will be sent to traced errors regardless of how this configuration setting is set.

Type:	Boolean
Default:	`true`

Turns on or turns off all attributes for transaction events. If attributes.enabled is false, no attributes will be sent to transaction events regardless of how this configuration setting is set.

Type:	Boolean
Default:	`false`

Turns on or turns off all attributes for . This is the data that gets sent to the PageView destination. If attributes.enabled is false, no attributes will be sent to browser monitoring regardless of how this configuration setting is set.

Use the following attribute/destination specific .include or .exclude settings to add or remove specific attributes in specific destinations:

Type:	Space-Separated List of Strings
Default:	(none)

Type:	Space-separated list of strings
Default:	(none)

Type:	Space-separated list of strings
Default:	(none)

Type:	Space-separated list of strings
Default:	(none)

Type:	Space-separated list of strings
Default:	(none)

Type:	Space-separated list of strings
Default:	(none)

Type:	Space-separated list of strings
Default:	(none)

Type:	Space-separated list of strings
Default:	(none)

Type:	Space-separated list of strings
Default:	(none)

Type:	Space-separated list of strings
Default:	(none)

Attribute rules

The agent 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.

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.

All user attributes default to true. However, by default, request parameters are disabled for all destinations.

Example configuration:

attributes.enabled = true
attributes.exclude = baz

Example output:

Keys passed in: foo, bar, baz
Keys included:  foo, bar
Keys excluded:  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.enabled = true
attributes.include = foo bar
attributes.exclude = nerd bar

Example output:

Keys passed in: foo, bar, nerd
Keys included:  foo
Keys excluded:  nerd, bar

Keys are case-sensitive.

Example configuration:

attributes.enabled = true
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.enabled = true
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.enabled = true
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:

attributes.include = foo
transaction_events.attributes.exclude = foo

Example output:

Keys passed in: foo
Keys included for transaction events: 
Keys included for other destinations: foo
Keys excluded for transaction events: foo

Deprecated configuration settings

The following configuration settings have been deprecated. Switch to the new attributes configuration for these settings when upgrading your Python agent.

Deprecated setting	New setting
`capture_params`	`attributes.include = request.parameters.` By default, request parameters are not sent. Add `request.parameters.` to the `attributes.include` list to turn on all request parameters. The `capture_params` property has been deprecated.
`ignored_params`	`attributes.exclude = request.parameters.{name}` Add each request parameter key to the `attributes.exclude` list. Be sure to prepend the key with `request.parameters`. The `ignored_params` property has been deprecated.
`analytics_events.enabled`	`transaction_events.enabled`
`analytics_events.capture_attributes`	`transaction_events.capture_attributes`
`analytics_events.max_samples_stored`	`transaction_events.max_samples_stored`
`browser_monitoring.capture_attributes`	`browser_monitoring.attributes.enabled`
`error_collector.capture_attributes`	`error_collector.attributes.enabled`
`transaction_tracer.capture_attributes`	`transaction_tracer.attributes.enabled`

Enabling and disabling attributes (Python)

Configuration settings

attributes.enabled

transaction_tracer.attributes.enabled

error_collector.attributes.enabled

transaction_events.attributes.enabled

browser_monitoring.attributes.enabled

attributes.include

attributes.exclude

transaction_tracer.attributes.include

transaction_tracer.attributes.exclude

error_collector.attributes.include

error_collector.attributes.exclude

transaction_events.attributes.include

transaction_events.attributes.exclude

browser_monitoring.attributes.include

browser_monitoring.attributes.exclude

Attribute rules

Root level takes precedence for enabled.

Destination enabled takes precedence over include and exclude.

Attribute is included if the destination is enabled.

Exclude always supersedes include.

Keys are case sensitive.

Use `\*` for wildcards.

Most specific setting for a key takes priority.

Include or exclude affects the specific destination.

Deprecated configuration settings

Enabling and disabling attributes (Python)

Configuration settings .css-21sua1{background:none;border:none;width:0;padding:0;}

transaction_tracer.attributes.enabled

error_collector.attributes.enabled

transaction_events.attributes.enabled

browser_monitoring.attributes.enabled

attributes.include

attributes.exclude

transaction_tracer.attributes.include

transaction_tracer.attributes.exclude

error_collector.attributes.include

error_collector.attributes.exclude

transaction_events.attributes.include

transaction_events.attributes.exclude

browser_monitoring.attributes.include

browser_monitoring.attributes.exclude

Attribute rules

Root level takes precedence for enabled.

Destination enabled takes precedence over include and exclude.

Attribute is included if the destination is enabled.

Exclude always supersedes include.

Keys are case sensitive.

Use \* for wildcards.

Most specific setting for a key takes priority.

Include or exclude affects the specific destination.

Deprecated configuration settings

Configuration settings

Use `\*` for wildcards.