java.lang.Object | |
↳ | com.google.firebase.perf.metrics.HttpMetric |
Metric used to collect data for network requests/responses. A new object must be used for every request/response. This class is not thread safe.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | MAX_ATTRIBUTE_KEY_LENGTH | Maximum allowed length of the Key of the Trace attribute |
|||||||||
int | MAX_ATTRIBUTE_VALUE_LENGTH | Maximum allowed length of the Value of the Trace attribute |
|||||||||
int | MAX_TRACE_CUSTOM_ATTRIBUTES | Maximum allowed number of attributes allowed in a trace. | |||||||||
int | MAX_TRACE_NAME_LENGTH | Maximum allowed length of the name of the Trace |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the value of an attribute.
| |||||||||||
Returns the map of all the attributes added to this HttpMetric.
| |||||||||||
Sets a String value for the specified attribute.
| |||||||||||
Removes an already added attribute from the HttpMetric.
| |||||||||||
Sets the httpResponse code of the request
| |||||||||||
Sets the size of the request payload
| |||||||||||
Content type of the response such as text/html, application/json, etc...
| |||||||||||
Sets the size of the response payload
| |||||||||||
Marks the start time of the request
| |||||||||||
Marks the end time of the response and queues the network request metric on the device for
transmission.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Maximum allowed length of the Key of the Trace
attribute
Maximum allowed length of the Value of the Trace
attribute
Maximum allowed number of attributes allowed in a trace.
Maximum allowed length of the name of the Trace
Returns the value of an attribute.
Parameters | |
---|---|
attribute |
String : name of the attribute to fetch the value for |
Returns | |
---|---|
String |
The value of the attribute if it exists or null otherwise. |
Returns the map of all the attributes added to this HttpMetric.
Returns | |
---|---|
Map<String, String> |
map of attributes and its values currently added to this HttpMetric |
Sets a String value for the specified attribute. Updates the value of the attribute if the
attribute already exists. If the HttpMetric has been stopped, this method returns without
adding the attribute. The maximum number of attributes that can be added to a HttpMetric are
.MAX_TRACE_CUSTOM_ATTRIBUTES
.
Parameters | |
---|---|
attribute |
String : name of the attribute |
value |
String : value of the attribute |
Returns | |
---|---|
void |
true if the attribute was added, false otherwise. |
Removes an already added attribute from the HttpMetric. If the HttpMetric has already been stopped, this method returns without removing the attribute.
Parameters | |
---|---|
attribute |
String : name of the attribute to be removed from the running Traces.
|
Sets the httpResponse code of the request
Parameters | |
---|---|
responseCode |
int : valid values are greater than 0. Invalid usage will be logged.
|
Sets the size of the request payload
Parameters | |
---|---|
bytes |
long : valid values are greater than or equal to 0. Invalid usage will be logged.
|
Content type of the response such as text/html, application/json, etc...
Parameters | |
---|---|
contentType |
String : valid string of MIME type. Invalid usage will be logged.
|
Sets the size of the response payload
Parameters | |
---|---|
bytes |
long : valid values are greater than or equal to 0. Invalid usage will be logged.
|
Marks the start time of the request
Marks the end time of the response and queues the network request metric on the device for transmission. Check logcat for transmission info.