Skip to content

UniApp Application Data Collection

Introduction

UniApp data collection relies on the Android/iOS native frameworks. For comparison with Android/iOS data collection, features marked with strikethrough below are not implemented.

Data Types

Guance Real User Monitoring (RUM) includes six data types.

Type Description
session Records user session information. Within the current session, it collects user page, resource, action, error, and long task access data based on the session dimension.
view Each time a user visits a page in the mobile application, a view record is generated. When the user stays on the same page, resource, long task, error, and action records are linked to the related RUM view via the view_id attribute.
resource Records information about resources loaded when a user visits a page.
error Exceptions or crashes emitted by the mobile application.
long_task A long task event is generated for any task that blocks the main thread for longer than the specified duration threshold in the application.
action Records user activities in the mobile application (app launch, click, swipe, back, etc.). Each action is attached with a unique action_id.

Global Attributes

Both scenario construction and event alerting in RUM can be queried using the following global attributes.

SDK Attributes

Field Type Description
sdk_name string Collector name, fixed values:
df_macos_rum_sdk
df_linux_rum_sdk
df_windows_rum_sdk
df_web_rum_sdk
df_miniapp_rum_sdk
df_ios_rum_sdk
df_android_rum_sdk
sdk_version string Collector version information

Application Attributes

Field Type Description
app_id string Required, unique ID identifying the user-accessed application. Automatically generated when creating a monitor in the Guance console.
env string Required, environment field. Attribute values: prod/gray/pre/common/local. Where:
prod: Production environment
gray: Canary environment
pre: Pre-release environment
common: Daily environment
local: Local environment
version string Required, version number.
service string Optional, name of the service or business to which it belongs. Fixed values:
df_rum_ios
df_rum_android
df_rum_windows
df_rum_linux

User & Session Attributes

Field Type Description
userid string For unauthenticated users, a random UUID is used as userid; for authenticated users, the user ID generated by the application backend is used.
user_name string Optional, user name.
user_email string Optional, user email.
session_id string Session ID. A new session_id is generated after 15 minutes of inactivity.
session_type string Session type. Reference values: user & synthetics
user: Data generated by the RUM feature;
synthetics: Data generated by headless synthetic tests.
is_signin boolean Whether the user is a registered user. Attribute values: T & F.

Device & Screen Resolution Attributes

Field Type Description
device string Mobile device manufacturer
model string Mobile device model
device_uuid string Unique mobile device ID. Generated using Android: ANDROID_ID, iOS: UIDevice.identifierForVendor
os string Operating system information
os_version string Operating system version
os_version_major string Major operating system version
screen_size string Screen resolution

Geographic & Network Attributes

Field Type Description
ip string User access IP address
isp string Internet service provider
network_type string Network connection type. Reference values: wifi | 2g | 3g | 4g | 5g | unknown (unknown network) | unreachable (network unreachable)
country string Country
country_iso_code string Country ISO code
province string Province
city string City

Custom Attributes

In addition to global attributes, you can also use custom attributes (the SDK supports user-defined custom tag data) to build scenarios and configure event alerts. Custom attributes are non‑global attributes. Through custom attributes, you can track the entire process of user access in the application, locate and identify affected user access patterns, and monitor user access performance.

Other Data Type Attributes

Session

Attributes

Field Type Description
session_id string Session ID
session_type string Session type. Reference values: user & test
user: Data generated by the RUM feature;
test: Data generated by headless synthetic tests.
session_referrer string Session source. Typically records the page URL from which the source originated.
session_first_view_id string The view_id of the first page in the current session
session_first_view_name string The URL of the first page in the current session
session_last_view_id string The view_id of the last page visited in the current session
session_last_view_name string The URL of the last page in the current session

Metrics

Field Type Description
time_spent number (ns) Duration of the current session
session_view_count number Number of view_id values associated with the current session
session_error_count number Number of errors generated in the current session
session_resource_count number Number of resources loaded in the current session
session_action_count number Number of user actions in the current session
session_long_task_count number Number of long tasks generated in the current session

View

Attributes

Field Type Description
view_id string Unique ID generated each time a page is visited
view_referrer string Page source, the parent page of the current page
view_name string Page name

Metrics

Field Type Description
loading_time number (ns) Page load time
time_spent number (ns) Time spent on the page
is_active boolean Indicates whether the user is still active. Reference values: true & false

Cumulative Metrics

