Skip to content

Commit 2a0986e

Browse files
author
Luca Forstner
committed
jsdoc, comment, name
1 parent 98db1ca commit 2a0986e

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

packages/browser/src/integrations/session.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,18 @@ import { captureSession, defineIntegration, logger, startSession } from '@sentry
33
import { DEBUG_BUILD } from '../debug-build';
44
import { WINDOW } from '../helpers';
55

6+
/**
7+
* When added, automatically creates sessions which allow you to track adoption and crashes (crash free rate) in your Releases in Sentry.
8+
*
9+
* Note: In order for session tracking to work, you need to set up Releases: https://docs.sentry.io/product/releases/
10+
*/
611
export const browserSessionIntegration = defineIntegration(() => {
712
return {
8-
name: 'Session',
13+
name: 'BrowserSession',
914
setupOnce() {
1015
if (typeof WINDOW.document === 'undefined') {
11-
DEBUG_BUILD && logger.warn('Using the sessionIntegration in non-browser environments is not supported.');
16+
DEBUG_BUILD &&
17+
logger.warn('Using the `browserSessionIntegration` in non-browser environments is not supported.');
1218
return;
1319
}
1420

0 commit comments

Comments
 (0)