Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/operate/rum/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "RUM",
"position": 8,
"link": {
"type": "generated-index",
"title": "Mobile Real User Monitoring with RUM",
"description": "Monitor real mobile user experience with RUM in base14 Scout. Track crash-free rates, app startup performance, screen load times, network calls, and session timelines for your Flutter applications."
}
}
51 changes: 51 additions & 0 deletions docs/operate/rum/anr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: RUM ANR
sidebar_label: ANR
sidebar_position: 5
description:
Detect Application Not Responding (ANR) events in your Flutter apps with RUM
in base14 Scout. Analyze frozen-UI durations by app version, OS, and device.
keywords:
[
rum,
anr,
application not responding,
frozen ui,
mobile performance,
jank,
base14,
scout,
]
---

The **ANR** (Application Not Responding) tab tracks frozen-UI events — periods
where the app's main thread was blocked and unresponsive to user input.

![ANR](/img/rum/anr.png)

ANR events include duration breakdowns **by App Version**, **by OS Version**,
and **by Device Model**, helping you pin down which builds and devices freeze
most often.

---

## ANR Details

Click an ANR group to open the detail view.

![ANR Details](/img/rum/anr-details.png)

- **Total Occurrences**, **Affected Users**, and **Affected Sessions** stats
- **Attributes** panel with device, OS, screen, session, and SDK context
- Occurrences broken down **by App Version**, **by OS Version**, and
**by Device Model**
- **Stack Trace (Main Thread)** showing where the main thread was blocked
- **All Threads** dump listing every thread with its state
(`RUNNABLE`, `TIMED_WAITING`, `WAITING`) and frame count — useful for finding
which thread held the lock the main thread was waiting on
- **Breadcrumbs** — the sequence of lifecycle, navigation, and tap events
leading up to the freeze
- **Affected Devices** and **Affected Users** tables

Use **View Session Timeline** to jump into the full
[session](./sessions.md) where the ANR occurred.
44 changes: 44 additions & 0 deletions docs/operate/rum/crashes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: RUM Crashes
sidebar_label: Crashes
sidebar_position: 3
description:
Investigate mobile app crashes with RUM in base14 Scout. Group crashes,
view symbolicated stack traces, and see affected devices, users, app
versions, and OS versions.
keywords:
[
rum,
crashes,
crash reporting,
symbolication,
stack trace,
native crash,
mobile crash,
base14,
scout,
]
---

The **Crashes** tab groups individual crash events into deduplicated crash
groups so you can prioritize by impact.

![Crashes List](/img/rum/crashes.png)

Each crash group shows its **Title**, **Kind**, **Type** (Native or JS Error),
**Occurrences**, affected **Sessions** and **Users**, **App Version**, and
**Last Seen**.

---

## Crash Details

Click a crash group to open the detail view with:

- **Symbolicated stack trace** (Java / Android), memory map, and raw tombstone
- Occurrences broken down **by App Version**, **by OS Version**, and
**by Device Model**
- **Affected Devices** (brand, model, OS, app version, count)
- **Affected Users** (user, crash count, last hit)

![Crash Details](/img/rum/crash-details.png)
52 changes: 52 additions & 0 deletions docs/operate/rum/errors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: RUM Errors
sidebar_label: Errors
sidebar_position: 4
description:
Track non-fatal errors in your Flutter apps with RUM in base14 Scout. Group
and rank JS and Dart errors by occurrence to prioritize fixes.
keywords:
[
rum,
errors,
non-fatal errors,
dart errors,
js errors,
mobile errors,
base14,
scout,
]
---

The **Errors** tab surfaces non-fatal JS/Dart errors reported by the app,
grouped and ranked by occurrence so you can prioritize the errors affecting the
most users.

![Errors](/img/rum/errors.png)

Each error group shows its message, occurrence count, and the sessions and users
affected. Use it alongside [Crashes](./crashes.md) to separate fatal crashes
from recoverable errors.

---

## Error Details

Click an error group to open the detail view. The header shows the exception
message along with badges such as the error kind (for example `manual_error`)
and whether it was `handled`.

![Error Details](/img/rum/error-details.png)

- **Total Occurrences**, **Affected Users**, and **Affected Sessions** stats
- **Attributes** panel with rich context — device, OS, network, process and
runtime details, plus custom attributes like feature flags and experiments
- Occurrences broken down **by App Version**, **by OS Version**, and
**by Device Model**
- **Stack Trace** with numbered frames pointing to the source location
- **Breadcrumbs** — the events (screen views, taps, long tasks, UI hangs)
leading up to the error
- **Affected Devices** and **Affected Users** tables

Use **View Session Timeline** to open the full [session](./sessions.md) where
the error was thrown.
72 changes: 72 additions & 0 deletions docs/operate/rum/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Getting Started with RUM
sidebar_label: Getting Started
sidebar_position: 1
description:
Get started with RUM in base14 Scout. Learn the interface, select a mobile
application, and set a time range to monitor real user experience for your
Flutter apps.
keywords:
[
rum,
real user monitoring,
mobile monitoring,
flutter monitoring,
getting started,
base14,
scout,
]
---

