Syntax
newrelic.agent.record_custom_event(event_type, params, application=None)Records a custom event for use in querying
Requirements
Python agent version 2.60.0.46 or higher.
Description
This records a custom event that can be viewed and queried in the New Relic UI. If you want to use this outside of the context of a monitored transaction, use the application parameter.
For custom machine learning events, see the record_ml_event page for more information.
Important
For limits and restrictions on event_type and params, see Limits and restricted characters and Reserved words.
Important
This setting is disabled when high security mode is enabled.
Parameters
Parameter | Description |
|---|---|
string | Required. The |
dict | Required. Attaches custom attributes to the event. Only attributes passed in as |
object | Optional. If you want to record an event outside of the context of a monitored transaction, use this to associate the call with a specific application object. An application object can be obtained using the |
Return values
None.
Examples
Record custom event in background task
Here's an example of recording a custom event associated with a background task:
@newrelic.agent.background_task() def bg_task(): # do some type of work in this background task... application = newrelic.agent.application() newrelic.agent.record_custom_event('your_event_type', {'param1':'value1'}, application)Create a killed-query custom event
An example of creating a killed-query custom event inside a database-logging function:
application = newrelic.agent.register_application(timeout=10)
def task_runner(): event_type = "Killed_Query" params = {'query_info':'select * from all_things;', 'killed_time': '2016-05-18 00:59:00', 'host': 'my_host'} newrelic.agent.record_custom_event(event_type, params, application=application)