Browser Monitoring fields-Application Real-Time Monitoring Service(ARMS)-阿里云帮助中心

Application Real-Time Monitoring Service (ARMS) Browser Monitoring collects telemetry data and stores it in Log Service. Each log entry contains fields that describe the event. Use these fields to build log queries, create dashboards, and debug browser performance issues in Log Service.

Every log entry includes a t field that identifies the event type, a set of common fields shared across all event types, and event-specific fields unique to each type.

Event types

The t field determines the event type of each log entry.

Value of `t`	Event type	Description
`api`	API call	Tracks API requests initiated from the page, including status codes and response times.
`pv`	Page view	Records page visits. Used to calculate page view (PV) and unique visitor (UV) metrics.
`perf`	Performance	Captures page load timing metrics such as DNS, TCP, TTFB, and First Paint.
`health`	Health	Summarizes per-page health: error counts, API success/failure counts, and page stay duration.
`speed`	Custom speed	Reports custom data transmission rates. Specify a keyword from `s0` to `s10`.
`behavior`	User behavior	Captures user interactions (clicks, navigations) leading up to an error.
`error`	JavaScript error	Reports JavaScript runtime errors with stack traces and source locations.
`resourceError`	Resource error	Reports failed resource loads (images, scripts, stylesheets).
`sum`	Sum	Reports a custom sum value for a named event.
`avg`	Average	Reports a custom average value for a named event.
`percent`	Percent	Reports a custom percent value for a named event.
`custom`	Custom	Reports custom key-value pairs. Field names cannot exceed 20 characters and are automatically prefixed with `x-` on ingestion.

Common fields

These fields appear in every log entry, regardless of event type.

Device and browser

Field	Type	Example	Description
`detector_browser`	string	`safari`	Browser name.
`detector_browser_version`	string	`14.1.1`	Browser version.
`detector_device`	string	`mac`	Device model or name.
`detector_type`	string	`pc`	Device type.
`detector_engine`	string	`webkit`	Browser rendering engine.
`detector_engine_version`	string	`605.1.15`	Rendering engine version.
`detector_os`	string	`macos`	Operating system.
`detector_os_version`	string	`10.15.7`	Operating system version.
`sr`	string	`1280x800`	Screen resolution in pixels (width x height).
`vp`	string	`1280x677`	Viewport size in pixels (width x height).
`http_user_agent`	string	`Mozilla/5.0 (Macintosh; ...)`	Full user agent string.

Network and geolocation

Field	Type	Example	Description
`ct`	string	`4g`	Network connection type.
`remote_addr`	string	`111.198.XX.XX`	Client IP address.
`ip_country`	string	`China`	Country derived from the client IP.
`ip_country_id`	string	`CN`	ISO 3166-1 alpha-2 country code.
`ip_region`	string	`Beijing`	Province or state derived from the client IP.
`ip_region_id`	string	`110000`	Administrative division code for the province or state.
`ip_city`	string	`Beijing`	City derived from the client IP.
`ip_city_id`	string	`110100`	Administrative division code for the city.
`ip_isp`	string	`China Unicom`	Internet service provider.

Session and identity

Field	Type	Example	Description
`uid`	string	`94kUgryg4thaLg61ep5******`	User ID.
`sid`	string	`kCk83rFv40Caz06y3pv******`	Session ID.
`pv_id`	string	`bkkRsrej4OFdv2d4yeb37Xb2R2Xp`	Page view ID.

Page and environment

Field	Type	Example	Description
`page`	string	`testing`	Page URL path.
`src`	string	`https://example.com`	Monitored site URL.
`http_referer`	string	`https://example.com/`	HTTP Referer header value.
`environment`	string	`prod`	Deployment environment.
`release`	string	`2.0.123`	Application release version.

Timestamps and sampling

Field	Type	Example	Description
`begin`	number (ms)	`1626320736212`	Timestamp when the event was generated on the client, in Unix epoch milliseconds.
`date`	number (ms)	`1626320736212`	Defaults to the value of `begin`. Falls back to the server receive time if `begin` is absent.
`sampling`	number	`100`	Global sampling rate.
`sample_pv`	number	`3`	Sampling rate for page view events.
`sample_api`	number	`4`	Sampling rate for API events.
`sample_health`	number	`3`	Sampling rate for health events.
`sample_resourceError`	number	`100`	Sampling rate for resource error events.

Other common fields

