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

record_custom_metric (Python agent API)


newrelic.agent.record_custom_metric(name, value, application=None)

Records a single custom metric.


This call records a single custom metric. To record a set of metrics, see record_custom_metrics.






Required. Name of the metric.

There are no restrictions on naming formats, but we recommend you use a Custom/ prefix for your custom metric names. This helps you differentiate custom metrics from default-monitored metrics in the our UI, and also helps you troubleshoot if necessary.


int or dict

Required. The numeric value of the metric. Can be an integer, a float, or a dictionary of values. The possible fields for a dictionary are:

  • count
  • total
  • min
  • max
  • sum_of_squares


application object

Optional. The application object corresponding to the app with which you want to associate the metrics. If the application is the default value of None, the agent records the custom metrics to the app associated with the current transaction. Thus, you should provide the application unless this method is used in code for a web transaction or background task.

Return values



Recording a custom metric using the application object

To record custom metrics from a distinct background thread or other code, you must pass the application object corresponding to the application to which the custom metrics are to be reported.

import newrelic.agent
application = newrelic.agent.application()
newrelic.agent.record_custom_metric('Custom/my_favorite_number', 42, application)

View and use custom metrics

To view custom metrics, use metrics and events to search and filter for custom metrics, create customizable charts, and add those charts to New Relic dashboards. You can use our REST API to programmatically retrieve and use custom metric data outside of the UI. It is also possible to create custom metric alert conditions to notify you or your team when your custom metric exceeds specific values.

Copyright © 2024 New Relic Inc.

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