Skip to content

Commit 1cbac2f

Browse files
authored
add more user & session release health details (#5052)
* added more user and session details * fixed wording * add heading in link * replaced hash with %23 * removed IP address from user information * added comma and updated link
1 parent 47d15bb commit 1cbac2f

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/docs/product/releases/health/index.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Sentry distinguishes between two kinds of sessions:
2525

2626
<ul>
2727

28-
<li style="list-style-type:none;">A user- or application-mode session begins with the start of the application. Or, it begins with bringing the already started application back from background to the foreground.</li>
28+
<li style="list-style-type:none;">A user- or application-mode session begins with the start of the application. Or, it begins with bringing the already started application back from background to the foreground. In this context, a user is defined by one or more of the following: a unique ID or UUID, username, or email.</li>
2929

3030
<br></br>
3131

@@ -47,7 +47,9 @@ Sentry distinguishes between two kinds of sessions:
4747

4848
Sessions, whether application-mode or request-mode, are submitted to Sentry so you can track the usage and adoption of your application. When a user of your application experiences a crash, error, or abnormal exit, the session will be flagged accordingly, and Sentry calculates derived metrics. The metrics include data such as the number of users that didn't experience a crash in the specified time range.
4949

50-
In terms of which mode a project runs in, Sentry is able to automatically detect if it is in a server setting and so should run in server-mode/request-mode or if it is in an application setting and so should run in user-mode/application-mode
50+
In terms of which mode a project runs in, Sentry is able to automatically detect if it is in a server setting and so should run in server-mode/request-mode or if it is in an application setting and so should run in user-mode/application-mode.
51+
52+
While the descriptions of a session above cover many cases, the definition of a session can vary by platform. For example, with JavaScript applications, we create a session for every page load and on every navigation change for single-page applications. By contrast, backend applications don't have a well-defined user entity like web and mobile apps, so for those, each new API request represents a new session. Check out the docs for your [specific platform](/platform-redirect/?next=/configuration/releases/%23sessions) for more information.
5153

5254
### Active Sessions/Users
5355

@@ -69,9 +71,9 @@ A _crash_ is when the application had an explicit unhandled error or hard crash.
6971

7072
The _crash free sessions_ number is the percentage of sessions in the specified time range not ended by a crash of the application.
7173

72-
The _crash free users_ number is the percentage of distinct users who did not experience a crash during the specified time period.
74+
The _crash free users_ number is the percentage of distinct users who did not experience a crash during the specified time period. For example, if a user attempts to complete the checkout process on your application and there's a crash, that represents a [crashed user](#crashed-users). By contrast, if the user is able to successfully complete checkout, they are counted as a crash free user.
7375

74-
You can set [crash rate alerts](/product/alerts/alert-types/#sessions-crash-rate-alerts) to tell you when your crash free percentage for either sessions or users falls below a specific threshold.
76+
You can set [crash rate alerts](/product/alerts/alert-types/#sessions-crash-rate-alerts) to tell you when your crash free percentage for either sessions or users falls below a specific threshold.
7577

7678
Depending on your "Display" selection, the sort options for the **Releases** page change. To sort releases by crash free sessions, select "Sessions" in the "Display" dropdown, and to sort by crash free users, select "Users".
7779

@@ -147,3 +149,5 @@ The application shut down normally, but the session experienced handled errors.
147149
### Healthy
148150

149151
The session ends normally and no errors occurred during its lifetime.
152+
153+
Session status can be defined slightly differently by platform, and not all platforms use all of the statuses above. Check out the docs for your [specific platform](/platform-redirect/?next=/configuration/releases/%23sessions) for more information.

0 commit comments

Comments
 (0)