Field	Type	Example	Description
`t`	string	`resourceError`	Event type.
`times`	number	`100`	Occurrence count for similar events batched together.
`xpath`	string	`html.is-safari.is-desktop.is-mac > head. > script.`	DOM node path.
`z`	string	`kr4dde7g`	Cache-busting token.

Note

Log storage tables also contain auxiliary fields prefixed with an underscore (_), such as _line, _v, and _target. These fields are generated during internal data processing and are not relevant to your queries. You can ignore them.

API fields (`t: api`)

Logged when the Browser Monitoring SDK intercepts an API request.

Field	Type	Example	Description
`page`	string	`tracing/list/cn-hangzhou`	Page from which the API request was sent.
`api`	string	`/api/trace.json`	Request URL path.
`success`	number	`1`	Whether the request succeeded. `1` = success, `0` = failure.
`time`	number (ms)	`63`	Request duration in milliseconds.
`code`	string	`200`	HTTP response status code.
`msg`	string	`success`	Response message body.
`traceId`	string	`7eb784eb16381787313011******`	Trace ID associated with the request, used for end-to-end tracing.
`pv_id`	string	`7ekzzwImkbyhU5bIeiX0v9******`	Page view ID that this request belongs to.

Sample payload:

t: api
times: 1
page: tracing/list/cn-hangzhou
environment: prod
begin: 1638178731302
api: /api/trace.json
success: 1
time: 63
code: 200
msg: success
traceId: 7eb784eb16381787313011******
pv_id: 7ekzzwImkbyhU5bIeiX0v9******
domain: arms.console.aliyun.com
sr: 1680x1050
vp: 1628x946
ct: 4g
sampling: 1

Page view fields (`t: pv`)

Logged on each page visit.

Field	Type	Example	Description
`pv_id`	string	`Rhksdwe1kFLhhXjwqp159******`	Page view ID.
`dt`	string	`Application Real-Time Monitoring Service (ARMS)`	Page title.
`dr`	string	`https://example.com`	Document referrer.
`dpr`	number	`1.00`	Device pixel ratio.
`de`	string	`utf-8`	Document character encoding.
`ul`	string	`zh`	Document language.
`dl`	string	`https://arms.console.aliyun.com/#/tracing/callChains/cn-hangzhou`	Full page URL.

Sample payload:

t: pv
times: 1
page: tracing/callChains/cn-hangzhou
environment: prod
begin: 1638179112949
dt: Application Real-Time Monitoring Service (ARMS)
dpr: 1.00
de: utf-8
ul: zh
sr: 1680x1050
vp: 1628x946
ct: 4g
pv_id: Rhksdwe1kFLhhXjwqp159******
sampling: 1
dl: https://arms.console.aliyun.com/#/tracing/callChains/cn-hangzhou

Health fields (`t: health`)

Logged to summarize the overall health of the page session. Reported in the same cadence as PV events.

Field	Type	Example	Description
`errcount`	number	`0`	Total JavaScript error count during this page view.
`apisucc`	number	`42`	Number of successful API calls.
`apifail`	number	`0`	Number of failed API calls.
`healthy`	number	`1`	Page health status. `1` = healthy, `0` = unhealthy.
`stay`	number (ms)	`1647744`	Time the user spent on the page, in milliseconds. The minimum reported value is 2,000 ms. Because health events follow the same reporting cadence as PV events, rapid page switches may cause the reported API counts to be lower than the actual totals.

Sample payload:

t: health
times: 1
page: tracing/callChains/cn-hangzhou
environment: prod
begin: 1638178731334
errcount: 0
apisucc: 42
apifail: 0
healthy: 1
stay: 1647744
pv_id: Iakvsw01ktagjzcpz773g******
sampling: 1

Performance fields (`t: perf`)

Logged once per page load to capture navigation and paint timing metrics. All timing values are in milliseconds.

Navigation timing

Field	Type	Example	Description
`dns`	number (ms)	`12`	Time consumed for DNS lookup.
`tcp`	number (ms)	`17`	Time consumed for TCP connection.
`ssl`	number (ms)	`14`	Time consumed for SSL connection.
`ttfb`	number (ms)	`426`	Time to First Byte (TTFB). The period from the time when the browser makes the request to the time when the browser receives the first byte of the page.
`trans`	number (ms)	`3`	Time consumed for data transmission.
`dom`	number (ms)	`1760`	Time consumed for DOM resolution.
`res`	number (ms)	`1466`	Time consumed for resource loading.
`firstbyte`	number (ms)	`455`	The period from the time when the browser starts the domain name lookup for the resource to the time when the browser receives the first byte of the page.

