Skip to content

iOS/tvOS Application Data Collection

Application data collected by Guance can be customized for configuration scenarios and anomaly detection events through the Guance console.

Data Types

Guance's user access monitoring includes six types of data:

Type Description
session Records user session information. During the current session, session-based user page, resource, action, error, and long task related access data will be recorded.
view A view record is generated each time a user visits a page in the mobile application. When a user stays on the same page, resources, long tasks, errors, and action records are linked to the relevant RUM view via the view_id attribute.
resource Records information about resources loaded when the user visits a page.
error Exceptions or crashes issued by the mobile application.
long_task A long task event is generated for any task that blocks the main thread of the application for longer than a specified duration threshold.
action Records user activities in the mobile application (application launch, clicks, swipes, back actions, etc.). Each action is attached with a unique action_id.

Global Attributes

Scenarios for user access monitoring and event alerts can be queried using the following global attributes.

SDK Attributes

Field Type Description
sdk_name string Collector name, fixed names:
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 for user access application. Automatically generated when creating monitoring in the Guance console.
env string Required, environment field. Values: prod/gray/pre/common/local. Where:
prod: production environment
gray: gray release environment
pre: pre-release environment
common: daily environment
local: local environment
version string Required, version number.
service string Optional, name of the associated business or service. Fixed names:
df_rum_ios
df_rum_android
df_rum_windows
df_rum_linux

User & Session Attributes

Field Type Description
userid string For unlogged users, use a random UUID as userid; for logged-in users, use the user ID generated by the application backend.
user_name string Optional, user name.
user_email string Optional, user email.
session_id string Session ID, a new session_id is generated if no activity for more than 15 minutes.
session_type string Session type. Reference values: user & synthetics
user: data generated by RUM features;
synthetics: data generated by headless tests.
is_signin boolean Whether the user is registered, values: T & F.

Device & Resolution Attributes

Field Type Description
device string Mobile device manufacturer
model string Mobile device model
device_uuid string Unique ID of the mobile device, generated using UIDevice.identifierForVendor
os string Operating system information
os_version string Operating system version
os_version_major string Major version of the operating system
screen_size string Screen resolution

Geographic & Network Attributes

Field Type Description
ip string User's 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 unavailable)
country string Country
country_iso_code string ISO code of the country
province string Province
city string City

Custom Attributes

In addition to global attributes, custom attributes (SDK supports tagging custom data) can be used to build scenarios and configure event alerts. Custom attributes are non-global attributes that allow tracking the entire process of user access to applications, identifying and discovering affected user visits, and monitoring 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 RUM features;
test: data generated by headless tests.
session_referrer string Session source, usually records the URL of the source page.
session_first_view_id string view_id of the first page of the current session
session_first_view_name string URL of the first page of the current session
session_last_view_id string view_id of the last visited page of the current session
session_last_view_name string URL of the last page of the current session

Statistics Metrics

Field Type Description
time_spent number(ns) Duration of the current session
session_view_count number Number of associated view_id in 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, parent page
view_name string Page name

Metrics

Field Type Description
loading_time number（ns） Page loading time
time_spent number（ns） Time spent on the page
is_active boolean Indicates whether the user is still active, reference values: true & false

Statistics Metrics

Field Type Description
view_error_count number Number of errors that occurred 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 operations performed during the page view

Monitoring Metrics

Field Type Description
cpu_tick_count number Optional, CPU tick count for this page
cpu_tick_count_per_second number Optional, average CPU tick count per second
fps_avg number Optional, average frames per second for the page
fps_mini number Optional, minimum frames per second for the page
memory_avg number Optional, average memory usage for the page
memory_max number Optional, peak memory usage for 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, parent 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 start, 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 Path group of the resource URL
resource_type string Category of the resource
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
resource_host_ip string Target IP of the resource URL

Metrics

Field Type Description
resource_size number Size of the resource, default unit: byte
resource_dns number（ns） DNS resolution time for resource loading
Calculation method: domainLookupEnd - domainLookupStart
resource_tcp number（ns） TCP connection time for resource loading
Calculation method: connectEnd - connectStart
resource_ssl number（ns） SSL connection time for resource loading
Calculation method: connectEnd - secureConnectStart
resource_ttfb number（ns） Response time for resource loading
Calculation method: responseStart - requestStart
resource_trans number（ns） Content transfer time for resource loading
Calculation method: responseEnd - responseStart
resource_first_byte number（ns） First byte time for resource loading
Calculation method: responseStart - domainLookupStart
duration number（ns） Total loading time for the resource
Calculation method: duration(responseEnd-startTime)
request_header string Request header for the resource
response_header string Response header for the resource

Error

View Attributes

Field Type Description
view_id string Unique ID generated each time a page is visited
view_referrer string Page source, parent 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 start, click, etc.)

Error Attributes

Field Type Description
error_source string Error source, reference values: logger & network
error_type string Error type
logger error type: anr_error | ios_crash
network error type：network_error
error_situation string Error occurrence timing, reference values: startup (at 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 Path group of the resource URL
resource_method string Resource request method

Error Monitoring Attributes

Field Type Description
memory_total string Optional, total memory
memory_use number Optional, memory usage rate
cpu_use number Optional, CPU usage rate
battery_use number Optional, current battery level (not supported on tvOS)
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, parent 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 start, click, etc.)

Metrics

Field Type Description
duration number（ns） Duration of the long task
long_task_message string Long task message
long_task_stack string Long task 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, parent 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 start, click, etc.)

Metrics

Field Type Description
duration number（ns） Time spent on the page operation

Statistics 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? ×