Skip to content

Commit 303dc02

Browse files
rtrieuMaelNamNam
andauthored
[DOCS-11406] Clean up inaccurate mentions of metrics (#30424)
* Clean up inaccurate mentions of metrics * Apply suggestions from code review Co-authored-by: Maël Lilensten <[email protected]> * Apply suggestions from code review Co-authored-by: Maël Lilensten <[email protected]> * update android, ios, roku * Apply suggestions from code review Co-authored-by: Maël Lilensten <[email protected]> --------- Co-authored-by: Maël Lilensten <[email protected]>
1 parent 695356d commit 303dc02

File tree

20 files changed

+203
-263
lines changed

20 files changed

+203
-263
lines changed

content/en/real_user_monitoring/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Select an application from the top navigation, or follow the setup instructions
141141

142142
The [RUM Performance Monitoring summary][1] page provides relevant and actionable insights for both web and mobile applications. You have a tailored experience for each platform that helps you:
143143

144-
- **Focus on key data points** by platform, such as the UI latency for web or mobile crashes
144+
- **Focus on key datapoints** by platform, such as the UI latency for web or mobile crashes
145145
- **Monitor application health** through familiar KPIs, such as Core Web Vitals for web apps or hang rate for iOS, to assess app reliability
146146
- **Dive into investigations directly** from interactive widgets without leaving the page
147147

content/en/real_user_monitoring/browser/data_collected.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ further_reading:
2727

2828
## Overview
2929

30-
The RUM Browser SDK generates events that have associated metrics and attributes. Every RUM event has all of the [default attributes](#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`).
30+
The RUM Browser SDK generates events that have associated telemetry and attributes. Every RUM event has all of the [default attributes](#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`).
3131

32-
There are additional [metrics and attributes specific to a given event type](#event-specific-metrics-and-attributes). For example, the `view.loading_time` metric is associated with view events, and the `resource.method` attribute is associated with resource events.
32+
There are additional [attributes specific to a given event type](#event-specific-attributes). For example, the `view.loading_time` telemetry is associated with view events, and the `resource.method` attribute is associated with resource events.
3333

3434
| Event Type | Retention | Description |
3535
|----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -48,11 +48,11 @@ The following diagram illustrates the RUM event hierarchy:
4848

4949
See a complete list of [Standard Attributes][1] for RUM Browser. By default, the attributes are attached to each event type, so you can use them regardless of the RUM event type being queried.
5050

51-
## Event-specific metrics and attributes
51+
## Event-specific attributes
5252

53-
### Session metrics
53+
### Session attributes
5454

55-
| Metric | Type | Description |
55+
| Attribute | Type | Description |
5656
|------------|--------|----------------------------|
5757
| `session.time_spent` | number (ns) | Duration of the user session. |
5858
| `session.view.count` | number | Count of all views collected for this session. |
@@ -83,9 +83,9 @@ See a complete list of [Standard Attributes][1] for RUM Browser. By default, the
8383
| `session.last_view.url_query` | object | The query string parts of the URL decomposed as query params key/value attributes. |
8484
| `session.last_view.url_scheme` | object | The scheme part of the URL. |
8585

86-
### View timing metrics
86+
### View timing attributes
8787

88-
**Note**: View timing metrics include time that a page is open in the background.
88+
**Note**: View timing telemetry includes time that a page is open in the background.
8989

9090
| Attribute | Type | Description |
9191
|---------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -110,16 +110,16 @@ See a complete list of [Standard Attributes][1] for RUM Browser. By default, the
110110
| `view.resource.count` | number | Count of all resources collected for this view. |
111111
| `view.action.count` | number | Count of all actions collected for this view. |
112112

113-
### Resource timing metrics
113+
### Resource timing attributes
114114

115115
Detailed network timing data for the loading of an application's resources are collected with the [Performance Resource Timing API][10].
116116

117-
| Metric | Type | Description |
117+
| Attribute | Type | Description |
118118
|----------------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------|
119119
| `resource.duration` | number | Entire time spent loading the resource. |
120120
| `resource.size` | number (bytes) | Resource size. |
121121
| `resource.connect.duration` | number (ns) | Time spent establishing a connection to the server (connectEnd - connectStart). |
122-
| `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). |
122+
| `resource.ssl.duration` | number (ns) | Time spent for the TLS handshake. If the last request is not over HTTPS, this attribute does not appear (connectEnd - secureConnectionStart). |
123123
| `resource.dns.duration` | number (ns) | Time spent resolving the DNS name of the last request (domainLookupEnd - domainLookupStart). |
124124
| `resource.redirect.duration` | number (ns) | Time spent on subsequent HTTP requests (redirectEnd - redirectStart). |
125125
| `resource.first_byte.duration` | number (ns) | Time spent waiting for the first byte of response to be received (responseStart - RequestStart). |
@@ -141,9 +141,9 @@ Detailed network timing data for the loading of an application's resources are c
141141
| `resource.provider.domain` | string | The resource provider domain. |
142142
| `resource.provider.type` | string | The resource provider type (for example, `first-party`, `cdn`, `ad`, or `analytics`). |
143143

144-
### Long task timing metrics
144+
### Long task timing attributes
145145

146-
| Metric | Type | Description |
146+
| Attribute | Type | Description |
147147
|------------|--------|----------------------------|
148148
| `long_task.duration` | number | Duration of the long task. |
149149

@@ -164,9 +164,9 @@ Source errors include code-level information about the error. For more informati
164164
|-----------------|--------|-------------------------------------------------------------------|
165165
| `error.type` | string | The error type (or error code in some cases). |
166166

167-
### Action timing metrics
167+
### Action timing attributes
168168

169-
| Metric | Type | Description |
169+
| Attribute | Type | Description |
170170
|--------------|--------|--------------------------|
171171
| `action.loading_time` | number (ns) | The loading time of the action. See how it is calculated in the [Tracking User Actions documentation][13]. |
172172
| `action.long_task.count` | number | Count of all long tasks collected for this action. |
@@ -218,5 +218,5 @@ Source errors include code-level information about the error. For more informati
218218
[10]: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
219219
[11]: /real_user_monitoring/browser/collecting_browser_errors#error-sources
220220
[12]: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming
221-
[13]: /real_user_monitoring/browser/tracking_user_actions/?tab=npm#action-timing-metrics
221+
[13]: /real_user_monitoring/browser/tracking_user_actions/?tab=npm#action-timing-telemetry
222222
[14]: /real_user_monitoring/browser/tracking_user_actions/?tab=npm#custom-actions

content/en/real_user_monitoring/browser/frustration_signals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Frustration signals require actions. Enabling `trackFrustrations` automatically
6565

6666
## Usage
6767

68-
Frustration signals appear as high-level data points representing sources of user frustration on the [**RUM Applications** page][1]. To display a list of frustration counts in the [RUM Explorer][2], click the **Options** button and add a column for `@session.frustration.count`.
68+
Frustration signals appear as high-level datapoints representing sources of user frustration on the [**RUM Applications** page][1]. To display a list of frustration counts in the [RUM Explorer][2], click the **Options** button and add a column for `@session.frustration.count`.
6969

7070
### Application list
7171

content/en/real_user_monitoring/browser/monitoring_page_performance.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,45 +23,45 @@ further_reading:
2323

2424
## Overview
2525

26-
RUM view events collect extensive performance metrics for every pageview. Monitor your application's pageviews and explore performance metrics in dashboards and the RUM Explorer.
26+
RUM view events collect extensive performance telemetry for every pageview. Monitor your application's pageviews and explore performance telemetry in dashboards and the RUM Explorer.
2727

2828
{{< img src="real_user_monitoring/browser/waterfall-4.png" alt="A waterfall graph on the Performance tab of a RUM view in the RUM Explorer" style="width:100%;" >}}
2929

30-
You can access performance metrics for your views in:
30+
You can access performance telemetry for your views in:
3131

32-
- Out-of-the-box [RUM dashboards][1], which provide a high-level view of your application's performance. For example, you can filter on [default attributes][2] collected by RUM to surface issues impacting a subset of users in the [Performance Overview dashboard][3]. You can also clone this dashboard, customize it to your needs, and use any [RUM performance metrics](#all-performance-metrics) in the dashboard's query.
32+
- Out-of-the-box [RUM dashboards][1], which provide a high-level view of your application's performance. For example, you can filter on [default attributes][2] collected by RUM to surface issues impacting a subset of users in the [Performance Overview dashboard][3]. You can also clone this dashboard, customize it to your needs, and use any [RUM performance telemetry](#all-performance-telemetry) in the dashboard's query.
3333
- A performance waterfall, accessible for every RUM view event in the [RUM Explorer][4], which enables you to troubleshoot the performance of a specific page view. It displays how your website assets and resources, long tasks, and frontend errors affect the page-level performance for your end users.
3434

3535
## Event timings and core web vitals
3636

3737
<div class="alert alert-warning">
38-
Datadog's Core Web Vitals metrics are available from the <a href="https://github.com/DataDog/browser-sdk">@datadog/browser-rum</a> package v2.2.0+.
38+
Datadog's Core Web Vitals telemetry is available from the <a href="https://github.com/DataDog/browser-sdk">@datadog/browser-rum</a> package v2.2.0+.
3939
</div>
4040

41-
[Google's Core Web Vitals][5] are a set of three metrics designed to monitor a site's user experience. These metrics focus on giving you a view of load performance, interactivity, and visual stability. Each metric comes with guidance on the range of values that translate to good user experience. Datadog recommends monitoring the 75th percentile for these metrics.
41+
[Google's Core Web Vitals][5] are a set of three KPIs designed to monitor a site's user experience. These KPIs focus on giving you a view of load performance, interactivity, and visual stability. Each KPI comes with guidance on the range of values that translate to good user experience. Datadog recommends monitoring the 75th percentile for these KPIs.
4242

4343
{{< img src="real_user_monitoring/browser/core-web-vitals-1.png" alt="Core Web Vitals summary visualization" >}}
4444

4545
- Interaction to Next Paint and Largest Contentful Paint are not collected for pages opened in the background (for example, in a new tab or a window without focus).
46-
- Metrics collected from your real users' pageviews may differ from those calculated for pages loaded in a fixed, controlled environment such as a [Synthetic browser test][6]. Synthetic Monitoring displays Largest Contentful Paint and Cumulative Layout Shift as lab metrics, not real metrics.
46+
- Telemetry collected from your real users' pageviews may differ from those calculated for pages loaded in a fixed, controlled environment such as a [Synthetic browser test][6]. Synthetic Monitoring displays Largest Contentful Paint and Cumulative Layout Shift as lab telemetry, not real telemetry.
4747

48-
| Metric | Focus | Description | Target value |
48+
| Datapoint | Focus | Description | Target value |
4949
|--------------------------|------------------|-------------------------------------------------------------------------------------------------------|--------------|
5050
| [Largest Contentful Paint][7] | Load performance | Moment in the page load timeline in which the largest DOM object in the viewport (as in, visible on screen) is rendered. | <2.5s |
5151
| [Interaction To Next Paint][19]| Interactivity | Longest duration between a user's interaction with the page and the next paint. Requires RUM SDK v5.1.0. | <200ms |
5252
| [Cumulative Layout Shift][9] | Visual stability | Quantifies unexpected page movement due to dynamically loaded content (for example, third-party ads) where 0 means that no shifts are happening. | <0.1 |
5353

5454
### Core web vitals target elements
5555

56-
Identifying what element triggered a high Core Web Vitals metric is the first step in understanding the root cause and being able to improve performance.
56+
Identifying what element triggered a high Core Web Vitals KPI is the first step in understanding the root cause and being able to improve performance.
5757
RUM reports the element that is associated with each Core Web Vital instance:
5858

5959
- For Largest Contentful Paint, RUM reports the CSS Selector of the element corresponding to the largest contentful paint.
6060
- For Interaction to Next Paint, RUM reports the CSS selector of the element associated with the longest interaction to the next paint.
6161
- For First Input Delay, RUM reports the CSS selector of the first element the user interacted with.
6262
- For Cumulative Layout Shift, RUM reports the CSS selector of the most shifted element contributing to the CLS.
6363

64-
## All performance metrics
64+
## All performance telemetry
6565

6666
| Attribute | Type | Description |
6767
|---------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -90,7 +90,7 @@ RUM reports the element that is associated with each Core Web Vital instance:
9090

9191
For single page applications (SPAs), the RUM Browser SDK differentiates between `initial_load` and `route_change` navigation with the `loading_type` attribute. If an interaction on your web page leads to a different URL without a full refresh of the page, the RUM SDK starts a new view event with `loading_type:route_change`. RUM tracks URL changes using the [History API][16].
9292

93-
Datadog provides a unique performance metric, `loading_time`, which calculates the time needed for a page to load. This metric works for both `initial_load` and `route_change` navigation.
93+
Datadog provides a unique KPI, `loading_time`, which calculates the time needed for a page to load. This KPI works for both `initial_load` and `route_change` navigation.
9494

9595
### How loading time is calculated
9696

@@ -144,7 +144,7 @@ window.DD_RUM.init({
144144

145145
The RUM SDK automatically monitors frameworks that rely on hash (`#`) navigation. The SDK watches for `HashChangeEvent` and issues a new view. Events coming from an HTML anchor tag which do not affect the current view context are ignored.
146146

147-
## Create custom performance metrics
147+
## Create custom performance telemetry
148148

149149
### Measure component-level performance with custom vitals
150150

content/en/real_user_monitoring/browser/monitoring_resource_performance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See [Connect RUM and Traces][2] for information about setting up this feature.
3131

3232
{{< img src="real_user_monitoring/browser/resource_performance_graph.png" alt="APM Trace information for a RUM Resource" >}}
3333

34-
## Resource timing and metrics
34+
## Resource attributes
3535

3636
Detailed network timing data for resources is collected from the Fetch and XHR native browser methods and from the [Performance Resource Timing API][3].
3737

@@ -40,7 +40,7 @@ Detailed network timing data for resources is collected from the Fetch and XHR n
4040
| `resource.duration` | number | Entire time spent loading the resource. |
4141
| `resource.size` | number (bytes) | Resource size. |
4242
| `resource.connect.duration` | number (ns) | Time spent establishing a connection to the server (connectEnd - connectStart). |
43-
| `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). |
43+
| `resource.ssl.duration` | number (ns) | Time spent for the TLS handshake. If the last request is not over HTTPS, this attribute does not appear (connectEnd - secureConnectionStart). |
4444
| `resource.dns.duration` | number (ns) | Time spent resolving the DNS name of the last request (domainLookupEnd - domainLookupStart). |
4545
| `resource.redirect.duration` | number (ns) | Time spent on subsequent HTTP requests (redirectEnd - redirectStart). |
4646
| `resource.first_byte.duration` | number (ns) | Time spent waiting for the first byte of response to be received (responseStart - RequestStart). |

0 commit comments

Comments
 (0)