callable_name

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

newrelic.agent.callable_name(object, separator=':')
Returns a string name identifying the supplied object.

Description

This call returns a string name identifying the supplied object. This is often used to programmatically name function traces.

Parameters

Parameter Description

object

function, class, or member function

Required. The type of object supplied.

separator

string

Optional. Used for overriding the default : separator. By default, the separator between the module path and the object path is :. The convention used by the New Relic Python agent is : so that it is clear which part is the module name and which is the name of the object.

Return value(s)

Returns a string name identifying the supplied object.

The returned name will be in the form module:object_path. If the object supplied is a function, then the name returned would be in the form module:function. If the object is a class, the form would be module:class. If a member function, the form would be module:class.function.

Example(s)

Set name for function trace

Here's an example of using callable_name to set the name of a function trace:

name = callable_name(func)

with FunctionTrace(txn, name):
    func()

For more help

Recommendations for learning more: