Class Trace

Returns the value of an attribute. Returns null if it does not exist.

Example

const attribute = trace.getAttribute('userId');
Copy

Gets the value of the metric with the given name in the current trace. If the metric doesn't exist, it will not be created and a 0 is returned.

Example

const metric = trace.getMetric('hits');
Copy

Returns an object of all the currently added metrics and their number values.

Example

const metrics = trace.getMetrics();

metrics.forEach(($) => {
  console.log($);
});
Copy

Increments the named metric by the incrementBy value.

If a metric with the given name doesn't exist, a new one will be created starting with the value of incrementBy.

trace.incrementMetric('hits', 1);
Copy

Sets a String value for the specified attribute. Updates the value of the attribute if it already exists. The maximum number of attributes that can be added is 5.

Example

trace.putAttribute('userId', '123456789');
Copy

Sets the value of the named metric with the provided number.

If a metric with the given name exists it will be overwritten. If a metric with the given name doesn't exist, a new one will be created.

Example

trace.putMetric('hits', 1);
Copy

Removes a metric by name if it exists.

Example

trace.removeMetric('hits');
Copy

Marks the start time of the trace. Does nothing if already started.

Example

const trace = firebase.perf().newTrace('example');
await trace.start();
Copy

Marks the end time of the trace and queues the metric on the device for transmission. Does nothing if already stopped.

• Example

const trace = firebase.perf().newTrace('example');
await trace.start();
trace.putMetric('hits', 1);
await trace.stop();
Copy