Lynx
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

profileStart()

Marks the start of a trace event.

Syntax

profileStart(name: string, option?: { flowId: number, arg?:  Record<string, string>}): void;

Parameters

name

The name of the trace event.

option(optional)

Additional options such as flowId and custom arguments.

Examples

// Start a trace event with only a name
lynx.performance.profileStart('DataFetch');

// Start a trace event with custom arguments
lynx.performance.profileStart('DataFetch', {
  args: { url: 'https://api.example.com/data', method: 'GET' },
});

// Start a trace event with a flow id
const flowId = lynx.performance.profileFlowId();
lynx.performance.profileStart('UserAction', { flowId });

// Start a duration event with both arguments and flow ID
lynx.performance.profileStart('ComplexProcess', {
  args: { step: 'start' },
  flowId,
});

Compatibility

LCD tables only load in the browser

Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.