Overview

The RUM Android SDK generates events that have associated metrics and attributes. Metrics are quantifiable values that can be used for measurements related to the event. Attributes are non-quantifiable values used to slice metrics data (group by) in analytics.

Every RUM event has all of the default attributes, for example, the device type (device.type) and user information such as their name (usr.name) and their country (geo.country).

There are additional metrics and attributes that are specific to a given event type. For example, the metric view.time_spent is associated with “view” events and the attribute resource.method is associated with “resource” events.

The following diagram illustrates the RUM event hierarchy:

Application launch

During initialization, the RUM Android SDK creates a view called “ApplicationLaunch”. This view’s start time matches the start of the Android process, and can be used to track your application launch time.

The ApplicationLaunch view includes any logs, actions, and resources created before your first call to startView. Use the duration of this view to determine time to first view. This view has an action, application_start, with a duration that depends on Android version:

• In Android 7.0 and above, this view/action captures the period before any application code is executed (right before Application.onCreate) and when the first RUM event is recorded.
• In versions before Android 7.0, the view/action captures the period between the RumFeature class loads and when the first RUM event is recorded.

Default attributes

RUM collects common attributes for all events and attributes specific to each event listed below automatically. You can also choose to enrich your user session data by tracking additional events or by adding custom attributes to default events specific to your application monitoring and business analytics needs.

Common core attributes

Device

The following device-related attributes are attached automatically to all events collected by Datadog:

Connectivity

The following network-related attributes are attached automatically to Resource and Error events collected by Datadog:

Operating system

The following OS-related attributes are attached automatically to all events collected by Datadog:

Geo-location

The below attributes are related to the geo-location of IP addresses.

Note: If you want to stop collecting geo-location attributes, change the setting in your application details.

Global user attributes

You can enable tracking user info globally to collect and apply user attributes to all RUM events.

Event-specific metrics and attributes

Metrics are quantifiable values that can be used for measurements related to the event. Attributes are non-quantifiable values used to slice metrics data (group by) in analytics.

Session metrics

Session attributes

View metrics

RUM action, error, resource, and long task events contain information about the active RUM view event at the time of collection.

View attributes

Resource metrics

Resource attributes

Error attributes

Front-end errors are collected with Real User Monitoring (RUM). The error message and stack trace are included when available.

Network errors

Network errors include information about failing HTTP requests. The following facets are also collected:

Action timing metrics

Action attributes

Data storage

Before data is uploaded to Datadog, it is stored in cleartext in your application’s cache directory. This cache folder is protected by Android’s Application Sandbox, meaning that on most devices this data can’t be read by other applications. However, if the mobile device is rooted, or someone tempers with the Linux kernel, the stored data might become readable.

Data upload

The RUM Android SDK allows you to get the data you need to Datadog while considering user bandwidth impact. The Datadog SDK batches and uploads events as follows:

• On event collected, the Datadog SDK appends uncompressed events to a batch file (using a tag-length-value, or TLV encoding format)
• On upload (when the batch is considered “closed”), the Datadog SDK:
  • Reads the batch and extract events
  • Drops redundant View events in RUM (no optimizations in other tracks)
  • Builds payloads specific to each track
  • Compresses the payload and sends it

Direct Boot mode support

If your application supports Direct Boot mode, note that data captured before the device is unlocked won’t be captured, since the credential encrypted storage won’t be available yet.

Further Reading

お役に立つドキュメント、リンクや記事:

Source code for dd-sdk-androidSOURCE CODE Explore Datadog RUMDOCUMENTATION