Syntax
newrelic.agent.record_custom_metrics(metrics, application=None)
Records a set of custom metrics.
Description
This call records a set of custom metrics. To record a single custom metric, see record_custom_metric
.
The passed metrics can be any iterable object that yields (name, value)
tuples. For example:
def metrics(): yield "Custom/Value-1", 1 yield "Custom/Value-2", 2 yield "Custom/Value-3", 3
newrelic.agent.record_custom_metrics(metrics())
There are no restrictions on setting the name, but it's recommended you use a Custom/
prefix. The custom metric value can be a numeric, or can be a dictionary corresponding to an already-aggregated data sample. For more about the name
and value
rules, see record_custom_metric
.
Parameters
Parameter | Description |
---|---|
iterable object | Required. Set of metric values, which can be in the form of any iterable object that yields |
string | Optional. If the application is the default value of |
Return values
None.
Examples
Recording custom metrics
def metrics(): yield 'Custom/Value-1', 1 yield 'Custom/Value-2', 2 yield 'Custom/Value-3', 3
newrelic.agent.record_custom_metrics(metrics())
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.