Paint and interactivity timing

Field	Type	Example	Description
`fpt`	number (ms)	`479`	First Paint Time (FPT). Time until the browser renders the first pixel to the screen.
`tti`	number (ms)	`2239`	Time to Interactive (TTI). Time until the page is fully interactive.
`ready`	number (ms)	`2243`	Time consumed to load an HTML page, namely, the time consumed to construct the DOM.
`load`	number (ms)	`3709`	Time consumed to completely load the page.
`fmp`	number (ms)	`4374`	First Meaningful Paint (FMP). Time until the primary above-the-fold content is visible.
`navtype`	string	`Reload`	The method used to load the page. Valid values: `Reload`, `Other`.

Note

Fields t1 through t10, ctti, and cfpt are reserved for manually reported custom performance data. Only perf events contain these fields.

Sample payload:

t: perf
times: 1
page: arms.console.aliyun.com
environment: prod
begin: 1638183632694
dns: 12
tcp: 17
ssl: 14
ttfb: 426
trans: 3
dom: 1760
res: 1466
firstbyte: 455
fpt: 479
tti: 2239
ready: 2243
load: 3709
ct: 4g
bandwidth: 10
navtype: Reload
fmp: 4374
autoSend: true
sr: 2560x1440
vp: 1293x1336
sampling: 1

Behavior fields (`t: behavior`)

Logged when errors occur to capture the sequence of user interactions leading up to the error. The behavior array in the request body records each interaction with its type, data, timestamp, and page.

Interaction types include:

ui.click -- Records the CSS selector path of the clicked element.
navigation -- Records the from and to URLs of a page transition.

Sample payload:

t: behavior
times: 1
page: arms.console.aliyun.com%2Fapm
environment: prod
begin: 1638184741074
pv_id: shkRqwIpkLak92ttv8ne6******
sampling: 1

requestBody:
{
    "behavior": [
        {
            "type": "ui.click",
            "data": {
                "message": "div%23.next-menu-item-inner%20%3E%20span%23.next-menu-item-text%20%3E%20a%23."
            },
            "timestamp": 1638184607432,
            "page": "/apm"
        },
        {
            "type": "navigation",
            "data": {
                "from": "https://arms.console.aliyun.com/apm?pid=xxx%40xxx&regionId=cn-hangzhou#/aokcdqn3ly@4a331e0c0dcbd46/home",
                "to": "https://arms.console.aliyun.com/apm?pid=xxx%40xxx&regionId=cn-hangzhou#/aokcdqn3ly@4a331e0c0dcbd46/timedTask"
            },
            "timestamp": 1638184607433,
            "page": "/apm"
        },
        {
            "type": "ui.click",
            "data": {
                "message": "ul%23.next-tabs-nav%20%3E%20li%23.next-tabs-tab%20%3E%20div%23.next-tabs-tab-inner"
            },
            "timestamp": 1638184617802,
            "page": "/apm"
        },
        {
            "type": "navigation",
            "data": {
                "from": "https://arms.console.aliyun.com/apm?pid=xxx%40xxx&regionId=cn-hangzhou#/aokcdqn3ly@4a331e0c0dcbd46/timedTask",
                "to": "https://arms.console.aliyun.com/apm?pid=xxx%40xxx&regionId=cn-hangzhou#/aokcdqn3ly@4a331e0c0dcbd46/timedTask/{%22tabs%22:%22iss%22}"
            },
            "timestamp": 1638184617804,
            "page": "/apm"
        },
        {
            "type": "ui.click",
            "data": {
                "message": "ul%23.next-tabs-nav%20%3E%20li%23.next-tabs-tab%20%3E%20div%23.next-tabs-tab-inner%20%3E%20span%23."
            },
            "timestamp": 1638184619991,
            "page": "/apm"
        }
    ]
}

Error fields (`t: error`)

Logged when a JavaScript error occurs. The SDK captures the error type, message, stack trace, and source location.

