PHP agent attributes

Attributes are key-value pairs containing information that determines the properties of an event or transaction. New Relic enables you to customize exactly which attributes will be sent to each of these destinations:

  • Transaction traces in New Relic APM
  • Error traces in New Relic APM
  • Transaction events in Insights
  • Page views in Insights

This document provides specifics for attributes available as of PHP agent version 4.9.

Attribute destination flow

The following diagram illustrates how the agent decides to send attributes to each destination.

nr attribute collection diagram.png
Agent attribute collection: The agent makes three different decisions when sending an attribute to any New Relic destination based on the relevant property settings.

PHP agent attributes

You can configure the following attributes in the PHP agent. See PHP agent (newrelic.ini) settings and Enabling and disabling attributes for more information.

httpResponseCode

The response status code for a web request.

Defaults:

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Enabled
  • Page views (browser monitoring): Unavailable
newrelic_add_custom_parameter API call

Attributes added to an newrelic_add_custom_parameter() call on the New Relic API.

Defaults:

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Enabled
  • Page views (browser monitoring): Enabled
request.headers.accept

The types as read from the HTTP Accept request header.

Defaults:

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Enabled
  • Page views (browser monitoring): Unavailable
request.headers.contentType

The incoming request content-type as read from the Content-Type request header.

Defaults:

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Enabled
  • Page views (browser monitoring): Unavailable
request.headers.contentLength

The incoming request size in bytes as read from the Content-Length request header.

Defaults:

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Enabled
  • Page views (browser monitoring): Unavailable
request.headers.host

The name from the HTTP host request header.

Defaults:

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Enabled
  • Page views (browser monitoring): Unavailable
request.headers.referer

The incoming request referer as read from the Referer request header.

Defaults:

  • Transaction traces: Disabled
  • Error collector (traced errors): Enabled
  • Transaction events: Disabled
  • Page views (browser monitoring): Unavailable
request.headers.User-Agent

The contents of the User-Agent HTTP header.

Defaults:

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Disabled
  • Page views (browser monitoring): Unavailable
request.method

The HTTP method of the incoming request.

Defaults:

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Enabled
  • Page views (browser monitoring): Unavailable
request.parameters.*

Request parameters from the transaction.

The capture_params property has been deprecated. However, if set to true, it will enable request parameters for transaction traces and traced errors.

Defaults:

  • Transaction traces: Disabled
  • Error collector (traced errors): Disabled
  • Transaction events: Disabled
  • Page views (browser monitoring): Unavailable
response.headers.contentLength

The outgoing response size in bytes as read from the Content-Length response header.

Defaults:

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Enabled
  • Page views (browser monitoring): Unavailable
response.headers.contentType

The outgoing response content-type as read from the Content-Type response header.

Defaults:

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Enabled
  • Page views (browser monitoring): Unavailable
SERVER_NAME

The name of the server host under which the current script is executing.

Defaults

  • Transaction traces: Enabled
  • Error collector (traced errors): Enabled
  • Transaction events: Disabled
  • Page views (browser monitoring): Disabled

Change where attributes are sent

All destinations are open to attribute collection by default in the PHP agent, except newrelic.browser_monitoring.attributes.enabled.

To change which attributes are sent to the APM and Insights destinations:

  1. Open or close any destination to attribute collection by changing the .enabled destination property.

  2. Change the default attribute setting by adding the attribute name to the destination's .include or .exclude properties.

    See Attribute rules for which settings supersede each other.

Upgrading the PHP agent

When upgrading to PHP agent 4.9 or higher, upgrade your configuration file. For more information about deprecated properties, see Enabling and disabling attributes.

For more help

Additional documentation resources include:

Recommendations for learning more: