Create custom New Relic events

5 min

Measure what you need by creating your own event types.

Whereas adding custom attributes adds metadata to an existing event, a custom event creates an entirely new event type. Create custom events to define, visualize, and get alerts on additional data, just as you would with any data we provide from our core agents.

Custom events can be inserted through the Agent APIs or directly via the Insights Insert API. The following example shows how to send a custom event named CLIRun that tracks when a command line tool written in Ruby has its process exit due to an exception.

# Hook into the runtime 'at_exit' event
at_exit do
# Name the custom event
payload = { 'eventType' => 'CLIRun' }
# Check to see if the process is exiting due to an error
if $!.nil? || $!.is_a?(SystemExit) && $!.success?
payload[:status] = 0
# Gather any known errors
errors = ""
(Thread.current[:errors] ||= []).each do |err|
errors += "#{err}\n"
payload[:errors] = errors
# Send the errors to New Relic as a custom event
insights_url = URI.parse("")
headers = { "x-insert-key" => "YOUR_API_KEY", "content-type" => "application/json" }
http =, insights_url.port)
http.use_ssl = true
request =, headers)
request.body = payload.to_json
puts "Sending run summary to Insights: #{payload.to_json}"
response = http.request(request)
puts "Response from Insights: #{response.body}"
rescue Exception => e
puts "There was an error posting to Insights. Error: #{e.inspect}"

Here, a NRQL query retrieves information about the custom event, and the result can be added to a dashboard.

nrql query example

SELECT count(*) FROM CLIRun FACET errors SINCE 1 week ago

Learn more about custom events.

Page last modified on June 28, 2020