record_custom_metrics

For general information on how the Python agent API calls relate to each other, see the API guide.

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

metrics

iterable object

Required. Set of metric values, which can be in the form of any iterable object that yields (name, value) tuples. See record_custom_metric parameters for more information about name and value rules and suggestions.

application

string

Optional. If the application is the default value of None, the agent associates the custom metrics with the parent app of the current transaction. Thus, you should provide the application unless this method is used in code for a web transaction or background task.

Return value(s)

None.

Example(s)

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())

For more help

Recommendations for learning more: