• Log inFree account

newrelic_record_custom_event (PHP agent API)

Syntax

newrelic_record_custom_event(string $name, array $attributes)

Record a custom event with the given name and attributes.

Requirements

Agent version 4.18.0.89 or higher.

Description

Records a custom event for use in New Relic. For more information, see Inserting custom events with the PHP agent.

Tip

When creating custom events, follow these rules:

  • The agent records a maximum of 10,000 events per minute. Limit the number of unique event type names that you create, and do not generate these names dynamically.
  • Avoid using reserved words and characters for the event and attributes names.
  • Ensure you do not exceed the event size and rate restrictions.

Parameters

Parameter

Description

$name

string

Required. Name of the custom event.

$attributes

array

Required. Supply custom attributes as an associative array. Supply the attribute names as keys of up to 255 characters, and supply the values as scalar values. Arrays and objects are not supported.

Examples

Basic example

if (extension_loaded('newrelic')) { // Ensure PHP agent is available
newrelic_record_custom_event("WidgetSale", array("color"=>"red", "weight"=>12.5));
}
Copyright © 2022 New Relic Inc.