Class HttpMetric

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

Example

const attribute = metric.getAttribute('user_role');
Copy

Returns an object of all the currently added attributes.

Example

const attributes = metric.getAttributes();

attributes.forEach(($) => {
  console.log($);
});
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

metric.putAttribute('user_role', 'admin');
Copy

Removes an already added attribute. Does nothing if attribute does not exist.

Example

metric.removeAttribute('user_role');
Copy

Sets the httpResponse code of the request.

Example

const response = await fetch(url);
metric.setHttpResponseCode(response.status);
Copy

This is required for every request, if you do not provide this your metric will not be captured.

Sets the size of the request payload.

Example

const response = await fetch(url);
metric.setRequestPayloadSize(response.headers.get('Content-Type'));
Copy

Content type of the response e.g. text/html or application/json.

Example

const response = await fetch(url);
metric.setResponsePayloadSize(response.headers.get('Content-Type'));
Copy

Sets the size of the response payload.

Example

const response = await fetch(url);
metric.setResponsePayloadSize(response.headers.get('Content-Length'));
Copy

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

Example

const metric = firebase.perf().newHttpMetric('https://api.com/login', 'POST');
await metric.start();
Copy

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

Example

const metric = firebase.perf().newHttpMetric('https://api.com/login', 'POST');
await metric.start();
metric.putAttribute('user_role', 'admin');
await metric.stop();
Copy