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

add_custom_attributes (Python agent API)

Syntax

newrelic.agent.add_custom_attributes(items)

Adds multiple custom attributes to a transaction.

Description

This call records one or more custom attributes (a key/value tuple attached to your transaction).

Attributes may be found in APM if the transaction is associated with an error or if a transaction trace is generated for that transaction. Attributes can also be found and queried in the New Relic UI.

Important

Before you create custom attributes, review our list of reserved terms used by NRQL.

Attributes

Attribute

Description

items

list

Required. Each item in the list must be a tuple, with the first element being a key, and the second its value. Each key is a string representing the name of an attribute, and each corresponding value is the value to add to the current transaction for this attribute. Values can be int, float, string, or boolean. Only the first 255 characters are retained for both keys and values.

Return values

Returns True if all attributes were added successfully.

Examples

Adding custom attributes to background task

An example of adding custom attributes to a background task:

@newrelic.agent.background_task()
def send_request():
response = requests.get("http://example.com")
newrelic.agent.add_custom_attributes(
[("url_path_status_code", response.status_code)]
)

Using custom attributes to troubleshoot

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 transaction indicating the server, like so:

# Set server_ip to be the current server processing the transaction
newrelic.agent.add_custom_attributes([
("memcache_query_frontend_lookup", server_ip)
])
Copyright © 2024 New Relic Inc.

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