Adds a custom attribute to a span event.
Attributes may be found in Distributed Tracing or in APM if a transaction trace is created by the parent transaction. Attributes can also be found and queried in New Relic One.
Before you create custom attributes, review our list of reserved terms used by NRQL.
Required. The key name. Only the first 255 characters are retained.
string, integer, float, boolean
Required. The string value to add to the current span event. Only the first 255 characters are retained.
True if attribute was added successfully.
An example of adding custom attributes to a background task:
@newrelic.agent.background_task()def send_request():with newrelic.agent.FunctionTrace(name='Trace'):newrelic.agent.add_custom_span_attribute('attribute', 'value')
You can also use custom attributes to troubleshoot performance issues. For example, you might see occasional slow response times from a pool of memcache instances, but you don't know what instance is causing the problem. You might add an attribute to the span indicating the server, like so:
# Set server_ip to be the current server processing the transactionnewrelic.agent.add_custom_span_attribute("memcache_query_frontend_lookup", server_ip)
If you need more help, check out these support and learning resources:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's data security and licenses documentation.