Field Type Description
view_error_count number Number of errors occurring during each page load
view_resource_count number Number of resources requested during each page load
view_long_task_count number Number of long tasks generated during each page load
view_action_count number Number of actions during page view

Monitoring Metrics

Field Type Description
cpu_tick_count number Optional, CPU tick count of the page
cpu_tick_count_per_second number Optional, average CPU ticks per second
fps_avg number Optional, average frames per second of the page
fps_mini number Optional, minimum frames per second of the page
memory_avg number Optional, average memory usage of the page
memory_max number Optional, peak memory usage of the page

Resource

View Attributes

Field Type Description
view_id string Unique ID generated each time a page is visited
view_referrer string Page source, the parent page of the current page
view_name string Page name

Action Attributes

Field Type Description
action_id string Unique ID generated when the user performs an action on the page
action_name string Action name
action_type string Action type (cold/hot launch, click, etc.)

Resource Attributes

Field Type Description
resource_url string Resource URL
resource_url_host string Domain part of the resource URL
resource_url_path string Path part of the resource URL
resource_url_query string Query part of the resource URL
resource_url_path_group string Resource URL path grouping
resource_type string Resource category
resource_method string Resource request method
resource_status string Status value returned by the resource request
resource_status_group string Status group value returned by the resource request

Metrics

Field Type Description
resource_size number Resource size, default unit: byte
resource_dns number (ns) DNS resolution time for resource loading
Calculation: domainLookupEnd - domainLookupStart
resource_tcp number (ns) TCP connection time for resource loading
Calculation: connectEnd - connectStart
resource_ssl number (ns) SSL connection time for resource loading
Calculation: connectEnd - secureConnectStart
resource_ttfb number (ns) Time to first byte for resource loading
Calculation: responseStart - requestStart
resource_trans number (ns) Content transfer time for resource loading
Calculation: responseEnd - responseStart
resource_first_byte number (ns) First packet time for resource loading
Calculation: responseStart - domainLookupStart
duration number (ns) Resource loading time
Calculation: duration(responseEnd - startTime)
request_header string Resource request header
response_header string Resource response header

Error

View Attributes

Field Type Description
view_id string Unique ID generated each time a page is visited
view_referrer string Page source, the parent page of the current page
view_name string Page name

Action Attributes

Field Type Description
action_id string Unique ID generated when the user performs an action on the page
action_name string Action name
action_type string Action type (cold/hot launch, click, etc.)

Error Attributes

Field Type Description
error_source string Error source. Reference values: logger | network
error_type string Error type
logger error type: java_crash | ios_crash
network error type: network_error
error_situation string Timing of the error occurrence. Reference values: startup (during startup) and run (during runtime)

When type=network, the following Network Error attributes are added.

Field Type Description
resource_status string Status value returned by the resource request
resource_url string Resource URL
resource_url_host string Domain part of the resource URL
resource_url_path string Path part of the resource URL
resource_url_path_group string Resource URL path grouping
resource_method string Resource request method

Error Monitoring Attributes

Field Type Description
memory_total string Optional, total memory
memory_use number Optional, memory usage percentage
cpu_use number Optional, CPU usage percentage
battery_use number Optional, current phone battery level
locale string Current system language

Metrics

Field Type Description
error_message string Error message
error_stack string Error stack trace

Long Task

View Attributes

Field Type Description
view_id string Unique ID generated each time a page is visited
view_referrer string Page source, the parent page of the current page
view_name string Page name

Action Attributes

Field Type Description
action_id string Unique ID generated when the user performs an action on the page
action_name string Action name
action_type string Action type (cold/hot launch, click, etc.)

Metrics

Field Type Description
duration number (ns) Jank duration
long_task_message string Jank message
long_task_stack string Jank stack trace

Action

View Attributes

Field Type Description
view_id string Unique ID generated each time a page is visited
view_referrer string Page source, the parent page of the current page
view_name string Page name

Action Attributes

Field Type Description
action_id string Unique ID generated when the user performs an action on the page
action_name string Action name
action_type string Action type (cold/hot launch, click, etc.)

Metrics

Field Type Description
duration number (ns) Time spent on the page action

Cumulative Metrics

Field Type Description
action_long_task_count number Number of long tasks associated with the action
action_resource_count number Number of resource requests associated with the action
action_error_count number Number of errors associated with the action

Feedback

Is this page helpful?