• EnglishEspañol日本語한국어Português
  • Log inStart now

newrelic_add_custom_span_parameter (PHP agent API)


newrelic_add_custom_span_parameter(string $key, scalar $value)

Attaches a custom attribute (key/value pair) to the current span.


Agent version or higher.


Add a custom attribute (a key and a value data pair) to the current span. (The call name is newrelic_add_custom_span_parameter because "custom attributes" were previously called "custom parameters.") For example, you can add a customer's full name from your customer database. This attribute appears in any span. You can also query the Span for your custom attributes.


On spans, attributes added with newrelic_add_custom_span_parameter will take precedence over attributes added with newrelic_add_custom_parameter.


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






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



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 values

Returns true if the parameter was added successfully.


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_span_parameter ('user_email', $user_email);
Copyright © 2024 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.