addToTrace

Syntax

newrelic.addToTrace(JavaScript object $custom_object)

Adds a JavaScript object with a custom name, start time, etc. to an in-progress session trace.

Requirements

• Browser Pro or Pro+SPA agent (v593 or higher)

• If you're using npm to install the browser agent, you must enable the session_trace feature when instantiating the BrowserAgent class. In the features array, add the following:

  import { SessionTrace } from '@newrelic/browser-agent/features/session_trace';
  
  const options = {
    info: { ... },
    loader_config: { ... },
    init: { ... },
    features: [
      SessionTrace
    ]
  }

  Copy

  For more information, see the npm browser installation documentation.

Description

Custom events within browser session traces can provide context for other user actions, errors, and default events within the trace. This event will appear in the browser session trace details.

• If a session trace currently is in progress, this adds an object with a user-defined name, start time, and other optional fields.
• If you make this call and a session trace is not already in progress, this will not cause browser to capture a trace.

Note that the number of events shared this way is limited by the Browser agent harvest cycle. Here is the last update on that limit.

Parameters

Examples

var obj = {
  // REQUIRED
  name: 'Event Name',
  start: 1417044274239, // Time in ms since epoch

  // OPTIONAL
  end: 1417044274252,
  // Time in ms since epoch. Defaults to same as start resulting in trace object with a duration of zero.
  origin: 'Origin of event',
  // Defaults to empty string
};