RUM (Real User Monitoring) is a mobile monitoring Grafana app built into Scout.
It gives you deep visibility into how real users experience your Flutter
applications — tracking crashes, errors, ANRs, app startup, screen performance,
network calls, and full session timelines.

RUM queries mobile telemetry stored in the Scout Telemetry Data Lake and
correlates crashes, sessions, and screens so you can move from a symptom
(a crash spike) to a root cause (a specific screen, app version, or device) in
a few clicks.

![RUM Overview](/img/rum/overview.png)

---

## Interface Overview

The RUM interface consists of:

| Section | Description |
| ------- | ----------- |
| **Application Selector** | Choose which mobile application to inspect |
| **Navigation Tabs** | Switch between Overview, Errors, Crashes, ANR, Sessions, Screens, Network, and Users |
| **Time Picker** | Set the time range for all panels |
| **Breakdown Filters** | Slice metrics by app version, OS version, and device model |

---

## Select an Application

The **Applications** tab lists every mobile app reporting telemetry to Scout.

1. Open the **Applications** tab
2. Select the application you want to monitor
3. RUM loads that app's data across all other tabs

![Applications](/img/rum/applications.png)

---

## Set the Time Range

Use the time picker to scope every panel to a time window. All charts, tables,
and breakdowns update to the selected range.

---

## Next Steps

- [Overview](./overview.md) - Health-at-a-glance dashboard
- [Crashes](./crashes.md) - Crash groups and symbolicated stack traces
- [Sessions](./sessions.md) - Session list and event timelines
- [Screens](./screens.md) - Per-screen performance
30 changes: 30 additions & 0 deletions docs/operate/rum/network.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: RUM Network
sidebar_label: Network
sidebar_position: 8
description:
Analyze API and network performance from the mobile client's perspective with
RUM in base14 Scout. Track response times, error rates, and failed requests
by endpoint.
keywords:
[
rum,
network,
api performance,
response time,
error rate,
failed requests,
mobile network,
base14,
scout,
]
---

The **Network** tab surfaces API and network performance from the mobile
client's perspective.

![Network Performance](/img/rum/network.png)

- **Avg Response Time by Endpoint** (top 10)
- **All Endpoints** — URL, method, avg duration, error rate, request count
- **Failed Requests** — URL, method, status, occurrences, first/last seen
52 changes: 52 additions & 0 deletions docs/operate/rum/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: RUM Overview
sidebar_label: Overview
sidebar_position: 2
description:
Monitor mobile app health at a glance with the RUM Overview dashboard in
base14 Scout. Track crash-free rate, sessions, active users, startup times,
and trends by app version, OS, and device.
keywords:
[
rum,
overview,
crash-free rate,
mobile health,
app startup,
cold start,
warm start,
base14,
scout,
]
---

The **Overview** tab is your health-at-a-glance dashboard for the selected
mobile application.

![Overview Dashboard](/img/rum/overview.png)

---

## Key Metrics

| Metric | Description |
| ------ | ----------- |
| **Crash-Free Rate** | Percentage of sessions with no crashes |
| **Total Sessions** | Number of user sessions in the range |
| **Active Users** | Distinct users in the range |
| **Total Errors** | Count of reported errors |
| **Avg Cold Start** | Average cold app startup time |
| **Avg Warm Start** | Average warm app startup time |

---

## Trends and Breakdowns

- **Sessions Over Time**, **Crashes Over Time**, and **ANR Duration Over Time**
time-series charts
- Breakdowns of crashes, sessions, and ANR duration **by App Version**,
**by OS Version**, and **by Device Model**
- **Top Crashing Screens** and **Slowest Screens** tables

Click the **Total Sessions** or **Active Users** stat to jump straight to the
[Sessions](./sessions.md) or [Users](./users.md) tab.
43 changes: 43 additions & 0 deletions docs/operate/rum/screens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: RUM Screens
sidebar_label: Screens
sidebar_position: 7
description:
Measure per-screen performance in your Flutter apps with RUM in base14 Scout.
Track load times, frame rendering, memory and CPU usage, jank, and crashes
by screen.
keywords:
[
rum,
screens,
screen performance,
load time,
frame rendering,
jank,
core web vitals,
mobile performance,
base14,
scout,
]
---

The **Screens** tab measures per-screen performance across your app.

![Screen Performance](/img/rum/screens.png)

The screen table reports **Views**, **Unique Sessions**, **Avg Load**,
**p95 Load**, **Avg Time Spent**, **Long Tasks**, and **Crashes**.

---

## Screen Details

Select a screen to see:

![Screen Details](/img/rum/screen-details.png)

- **Load Time Trend** and **Views Over Time**
- Rendering health: **Frame Build Time**, **Frame Raster Time**, **Frame Time**
- Resource usage: **Memory Usage**, **CPU Usage**, **JS Heap Memory**
- **Core Web Vitals**
- **Slowest Loads**, **Long Tasks (Jank Events)**, and **Crashes on this Screen**
Loading
Loading