RUM Browser Data Collected
Overview
The RUM Browser SDK generates events that have associated metrics and attributes. Every RUM event has all of the default attributes, for example, the URL of the page (view.url) and user information such as their device type (device.type) and their country (geo.country).
There are additional metrics and attributes specific to a given event type. For example, the view.loading_time metric is associated with view events, and the resource.method attribute is associated with resource events.
| Event Type | Retention | Description |
|---|
| Session | 30 days | A user session begins when a user starts browsing the web application. It contains high-level information about the user (browser, device, geo-location). It aggregates all RUM events collected during the user journey with a unique session.id attribute. Note: The session resets after 15 minutes of inactivity. |
| View | 30 days | A view event is generated each time a user visits a page of the web application. While the user remains on the same page, resource, long-task, error, and action events are linked to the related RUM view with the view.id attribute. |
| Resource | 15 days | A resource event is generated for images, XHR, Fetch, CSS, or JS libraries loaded on a webpage. It includes detailed loading timing information. |
| Long Task | 15 days | A long task event is generated for any task in the browser that blocks the main thread for more than 50ms. |
| Error | 30 days | RUM collects every frontend error emitted by the browser. |
| Action | 30 days | RUM action events track user interactions during a user journey and can also be manually sent to monitor custom user actions. |
The following diagram illustrates the RUM event hierarchy:
Default attributes
Each of these event types has the following attributes attached by default, so you can use them regardless of the RUM event type being queried.
Core
| Attribute name | Type | Description |
|---|
type | string | The type of the event (for example, view or resource). |
application.id | string | The Datadog application ID generated when you create a RUM application. |
application.name | string | The name of your Datadog application. |
service | string | A service denotes a set of pages built by a team that offers a specific functionality in your browser application. You can assign web pages to a service with manual view tracking. |
View attributes
RUM action, error, resource, and long task events contain information about the active RUM view event at the time of collection:
| Attribute name | Type | Description |
|---|
view.id | string | Randomly generated ID for each page view. |
view.loading_type | string | The type of page load: initial_load or route_change. For more information, see the single page applications support docs. |
view.referrer | string | The URL of the previous web page from which a link to the currently requested page was followed. |
view.url | string | The view URL. |
view.url_hash | string | The hash part of the URL. |
view.url_host | string | The host part of the URL. |
view.url_path | string | The path part of the URL. |
view.url_path_group | string | The automatic URL group generated for similar URLs (for example, /dashboard/? for /dashboard/123 and /dashboard/456). |
view.url_query | object | The query string parts of the URL decomposed as query params key/value attributes. |
view.url_scheme | object | The scheme part of the URL. |
Device
The following device-related attributes are attached automatically to all events collected by Datadog:
| Attribute name | Type | Description |
|---|
device.type | string | The device type as reported by the device (User-Agent HTTP header). |
device.brand | string | The device brand as reported by the device (User-Agent HTTP header). |
device.model | string | The device model as reported by the device (User-Agent HTTP header). |
device.name | string | The device name as reported by the device (User-Agent HTTP header). |
Connectivity
The following network-related attributes are attached automatically to all events collected by Datadog:
| Attribute name | Type | Description |
|---|
connectivity.status | string | Status of device network reachability (connected or not connected). |
connectivity.interfaces | array | The list of available network interfaces (for example, bluetooth, cellular, ethernet, or wifi). |
connectivity.effective_type | string | Effective connection type, reflecting the measured network performance (slow-2g, 2g, 3g, or 4g). |
Operating system
The following OS-related attributes are attached automatically to all events collected by Datadog:
| Attribute name | Type | Description |
|---|
os.name | string | The OS name as reported by the device (User-Agent HTTP header). |
os.version | string | The OS version as reported by the device (User-Agent HTTP header). |
os.version_major | string | The OS version major as reported by the device (User-Agent HTTP header). |
Geo-location
The following attributes are related to the geo-location of IP addresses:
| Fullname | Type | Description |
|---|
geo.country | string | Name of the country. |
geo.country_iso_code | string | ISO Code of the country (for example, US for the United States or FR for France). |
geo.country_subdivision | string | Name of the first subdivision level of the country (for example, California in the United States or the Sarthe department in France). |
geo.continent_code | string | ISO code of the continent (EU, AS, NA, AF, AN, SA, OC). |
geo.continent | string | Name of the continent (Europe, Australia, North America, Africa, Antarctica, South America, Oceania). |
geo.city | string | The name of the city (for example, Paris or New York). |
Note: By default, Datadog stores the client IP address. Learn more about how to manage automatic user data collection in Real User Monitoring Data Security.
User attributes
In addition to default attributes, you can add user-related data to all RUM event types by identifying user sessions. This lets you follow the journey of a given user, figure out which users are the most impacted by errors, and monitor performance for your most important users.
Feature flag attributes
You can enrich your RUM event data with feature flags to get additional context and visibility into performance monitoring. This lets you determine which users are shown a specific user experience and if it is negatively affecting the user’s performance.
Event-specific metrics and attributes
Session metrics
| Metric | Type | Description |
|---|
session.time_spent | number (ns) | Duration of the user session. |
session.view.count | number | Count of all views collected for this session. |
session.error.count | number | Count of all errors collected for this session. |
session.resource.count | number | Count of all resources collected for this session. |
session.action.count | number | Count of all actions collected for this session. |
session.long_task.count | number | Count of all long tasks collected for this session. |
Session attributes
| Attribute name | Type | Description |
|---|
session.id | string | Randomly generated ID for each session. |
session.ip | string | Client IP address. If you want to stop collecting this attribute, change the setting in your application details. |
session.is_active | boolean | Indicates if the session is currently active. The session ends after 4 hours of activity or 15 minutes of inactivity. |
session.type | string | The type of session: user or synthetics. Sessions from Synthetic Monitoring Browser Tests are excluded from billing. |
session.referrer | string | The URL of the previous web page from which a link to the currently requested page was followed. |
session.initial_view.id | string | The ID of the first RUM view generated by the user. |
session.initial_view.url_host | string | The host part of the URL. |
session.initial_view.url_path | string | The path part of the URL. |
session.initial_view.url_path_group | string | The automatic URL group generated for similar URLs (for example, /dashboard/? for /dashboard/123 and /dashboard/456). |
session.initial_view.url_query | object | The query string parts of the URL decomposed as query params key/value attributes. |
session.initial_view.url_scheme | object | The scheme part of the URL. |
session.last_view.id | string | The ID of the last RUM view generated by the user. |
session.last_view.url_host | string | The host part of the URL. |
session.last_view.url_path | string | The path part of the URL. |
session.last_view.url_path_group | string | The automatic URL group generated for similar URLs (for example, /dashboard/? for /dashboard/123 and /dashboard/456). |
session.last_view.url_query | object | The query string parts of the URL decomposed as query params key/value attributes. |
session.last_view.url_scheme | object | The scheme part of the URL. |
View timing metrics
Note: View timing metrics include time that a page is open in the background.
| Attribute | Type | Description |
|---|
view.time_spent | number (ns) | Time spent on the current view. |
view.first_byte | number (ns) | Time elapsed until the first byte of the view has been received. |
view.largest_contentful_paint | number (ns) | Time in the page load where the largest DOM object in the viewport (visible on screen) is rendered. |
view.largest_contentful_paint_target_selector | string (CSS selector) | CSS Selector of the element corresponding to the largest contentful paint. |
view.first_input_delay | number (ns) | Time elapsed between a user’s first interaction with the page and the browser’s response. |
view.first_input_delay_target_selector | string (CSS selector) | CSS selector of the first element the user interacted with. |
view.interaction_to_next_paint | number (ns) | Longest duration between a user’s interaction with the page and the next paint. |
view.interaction_to_next_paint_target_selector | string (CSS selector) | CSS selector of the element associated with the longest interaction to the next paint. |
view.cumulative_layout_shift | number | Quantifies unexpected page movement due to dynamically loaded content (for example, third-party ads) where 0 means that no shifts are happening. |
view.cumulative_layout_shift_target_selector | string (CSS selector) | CSS selector of the most shifted element contributing to the page CLS. |
view.loading_time | number (ns) | Time until the page is ready and no network request or DOM mutation is currently occurring. More info from Monitoring Page Performance. |
view.first_contentful_paint | number (ns) | Time when the browser first renders any text, image (including background images), non-white canvas, or SVG. For more information about browser rendering, see the w3c definition. |
view.dom_interactive | number (ns) | Time until the parser finishes its work on the main document. More info from the MDN documentation. |
view.dom_content_loaded | number (ns) | Time until the load event is fired and the initial HTML document is completely loaded and parsed, without waiting for non-render blocking stylesheets, images, and subframes to finish loading. More info from the MDN documentation. |
view.dom_complete | number (ns) | Time until the page and all of the subresources are ready. The loading spinner has stopped spinning for the user. More info from the MDN documentation. |
view.load_event | number (ns) | Time until the load event is fired, indicating the page is fully loaded. Usually a trigger for additional application logic. More info from the MDN documentation. |
view.error.count | number | Count of all errors collected for this view. |
view.long_task.count | number | Count of all long tasks collected for this view. |
view.resource.count | number | Count of all resources collected for this view. |
view.action.count | number | Count of all actions collected for this view. |
Resource timing metrics
Detailed network timing data for the loading of an application’s resources are collected with the Performance Resource Timing API.
| Metric | Type | Description |
|---|
duration | number | Entire time spent loading the resource. |
resource.size | number (bytes) | Resource size. |
resource.connect.duration | number (ns) | Time spent establishing a connection to the server (connectEnd - connectStart). |
resource.ssl.duration | number (ns) | Time spent for the TLS handshake. If the last request is not over HTTPS, this metric does not appear (connectEnd - secureConnectionStart). |
resource.dns.duration | number (ns) | Time spent resolving the DNS name of the last request (domainLookupEnd - domainLookupStart). |
resource.redirect.duration | number (ns) | Time spent on subsequent HTTP requests (redirectEnd - redirectStart). |
resource.first_byte.duration | number (ns) | Time spent waiting for the first byte of response to be received (responseStart - RequestStart). |
resource.download.duration | number (ns) | Time spent downloading the response (responseEnd - responseStart). |
Resource attributes
| Attribute | Type | Description |
|---|
resource.type | string | The type of resource being collected (for example, css, javascript, media, XHR, or image). |
resource.method | string | The HTTP method (for example POST or GET). |
resource.status_code | number | The response status code (available for fetch/XHR resources only). |
resource.url | string | The resource URL. |
resource.url_host | string | The host part of the URL. |
resource.url_path | string | The path part of the URL. |
resource.url_query | object | The query string parts of the URL decomposed as query params key/value attributes. |
resource.url_scheme | string | The protocol name of the URL (HTTP or HTTPS). |
resource.provider.name | string | The resource provider name. Default is unknown. |
resource.provider.domain | string | The resource provider domain. |
resource.provider.type | string | The resource provider type (for example, first-party, cdn, ad, or analytics). |
Long task timing metrics
| Metric | Type | Description |
|---|
long_task.duration | number | Duration of the long task. |
Error attributes
| Attribute | Type | Description |
|---|
error.source | string | Where the error originates from (for example, console). See Error sources. |
error.type | string | The error type (or error code in some cases). |
error.message | string | A concise, human-readable, one-line message explaining the event. |
error.stack | string | The stack trace or complementary information about the error. |
Source errors
Source errors include code-level information about the error. For more information about different error types, see the MDN documentation.
| Attribute | Type | Description |
|---|
error.type | string | The error type (or error code in some cases). |
Action timing metrics
| Metric | Type | Description |
|---|
action.loading_time | number (ns) | The loading time of the action. See how it is calculated in the Tracking User Actions documentation. |
action.long_task.count | number | Count of all long tasks collected for this action. |
action.resource.count | number | Count of all resources collected for this action. |
action.error.count | number | Count of all errors collected for this action. |
Action attributes
| Attribute | Type | Description |
|---|
action.id | string | UUID of the user action. |
action.type | string | Type of the user action. For Custom User Actions, it is set to custom. |
action.target.name | string | Element that the user interacted with. Only for automatically collected actions. |
action.name | string | User-friendly name created (for example, Click on #checkout). For Custom User Actions, the action name given in the API call. |
Frustration signals fields
| Field | Type | Description |
|---|
session.frustration.count | number | Count of all frustration signals associated with one session. |
view.frustration.count | number | Count of all frustration signals associated with one view. |
action.frustration.type:dead_click | string | The dead clicks detected by the RUM Browser SDK. |
action.frustration.type:rage_click | string | The rage clicks detected by the RUM Browser SDK. |
action.frustration.type:error_click | string | The error clicks detected by the RUM Browser SDK. |
UTM attributes
| Field | Type | Description |
|---|
view.url_query.utm_source | string | The parameter in the URL tracking the source of traffic. |
view.url_query.utm_medium | string | The parameter in the URL tracking the channel where the traffic is coming from. |
view.url_query.utm_campaign | string | The paramter in the URL identifying the specific marketing campaign tied to that view. |
view.url_query.utm_content | string | The paramter in the URL identifying the specific element a user clicked within a marketing campaign. |
view.url_query.utm_term | string | The parameter in the URL tracking the keyword a user searched to trigger a given campaign. |
Further Reading
Additional helpful documentation, links, and articles:
