Trace and Span Attributes for APM Browser Agent
The trace (root span) and span attributes in Trace Explorer are defined by tagging a span, which enable the effective monitoring of the various tiers of an application.
Attributes are key-value pairs attached to a span to provide additional information and context about the operation performed in the span. A trace has some trace only attributes as well as all the span attributes of the root span.
In Trace Explorer, you can use attributes to query and filter traces and spans. There are two types of attributes: Dimensions (string attributes) and Metrics (numeric attributes) which are available in the Attributes panel in Trace Explorer.
This section provides a complete list of the out-of-the-box attributes applicable to APM Browser agent. The below table includes:
- Name: Name of the attribute.
- Description: Brief description of the attribute.
- Trace/Span: Availability of the attribute. A attribute can be available for traces, spans, or both.
- Type: Type of attribute: Dimension or Metric.
| Name | Description | Trace/Span | Type |
|---|---|---|---|
AggregateCount |
The number of observations grouped together in a single
span. This could be resource-hits or errors, depending on
ApmrumType.
|
Trace and span attribute | Metric |
AjaxCalls |
The number of AJAX calls observed. | Trace and span attribute | Metric |
AjaxDownloadTime |
The time taken to download a response. | Trace and span attribute | Metric |
AjaxErrors |
The number of AJAX errors observed. | Trace and span attribute | Metric |
AjaxFirstByteTime |
The time taken to receive the first byte of an AJAX call response after the request is sent to the server. This is mainly impacted by network latency and server response time. | Trace and span attribute | Metric |
AjaxInitTime |
The time taken to initialize an AJAX request inside the
browser, from the creation of fetch/xhr till the
request is sent.
|
Trace and span attribute | Metric |
AjaxResponseTime |
The time taken to process the AJAX call response, which
is the sum of AjaxInitTime,
AjaxFirstByteTime, and
AjaxDownloadTime.
|
Trace and span attribute | Metric |
ApdexScore |
The mapping of the level of user satisfaction to a
numeric representation that can be aggregated. The value is between
0 for Frustrated and 1 for
Satisfied.
|
Trace and span attribute | Metric |
ApmrumAttribute1 |
A custom attribute that can be configured to report any required value. The default value is populated with the first directory. | Trace and span attribute | Dimension |
ApmrumAttribute2 |
A custom dimension populated with a user-defined value. In some frameworks like Oracle Application Development Framework, a default value is described in documentation. | Trace and span attribute | Dimension |
ApmrumClickElementId |
The xpath representation of the element
clicked in relation to ApmRumType PageUpdate.
|
Trace and span attribute | Dimension |
ApmrumClickElementName |
The text clicked in relation to ApmRumType
PageUpdate. Note that this field is populated only if the
trackScreenText boolean is configured.
|
Trace and span attribute | Dimension |
ApmrumContextType |
The context in which the span is created. For example:
Page, Page Update and
Custom Span.
|
Trace and span attribute | Dimension |
ApmrumLanguage |
The language setting from the browser. | Trace and span attribute | Dimension |
ApmrumPageUpdateType |
The Page Update type. For example: Partial Page
Update, Full Page Update or Page
Load.
|
Trace and span attribute | Dimension |
ApmrumType |
The type of span. For example: Page
Update, Page Load or
Ajax.
|
Trace and span attribute | Dimension |
ApmrumWindowId |
The ID of the active window generating the span. | Trace and span attribute | Dimension |
Component |
The component that generated the span from the
https://opentracing.io/specification/conventions/
standard, with values such as JDBC, SERVLET, and BROWSER.
|
Trace and span attribute | Dimension |
ConnectCount |
The number of connections established. | Trace and span attribute | Metric |
ConnectTime |
The average time taken to establish server connections. | Trace and span attribute | Metric |
DeviceType |
The type of device used by the user. For example, Personal Computer. | Trace and span attribute | Dimension |
DNSLookups |
The number of DNS lookups. | Trace and span attribute | Metric |
DNSTime |
The average time taken to perform DNS lookups. | Trace and span attribute | Metric |
ECID |
The Oracle Execution Context ID. | Span attribute | Dimension |
Error |
The span property that marks a span as "failed" with
boolean value true, in case of an error. This indicates
that the application considered the operation represented by the span
failed. The default boolean value is false (no
error).
|
Trace and span attribute | Dimension |
ErrorLocation |
The location or source of the error, if available. | Trace and span attribute | Dimension |
ErrorMessage |
The description of the error. | Trace and span attribute | Dimension |
ErrorObject |
A human-readable description of the error. | Trace and span attribute | Dimension |
HttpMethod |
The HTTP method used in the request, for example,
GET, POST, and
DELETE.
|
Trace and span attribute | Dimension |
HttpStatusCode |
The HTTP status code of the response, for example,
200, 404, or
500.
|
Trace and span attribute | Dimension |
HttpStatusDetails |
The description of the HTTP response status code. | Trace and span attribute | Dimension |
HttpUrl |
The HTTP URL related to the span. | Trace and span attribute | Dimension |
HttpUrlFragment |
The HTTP URL fragment related to the span. | Trace and span attribute | Dimension |
HttpUrlHost |
The HTTP URL host name related to the span. | Trace and span attribute | Dimension |
HttpUrlPath |
The HTTP URL path related to the span. | Trace and span attribute | Dimension |
HttpUrlQuery |
The HTTP URL query related to the span. | Trace and span attribute | Dimension |
Kind |
The field related to open tracing definition (https://opentracing.io/specification/conventions/)
span.kind0. The Browser agent may report values
such as CLIENT or INTERNAL, and the Java agent and other tracers may
report values such as SERVER for servlets and CLIENT for HttpClient and
JDBC.
|
Trace and span attribute | Dimension |
OperationName |
The name of the span. | Trace and span attribute | Dimension |
PageClicks |
The number of clicks on a page. | Trace and span attribute | Metric |
PageDownloadTime |
The time from the browser sending a request for the page URL till the full content is received. | Trace and span attribute | Metric |
PageFirstByteTime |
The time from the browser sending the request for the page URL till the first byte of response from the server is sent for the page URL. This is mainly impacted by server response time and network latency. | Trace and span attribute | Metric |
PageInitTime |
The time from the browser receiving the navigation trigger till the request for the page URL is started, which includes connection setup time. This time is calculated for Page Loads and Page Updates. | Trace and span attribute | Metric |
PageInteractiveTime |
The time taken for the page to become interactive. | Trace and span attribute | Metric |
PageRenderTime |
The time from the browser receiving full HTML till the content is rendered. | Trace and span attribute | Metric |
PageResponseTime |
The time taken from the beginning of navigation till the
loading of script is complete. This is the sum of
PageInitTime, PageFirstByteTime,
PageDownloadTime, and
PageRenderTime.
|
Trace and span attribute | Metric |
PageViews |
The number of page views. | Trace and span attribute | Metric |
RedirectTime |
The average time spent in handling HTTP redirects. | Trace and span attribute | Metric |
SatisfiedPageViews |
The number of page views with a 'satisfying' performance. | Trace and span attribute | Metric |
ScriptErrors |
The number of JavaScript errors observed. | Trace and span attribute | Metric |
SessionId |
The unique identifier of the session or browser. | Trace and span attribute | Dimension |
SpanID |
The unique identifier for each span. | Span attribute | Dimension |
SSLTime |
The average time taken to establish secure server
connections (as part of ConnectTime).
|
Trace and span attribute | Metric |
StartTime |
The start time of the span. | Span attribute | Metric |
ToleratingPageViews |
The number of page views with a 'tolerable' performance. | Trace and span attribute | Metric |
UserName |
The user name of the end user using the system, or an
identifier that uniquely identifies the user.
For information about username capture and configuration options, see Modify or Disable Default Probe Settings. |
Trace and span attribute | Dimension |
WebApplicationName |
The name of the web application as specified in instrumentation. If no value is specified for this dimension, then "Default WebApp" is assigned. | Trace and span attribute | Dimension |