newrelic_add_custom_parameter

newrelic_add_custom_parameter(string $key, scalar $value)
Attaches a custom attribute (key/value pair) to the current transaction.

Requirements

Agent version 4.4.5.35 or higher.

Description

Add a custom attribute (a key and a value data pair) to the current web transaction. For example, you can add a customer's full name from your customer database. This attribute appears in any transaction trace that results from this transaction. You can also query the Transaction event in Insights for your custom attributes.

If you want to use your custom attributes in Insights, avoid using any of the reserved terms used by NRQL and Insights.

Parameters

Parameter Description

$key

string

Required. The name of the custom attribute. Only the first 255 characters are retained.

$value

scalar

Required. The value to associate with this custom attribute.

If the value given is a float with a value of NaN, Infinity, denorm or negative zero, the behavior of this function is undefined. For other floating point values, the agent may discard 1 or more bits of precision (ULPs) from the given value.

Return value(s)

Returns true if the parameter was added successfully.

Example(s)

Report a variable as the value

...
if (extension_loaded('newrelic')) { // Ensure PHP agent is available
    // Record custom data about this web transaction
    newrelic_add_custom_parameter ('user_email', $user_email);
}
...