-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(insights): document mobile session health tab #13344
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
31dfe8a
docs(insights): document frontend session health tab
michellewzhang 40d0eab
Merge remote-tracking branch 'origin' into mz/frontend-session-health…
michellewzhang bda6222
fix overview img
michellewzhang 43c9702
wording
michellewzhang 9619243
fix another img
michellewzhang c22c48f
update unhealthy sessions
michellewzhang 1fce2c3
link
michellewzhang de3524d
make reusable
michellewzhang 6f5b6de
refactor
michellewzhang af9892b
Merge remote-tracking branch 'origin' into mz/frontend-session-health…
michellewzhang 6b3292d
pr review
michellewzhang 5c574dd
jasmin pr review
michellewzhang 0999d65
jasmin pr review pt 2
michellewzhang 3f2a8b3
wording
michellewzhang 9ec5441
Merge remote-tracking branch 'origin' into mz/frontend-session-health…
michellewzhang 4068b94
docs(insights): document mobile session health tab
michellewzhang 0c317a8
wording
michellewzhang f9c0773
pr review pt 1
michellewzhang cd5343a
Merge remote-tracking branch 'origin' into mz/mobile-session-health-docs
michellewzhang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: Session Health | ||
| sidebar_order: 40 | ||
| description: "Get insights about your application's session health over time." | ||
| --- | ||
|
|
||
| <Include name="insights-session-health-body.mdx" /> | ||
|
|
||
| <Include name="insights-session-health-mobile.mdx" /> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| ## Charts | ||
|
|
||
|  | ||
|
|
||
| For the Mobile module, the following charts are available: | ||
|
|
||
| - [Crash Free Sessions](/product/releases/health/#crash-free-sessionsusers) | ||
| - [Total Sessions by Release](/product/releases/health/#session) | ||
| - Release Adoption | ||
| - Session Health | ||
| - Session Counts | ||
| - User Health | ||
| - User Counts | ||
| - [New Issues by Release](/product/issues/) | ||
|
|
||
| Most of these charts, with the exception of the New Issues by Release chart, are based on sessions-backed data. | ||
|
|
||
| The Session Health, Session Counts, User Health, and User Counts charts aim to break down trends in how your sessions are performing status-wise. The status options are healthy, crashed, errored, or abnormal. [Learn more about session statuses](/product/releases/health/#session-status). | ||
|
|
||
| The Crash Free Sessions chart extracts out a single status — "crashed" — to highlight the crash free rate of the 5 most adopted releases in the selected projects. In this case, we define "adoption" as the percent of sessions occurring in that release, out of the total number of sessions in the selected projects. We chose to highlight crash free rate, since this is typically the most useful and relevant error-related status for mobile developers. | ||
|
|
||
| The Total Sessions by Release and Release Adoption charts are two ways of visualizing the same data — how many sessions occur in each release. The most recent 5 releases are shown. Total Sessions by Releases is count-based, and Release Adoption is percentage-based (the percent of session counts coming from that release). Release adoption across all 5 releases will add to 100%. | ||
|
|
||
| The New Issues by Release shows the number of new issues per release over time. The most recent 5 releases are shown, and there is an additional series labeled `other` that comprises all other releases. (This series is turned off in the legend by default.) It also gives a preview of the two most recently seen issues for the selected projects. The chart header, when hovered, has a button to view all issues for the selected projects. | ||
|
|
||
|  | ||
|
|
||
| Click on any series option in the graph legend to hide it. In some charts, including the Session Health chart, the healthy series is hidden by default to allow you to automatically see the errored, abnormal, and crashed series at a better scale. | ||
|
|
||
|
|
||
| The overall chart view can be customized, so that you can display the visualizations and metrics you care about most. Simply click the toggle near the chart title to see other charts that can be displayed. | ||
|
|
||
|  | ||
|
|
||
| The chart view will be saved into your browser's local storage, so when you come back to the page, the chart view you selected before will still be displayed. | ||
|
|
||
| ## Releases Table | ||
|
|
||
| The Mobile Session Health tab also includes a table of releases for the selected projects. | ||
|
|
||
|  | ||
|
|
||
| The table contains key information about each release, including: | ||
|
|
||
| - [Adoption stage](/product/releases/health/#adoption-stages) | ||
| - [Crash free rate](/product/releases/health/#crash-free-sessionsusers) | ||
| - [Total session count](/product/releases/health/#sessions) | ||
| - [Number of new issues](/product/issues/) | ||
| - Release status (open or archived) | ||
| - Adoption rate | ||
|
|
||
| The search bar and filter dropdown above the table allow you to filter and search this table. The syntax and options here are similar to those used on the [Releases page](/product/releases/). Note that filtering by adoption stage requires exactly 1 environment to be chosen in the global page filters. [Learn more about searching and filtering releases](/product/releases/usage/sorting-filtering/). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.