Field	Type	Example	Description
`cate`	string	`ReferenceError`	Error type (for example, `ReferenceError`, `TypeError`). Defaults to `CustomError`.
`msg`	string	`unknownmethod333 is not defined`	Error message. Maximum 1,000 characters.
`stack`	string	`ReferenceError: unknownmethod333 is not defined at fetch-demo.js:278:9`	Stack trace. Maximum 1,000 characters.
`file`	string	`http://local.taobao.com:8880/demo/fetch-demo.js`	Source file URL where the error occurred.
`line`	number	`278`	Line number of the error.
`col`	number	`9`	Column number of the error.
`err`	string (JSON)	`{"msg_raw": "...", "stack_raw": "..."}`	URL-encoded error details, containing `msg_raw` (error message) and `stack_raw` (stack trace).

Sample payload:

t: error
times: 1
page: 8880/demo/index.html
environment: prod
begin: 1638185189365
cate: ReferenceError
msg: unknownmethod333 is not defined
stack: ReferenceError: unknownmethod333 is not defined
    at http://local.taobao.com:8880/demo/fetch-demo.js:278:9
file: http://local.taobao.com:8880/demo/fetch-demo.js
line: 278
col: 9
pv_id: RgkFyw9zk67l995pnwI5x5******
sampling: 1

requestBody:
{
    "err": {
        "msg_raw": "unknownmethod333%20is%20not%20defined",
        "stack_raw": "ReferenceError%3A%20unknownmethod333%20is%20not%20defined..."
    }
}

Resource error fields (`t: resourceError`)

Logged when a page resource (image, script, stylesheet) fails to load.

Field	Type	Example	Description
`src`	string	`http://example/unknown/picture.jpg`	URL of the failed resource.
`node_name`	string	`img`	HTML element that triggered the load.
`xpath`	string	`html. > body. > img.`	DOM path to the element.
`res_type`	string	`img`	Resource type.
`res_name`	string	`/unknown/picture.jpg`	Resource file path.
`domain`	string	`example`	Domain that hosts the resource.

Sample payload:

t: resourceError
times: 1
page: 8880/demo/index.html
environment: prod
begin: 1638185188224
src: http://example/unknown/picture.jpg
node_name: img
xpath: html. > body. > img.
res_type: img
res_name: /unknown/picture.jpg
domain: example
pv_id: RgkFyw9zk67l995pnwI5x******
sampling: 1

Sum, average, and percent fields (`t: sum`, `t: avg`, `t: percent`)

Logged when the SDK reports custom aggregation metrics. Use __bl.sum(), __bl.avg(), or __bl.percent() to report these events.

Field	Type	Example	Description
`key`	string	`Application list`	Event name. Separate group and event with double colons (`::`) -- for example, `groupX::eventC`.
`val`	number	`1`	Reported numeric value.
`group`	string	`ARMS2_NavItemClick`	Event group name.

Report custom metrics with the following SDK methods:

__bl.sum('eventA');          // Sum with default value 1
__bl.sum('eventB', 2);       // Sum with value 2
__bl.sum('groupX::eventC');  // Sum with group prefix

Sample payload:

t: sum
times: 1
page: tracing/callChains/cn-hangzhou
environment: prod
begin: 1638178731104
key: Application list
val: 1
group: ARMS2_NavItemClick
pv_id: Iakvsw01ktagjzcpz773g8******
sampling: 1

Custom fields (`t: custom`)

Logged when the SDK reports custom key-value data. Field names cannot exceed 20 characters and are automatically prefixed with x- on ingestion.

Sample payload:

t: custom
times: 1
page: local.taobao.com:8880/demo/index.html
environment: prod
begin: 1638185189340
x-msg: testcreateInstance222 is ok
pv_id: 99ktyw7akk0lIO565xXCw******
sampling: 1

Event types

Common fields

Device and browser

Network and geolocation

Session and identity

Page and environment

Timestamps and sampling

Other common fields

API fields (t: api)

Page view fields (t: pv)

Health fields (t: health)

Performance fields (t: perf)

Navigation timing

Paint and interactivity timing

Behavior fields (t: behavior)

Error fields (t: error)

Resource error fields (t: resourceError)

Sum, average, and percent fields (t: sum, t: avg, t: percent)

Custom fields (t: custom)

API fields (`t: api`)

Page view fields (`t: pv`)

Health fields (`t: health`)

Performance fields (`t: perf`)

Behavior fields (`t: behavior`)

Error fields (`t: error`)

Resource error fields (`t: resourceError`)

Sum, average, and percent fields (`t: sum`, `t: avg`, `t: percent`)

Custom fields (`t: custom`)