feat: Deprecate autoSessionTracking#14640

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.

Sign up for GitHub

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
lforst merged 3 commits into from
Dec 11, 2024
Merged

feat: Deprecate autoSessionTracking#14640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f503c8
feat: Deprecate `autoSessionTracking`
Dec 10, 2024
c7ea053
lint
Dec 10, 2024
0846471
review
Dec 11, 2024
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
5 changes: 5 additions & 0 deletions docs/migration/draft-v9-migration-guide.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,11 @@
In v9, we will streamline this behavior so that passing `undefined` will result in tracing being disabled, the same as not passing the option at all.
If you are relying on `undefined` being passed in and having tracing enabled because of this, you should update your config to set e.g. `tracesSampleRate: 0` instead, which will also enable tracing in v9.

- **The `autoSessionTracking` option is deprecated.**

To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.

## `@sentry/utils`

- **The `@sentry/utils` package has been deprecated. Import everything from `@sentry/core` instead.**
Expand Down
1 change: 1 addition & 0 deletions packages/angular/src/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ export function getDefaultIntegrations(options: BrowserOptions = {}): Integratio
httpContextIntegration(),
];

// eslint-disable-next-line deprecation/deprecation
if (options.autoSessionTracking !== false) {
integrations.push(browserSessionIntegration());
}
Expand Down
1 change: 1 addition & 0 deletions packages/browser/src/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ export function getDefaultIntegrations(options: Options): Integration[] {
httpContextIntegration(),
];

// eslint-disable-next-line deprecation/deprecation
if (options.autoSessionTracking !== false) {
integrations.push(browserSessionIntegration());
}
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/server-runtime-client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export class ServerRuntimeClient<
// The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
// TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
// TODO(v9): This should move into the httpIntegration.
// eslint-disable-next-line deprecation/deprecation
if (this._options.autoSessionTracking && this._sessionFlusher) {
// eslint-disable-next-line deprecation/deprecation
const requestSession = getIsolationScope().getRequestSession();
Expand All@@ -106,6 +107,7 @@ export class ServerRuntimeClient<
// The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
// TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
// TODO(v9): This should move into the httpIntegration.
// eslint-disable-next-line deprecation/deprecation
if (this._options.autoSessionTracking && this._sessionFlusher) {
const eventType = event.type || 'exception';
const isException =
Expand Down
6 changes: 5 additions & 1 deletion packages/core/src/types-hoist/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp

/**
* A flag enabling Sessions Tracking feature.
* By default, Sessions Tracking is enabled.
* By default, Session Tracking is enabled.
*
* @deprecated Setting the `autoSessionTracking` option is deprecated.
* To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
* To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.
*/
autoSessionTracking?: boolean;

Expand Down
1 change: 1 addition & 0 deletions packages/node/src/integrations/http/SentryHttpInstrumentation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -147,6 +147,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
});

const client = getClient<NodeClient>();
// eslint-disable-next-line deprecation/deprecation
if (client && client.getOptions().autoSessionTracking) {
// eslint-disable-next-line deprecation/deprecation
isolationScope.setRequestSession({ status: 'ok' });
Expand Down
2 changes: 2 additions & 0 deletions packages/node/src/integrations/http/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ interface HttpOptions {
*
* Note: If `autoSessionTracking` is set to `false` in `Sentry.init()` or the Client owning this integration, this option will be ignored.
*/
// TODO(v9): Remove the note above.
trackIncomingRequestsAsSessions?: boolean;

/**
Expand DownExpand Up@@ -218,6 +219,7 @@ function getConfigWithDefaults(options: Partial<HttpOptions> = {}): HttpInstrume

if (
client &&
// eslint-disable-next-line deprecation/deprecation
client.getOptions().autoSessionTracking !== false &&
options.trackIncomingRequestsAsSessions !== false
) {
Expand Down
1 change: 1 addition & 0 deletions packages/node/src/integrations/tracing/express.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,7 @@ export function expressErrorHandler(options?: ExpressHandlerOptions): ExpressMid

if (shouldHandleError(error)) {
const client = getClient<NodeClient>();
// eslint-disable-next-line deprecation/deprecation
if (client && client.getOptions().autoSessionTracking) {
// Check if the `SessionFlusher` is instantiated on the client to go into this branch that marks the
// `requestSession.status` as `Crashed`, and this check is necessary because the `SessionFlusher` is only
Expand Down
8 changes: 6 additions & 2 deletions packages/node/src/sdk/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -157,6 +157,7 @@ function _init(
logger.log(`Running in ${isCjs() ? 'CommonJS' : 'ESM'} mode.`);

// TODO(V9): Remove this code since all of the logic should be in an integration
// eslint-disable-next-line deprecation/deprecation
if (options.autoSessionTracking) {
startSessionTracking();
}
Expand DownExpand Up@@ -218,9 +219,11 @@ function getClientOptions(
const autoSessionTracking =
typeof release !== 'string'
? false
: options.autoSessionTracking === undefined
: // eslint-disable-next-line deprecation/deprecation
options.autoSessionTracking === undefined
? true
: options.autoSessionTracking;
: // eslint-disable-next-line deprecation/deprecation
options.autoSessionTracking;

if (options.spotlight == null) {
const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
Expand DownExpand Up@@ -315,6 +318,7 @@ function updateScopeFromEnvVariables(): void {
*/
function startSessionTracking(): void {
const client = getClient<NodeClient>();
// eslint-disable-next-line deprecation/deprecation
if (client && client.getOptions().autoSessionTracking) {
client.initSessionFlusher();
}
Expand Down
3 changes: 3 additions & 0 deletions packages/vercel-edge/src/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,14 +87,17 @@ export function init(options: VercelEdgeOptions = {}): Client | undefined {
options.release = detectedRelease;
} else {
// If release is not provided, then we should disable autoSessionTracking
// eslint-disable-next-line deprecation/deprecation
options.autoSessionTracking = false;
}
}

options.environment =
options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

// eslint-disable-next-line deprecation/deprecation
if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
// eslint-disable-next-line deprecation/deprecation
options.autoSessionTracking = true;
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: Deprecate autoSessionTracking#14640

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.

 Sign up for GitHub

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

lforst
merged 3 commits into

from

Dec 11, 2024
 Merged


feat: Deprecate autoSessionTracking#14640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8f503c8

feat: Deprecate `autoSessionTracking`

Dec 10, 2024
c7ea053

lint

Dec 10, 2024
0846471

review

Dec 11, 2024

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


5 changes: 5 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,11 @@
 In v9, we will streamline this behavior so that passing `undefined` will result in tracing being disabled, the same as not passing the option at all.
 If you are relying on `undefined` being passed in and having tracing enabled because of this, you should update your config to set e.g. `tracesSampleRate: 0` instead, which will also enable tracing in v9.

- **The `autoSessionTracking` option is deprecated.**

 To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.

## `@sentry/utils`

- **The `@sentry/utils` package has been deprecated. Import everything from `@sentry/core` instead.**
Expand Down

1 change: 1 addition & 0 deletions
packages/angular/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ export function getDefaultIntegrations(options: BrowserOptions = {}): Integratio
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ export function getDefaultIntegrations(options: Options): Integration[] {
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/server-runtime-client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 // eslint-disable-next-line deprecation/deprecation
 const requestSession = getIsolationScope().getRequestSession();
Expand All@@ -106,6 +107,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 const eventType = event.type || 'exception';
 const isException =
Expand Down

6 changes: 5 additions & 1 deletion
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp

 /**
 * A flag enabling Sessions Tracking feature.
 * By default, Sessions Tracking is enabled.
 * By default, Session Tracking is enabled.
 *
 * @deprecated Setting the `autoSessionTracking` option is deprecated.
 * To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 * To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.
 */
 autoSessionTracking?: boolean;

Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -147,6 +147,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 });

 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // eslint-disable-next-line deprecation/deprecation
 isolationScope.setRequestSession({ status: 'ok' });
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ interface HttpOptions {
 *
 * Note: If `autoSessionTracking` is set to `false` in `Sentry.init()` or the Client owning this integration, this option will be ignored.
 */
 // TODO(v9): Remove the note above.
 trackIncomingRequestsAsSessions?: boolean;

 /**
Expand DownExpand Up@@ -218,6 +219,7 @@ function getConfigWithDefaults(options: Partial<HttpOptions> = {}): HttpInstrume

 if (
 client &&
 // eslint-disable-next-line deprecation/deprecation
 client.getOptions().autoSessionTracking !== false &&
 options.trackIncomingRequestsAsSessions !== false
 ) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/tracing/express.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,7 @@ export function expressErrorHandler(options?: ExpressHandlerOptions): ExpressMid

 if (shouldHandleError(error)) {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // Check if the `SessionFlusher` is instantiated on the client to go into this branch that marks the
 // `requestSession.status` as `Crashed`, and this check is necessary because the `SessionFlusher` is only
Expand Down

8 changes: 6 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,6 +157,7 @@ function _init(
 logger.log(`Running in ${isCjs() ? 'CommonJS' : 'ESM'} mode.`);

 // TODO(V9): Remove this code since all of the logic should be in an integration
 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking) {
 startSessionTracking();
 }
Expand DownExpand Up@@ -218,9 +219,11 @@ function getClientOptions(
 const autoSessionTracking =
 typeof release !== 'string'
 ? false
 : options.autoSessionTracking === undefined
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking === undefined
 ? true
 : options.autoSessionTracking;
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
Expand DownExpand Up@@ -315,6 +318,7 @@ function updateScopeFromEnvVariables(): void {
 */
function startSessionTracking(): void {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 client.initSessionFlusher();
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/vercel-edge/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,14 +87,17 @@ export function init(options: VercelEdgeOptions = {}): Client | undefined {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = true;
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Deprecate autoSessionTracking#14640

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.

 Sign up for GitHub

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

lforst
merged 3 commits into

from

Dec 11, 2024
 Merged


feat: Deprecate autoSessionTracking#14640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8f503c8

feat: Deprecate `autoSessionTracking`

Dec 10, 2024
c7ea053

lint

Dec 10, 2024
0846471

review

Dec 11, 2024

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


5 changes: 5 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,11 @@
 In v9, we will streamline this behavior so that passing `undefined` will result in tracing being disabled, the same as not passing the option at all.
 If you are relying on `undefined` being passed in and having tracing enabled because of this, you should update your config to set e.g. `tracesSampleRate: 0` instead, which will also enable tracing in v9.

- **The `autoSessionTracking` option is deprecated.**

 To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.

## `@sentry/utils`

- **The `@sentry/utils` package has been deprecated. Import everything from `@sentry/core` instead.**
Expand Down

1 change: 1 addition & 0 deletions
packages/angular/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ export function getDefaultIntegrations(options: BrowserOptions = {}): Integratio
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ export function getDefaultIntegrations(options: Options): Integration[] {
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/server-runtime-client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 // eslint-disable-next-line deprecation/deprecation
 const requestSession = getIsolationScope().getRequestSession();
Expand All@@ -106,6 +107,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 const eventType = event.type || 'exception';
 const isException =
Expand Down

6 changes: 5 additions & 1 deletion
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp

 /**
 * A flag enabling Sessions Tracking feature.
 * By default, Sessions Tracking is enabled.
 * By default, Session Tracking is enabled.
 *
 * @deprecated Setting the `autoSessionTracking` option is deprecated.
 * To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 * To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.
 */
 autoSessionTracking?: boolean;

Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -147,6 +147,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 });

 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // eslint-disable-next-line deprecation/deprecation
 isolationScope.setRequestSession({ status: 'ok' });
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ interface HttpOptions {
 *
 * Note: If `autoSessionTracking` is set to `false` in `Sentry.init()` or the Client owning this integration, this option will be ignored.
 */
 // TODO(v9): Remove the note above.
 trackIncomingRequestsAsSessions?: boolean;

 /**
Expand DownExpand Up@@ -218,6 +219,7 @@ function getConfigWithDefaults(options: Partial<HttpOptions> = {}): HttpInstrume

 if (
 client &&
 // eslint-disable-next-line deprecation/deprecation
 client.getOptions().autoSessionTracking !== false &&
 options.trackIncomingRequestsAsSessions !== false
 ) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/tracing/express.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,7 @@ export function expressErrorHandler(options?: ExpressHandlerOptions): ExpressMid

 if (shouldHandleError(error)) {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // Check if the `SessionFlusher` is instantiated on the client to go into this branch that marks the
 // `requestSession.status` as `Crashed`, and this check is necessary because the `SessionFlusher` is only
Expand Down

8 changes: 6 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,6 +157,7 @@ function _init(
 logger.log(`Running in ${isCjs() ? 'CommonJS' : 'ESM'} mode.`);

 // TODO(V9): Remove this code since all of the logic should be in an integration
 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking) {
 startSessionTracking();
 }
Expand DownExpand Up@@ -218,9 +219,11 @@ function getClientOptions(
 const autoSessionTracking =
 typeof release !== 'string'
 ? false
 : options.autoSessionTracking === undefined
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking === undefined
 ? true
 : options.autoSessionTracking;
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
Expand DownExpand Up@@ -315,6 +318,7 @@ function updateScopeFromEnvVariables(): void {
 */
function startSessionTracking(): void {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 client.initSessionFlusher();
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/vercel-edge/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,14 +87,17 @@ export function init(options: VercelEdgeOptions = {}): Client | undefined {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = true;
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Deprecate autoSessionTracking#14640

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.

 Sign up for GitHub

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

lforst
merged 3 commits into

from

Dec 11, 2024
 Merged


feat: Deprecate autoSessionTracking#14640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8f503c8

feat: Deprecate `autoSessionTracking`

Dec 10, 2024
c7ea053

lint

Dec 10, 2024
0846471

review

Dec 11, 2024

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


5 changes: 5 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,11 @@
 In v9, we will streamline this behavior so that passing `undefined` will result in tracing being disabled, the same as not passing the option at all.
 If you are relying on `undefined` being passed in and having tracing enabled because of this, you should update your config to set e.g. `tracesSampleRate: 0` instead, which will also enable tracing in v9.

- **The `autoSessionTracking` option is deprecated.**

 To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.

## `@sentry/utils`

- **The `@sentry/utils` package has been deprecated. Import everything from `@sentry/core` instead.**
Expand Down

1 change: 1 addition & 0 deletions
packages/angular/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ export function getDefaultIntegrations(options: BrowserOptions = {}): Integratio
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ export function getDefaultIntegrations(options: Options): Integration[] {
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/server-runtime-client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 // eslint-disable-next-line deprecation/deprecation
 const requestSession = getIsolationScope().getRequestSession();
Expand All@@ -106,6 +107,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 const eventType = event.type || 'exception';
 const isException =
Expand Down

6 changes: 5 additions & 1 deletion
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp

 /**
 * A flag enabling Sessions Tracking feature.
 * By default, Sessions Tracking is enabled.
 * By default, Session Tracking is enabled.
 *
 * @deprecated Setting the `autoSessionTracking` option is deprecated.
 * To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 * To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.
 */
 autoSessionTracking?: boolean;

Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -147,6 +147,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 });

 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // eslint-disable-next-line deprecation/deprecation
 isolationScope.setRequestSession({ status: 'ok' });
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ interface HttpOptions {
 *
 * Note: If `autoSessionTracking` is set to `false` in `Sentry.init()` or the Client owning this integration, this option will be ignored.
 */
 // TODO(v9): Remove the note above.
 trackIncomingRequestsAsSessions?: boolean;

 /**
Expand DownExpand Up@@ -218,6 +219,7 @@ function getConfigWithDefaults(options: Partial<HttpOptions> = {}): HttpInstrume

 if (
 client &&
 // eslint-disable-next-line deprecation/deprecation
 client.getOptions().autoSessionTracking !== false &&
 options.trackIncomingRequestsAsSessions !== false
 ) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/tracing/express.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,7 @@ export function expressErrorHandler(options?: ExpressHandlerOptions): ExpressMid

 if (shouldHandleError(error)) {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // Check if the `SessionFlusher` is instantiated on the client to go into this branch that marks the
 // `requestSession.status` as `Crashed`, and this check is necessary because the `SessionFlusher` is only
Expand Down

8 changes: 6 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,6 +157,7 @@ function _init(
 logger.log(`Running in ${isCjs() ? 'CommonJS' : 'ESM'} mode.`);

 // TODO(V9): Remove this code since all of the logic should be in an integration
 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking) {
 startSessionTracking();
 }
Expand DownExpand Up@@ -218,9 +219,11 @@ function getClientOptions(
 const autoSessionTracking =
 typeof release !== 'string'
 ? false
 : options.autoSessionTracking === undefined
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking === undefined
 ? true
 : options.autoSessionTracking;
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
Expand DownExpand Up@@ -315,6 +318,7 @@ function updateScopeFromEnvVariables(): void {
 */
function startSessionTracking(): void {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 client.initSessionFlusher();
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/vercel-edge/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,14 +87,17 @@ export function init(options: VercelEdgeOptions = {}): Client | undefined {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = true;
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: Deprecate autoSessionTracking#14640

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.

 Sign up for GitHub

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

lforst
merged 3 commits into

from

Dec 11, 2024
 Merged


feat: Deprecate autoSessionTracking#14640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8f503c8

feat: Deprecate `autoSessionTracking`

Dec 10, 2024
c7ea053

lint

Dec 10, 2024
0846471

review

Dec 11, 2024

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


5 changes: 5 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,11 @@
 In v9, we will streamline this behavior so that passing `undefined` will result in tracing being disabled, the same as not passing the option at all.
 If you are relying on `undefined` being passed in and having tracing enabled because of this, you should update your config to set e.g. `tracesSampleRate: 0` instead, which will also enable tracing in v9.

- **The `autoSessionTracking` option is deprecated.**

 To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.

## `@sentry/utils`

- **The `@sentry/utils` package has been deprecated. Import everything from `@sentry/core` instead.**
Expand Down

1 change: 1 addition & 0 deletions
packages/angular/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ export function getDefaultIntegrations(options: BrowserOptions = {}): Integratio
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ export function getDefaultIntegrations(options: Options): Integration[] {
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/server-runtime-client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 // eslint-disable-next-line deprecation/deprecation
 const requestSession = getIsolationScope().getRequestSession();
Expand All@@ -106,6 +107,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 const eventType = event.type || 'exception';
 const isException =
Expand Down

6 changes: 5 additions & 1 deletion
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp

 /**
 * A flag enabling Sessions Tracking feature.
 * By default, Sessions Tracking is enabled.
 * By default, Session Tracking is enabled.
 *
 * @deprecated Setting the `autoSessionTracking` option is deprecated.
 * To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 * To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.
 */
 autoSessionTracking?: boolean;

Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -147,6 +147,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 });

 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // eslint-disable-next-line deprecation/deprecation
 isolationScope.setRequestSession({ status: 'ok' });
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ interface HttpOptions {
 *
 * Note: If `autoSessionTracking` is set to `false` in `Sentry.init()` or the Client owning this integration, this option will be ignored.
 */
 // TODO(v9): Remove the note above.
 trackIncomingRequestsAsSessions?: boolean;

 /**
Expand DownExpand Up@@ -218,6 +219,7 @@ function getConfigWithDefaults(options: Partial<HttpOptions> = {}): HttpInstrume

 if (
 client &&
 // eslint-disable-next-line deprecation/deprecation
 client.getOptions().autoSessionTracking !== false &&
 options.trackIncomingRequestsAsSessions !== false
 ) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/tracing/express.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,7 @@ export function expressErrorHandler(options?: ExpressHandlerOptions): ExpressMid

 if (shouldHandleError(error)) {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // Check if the `SessionFlusher` is instantiated on the client to go into this branch that marks the
 // `requestSession.status` as `Crashed`, and this check is necessary because the `SessionFlusher` is only
Expand Down

8 changes: 6 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,6 +157,7 @@ function _init(
 logger.log(`Running in ${isCjs() ? 'CommonJS' : 'ESM'} mode.`);

 // TODO(V9): Remove this code since all of the logic should be in an integration
 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking) {
 startSessionTracking();
 }
Expand DownExpand Up@@ -218,9 +219,11 @@ function getClientOptions(
 const autoSessionTracking =
 typeof release !== 'string'
 ? false
 : options.autoSessionTracking === undefined
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking === undefined
 ? true
 : options.autoSessionTracking;
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
Expand DownExpand Up@@ -315,6 +318,7 @@ function updateScopeFromEnvVariables(): void {
 */
function startSessionTracking(): void {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 client.initSessionFlusher();
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/vercel-edge/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,14 +87,17 @@ export function init(options: VercelEdgeOptions = {}): Client | undefined {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = true;
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Deprecate autoSessionTracking#14640

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.

 Sign up for GitHub

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

lforst
merged 3 commits into

from

Dec 11, 2024
 Merged


feat: Deprecate autoSessionTracking#14640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8f503c8

feat: Deprecate `autoSessionTracking`

Dec 10, 2024
c7ea053

lint

Dec 10, 2024
0846471

review

Dec 11, 2024

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


5 changes: 5 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,11 @@
 In v9, we will streamline this behavior so that passing `undefined` will result in tracing being disabled, the same as not passing the option at all.
 If you are relying on `undefined` being passed in and having tracing enabled because of this, you should update your config to set e.g. `tracesSampleRate: 0` instead, which will also enable tracing in v9.

- **The `autoSessionTracking` option is deprecated.**

 To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.

## `@sentry/utils`

- **The `@sentry/utils` package has been deprecated. Import everything from `@sentry/core` instead.**
Expand Down

1 change: 1 addition & 0 deletions
packages/angular/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ export function getDefaultIntegrations(options: BrowserOptions = {}): Integratio
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ export function getDefaultIntegrations(options: Options): Integration[] {
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/server-runtime-client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 // eslint-disable-next-line deprecation/deprecation
 const requestSession = getIsolationScope().getRequestSession();
Expand All@@ -106,6 +107,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 const eventType = event.type || 'exception';
 const isException =
Expand Down

6 changes: 5 additions & 1 deletion
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp

 /**
 * A flag enabling Sessions Tracking feature.
 * By default, Sessions Tracking is enabled.
 * By default, Session Tracking is enabled.
 *
 * @deprecated Setting the `autoSessionTracking` option is deprecated.
 * To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 * To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.
 */
 autoSessionTracking?: boolean;

Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -147,6 +147,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 });

 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // eslint-disable-next-line deprecation/deprecation
 isolationScope.setRequestSession({ status: 'ok' });
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ interface HttpOptions {
 *
 * Note: If `autoSessionTracking` is set to `false` in `Sentry.init()` or the Client owning this integration, this option will be ignored.
 */
 // TODO(v9): Remove the note above.
 trackIncomingRequestsAsSessions?: boolean;

 /**
Expand DownExpand Up@@ -218,6 +219,7 @@ function getConfigWithDefaults(options: Partial<HttpOptions> = {}): HttpInstrume

 if (
 client &&
 // eslint-disable-next-line deprecation/deprecation
 client.getOptions().autoSessionTracking !== false &&
 options.trackIncomingRequestsAsSessions !== false
 ) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/tracing/express.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,7 @@ export function expressErrorHandler(options?: ExpressHandlerOptions): ExpressMid

 if (shouldHandleError(error)) {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // Check if the `SessionFlusher` is instantiated on the client to go into this branch that marks the
 // `requestSession.status` as `Crashed`, and this check is necessary because the `SessionFlusher` is only
Expand Down

8 changes: 6 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,6 +157,7 @@ function _init(
 logger.log(`Running in ${isCjs() ? 'CommonJS' : 'ESM'} mode.`);

 // TODO(V9): Remove this code since all of the logic should be in an integration
 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking) {
 startSessionTracking();
 }
Expand DownExpand Up@@ -218,9 +219,11 @@ function getClientOptions(
 const autoSessionTracking =
 typeof release !== 'string'
 ? false
 : options.autoSessionTracking === undefined
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking === undefined
 ? true
 : options.autoSessionTracking;
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
Expand DownExpand Up@@ -315,6 +318,7 @@ function updateScopeFromEnvVariables(): void {
 */
function startSessionTracking(): void {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 client.initSessionFlusher();
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/vercel-edge/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,14 +87,17 @@ export function init(options: VercelEdgeOptions = {}): Client | undefined {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = true;
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Deprecate autoSessionTracking#14640

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.

 Sign up for GitHub

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

lforst
merged 3 commits into

from

Dec 11, 2024
 Merged


feat: Deprecate autoSessionTracking#14640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8f503c8

feat: Deprecate `autoSessionTracking`

Dec 10, 2024
c7ea053

lint

Dec 10, 2024
0846471

review

Dec 11, 2024

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


5 changes: 5 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,11 @@
 In v9, we will streamline this behavior so that passing `undefined` will result in tracing being disabled, the same as not passing the option at all.
 If you are relying on `undefined` being passed in and having tracing enabled because of this, you should update your config to set e.g. `tracesSampleRate: 0` instead, which will also enable tracing in v9.

- **The `autoSessionTracking` option is deprecated.**

 To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.

## `@sentry/utils`

- **The `@sentry/utils` package has been deprecated. Import everything from `@sentry/core` instead.**
Expand Down

1 change: 1 addition & 0 deletions
packages/angular/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ export function getDefaultIntegrations(options: BrowserOptions = {}): Integratio
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ export function getDefaultIntegrations(options: Options): Integration[] {
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/server-runtime-client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 // eslint-disable-next-line deprecation/deprecation
 const requestSession = getIsolationScope().getRequestSession();
Expand All@@ -106,6 +107,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 const eventType = event.type || 'exception';
 const isException =
Expand Down

6 changes: 5 additions & 1 deletion
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp

 /**
 * A flag enabling Sessions Tracking feature.
 * By default, Sessions Tracking is enabled.
 * By default, Session Tracking is enabled.
 *
 * @deprecated Setting the `autoSessionTracking` option is deprecated.
 * To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 * To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.
 */
 autoSessionTracking?: boolean;

Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -147,6 +147,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 });

 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // eslint-disable-next-line deprecation/deprecation
 isolationScope.setRequestSession({ status: 'ok' });
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ interface HttpOptions {
 *
 * Note: If `autoSessionTracking` is set to `false` in `Sentry.init()` or the Client owning this integration, this option will be ignored.
 */
 // TODO(v9): Remove the note above.
 trackIncomingRequestsAsSessions?: boolean;

 /**
Expand DownExpand Up@@ -218,6 +219,7 @@ function getConfigWithDefaults(options: Partial<HttpOptions> = {}): HttpInstrume

 if (
 client &&
 // eslint-disable-next-line deprecation/deprecation
 client.getOptions().autoSessionTracking !== false &&
 options.trackIncomingRequestsAsSessions !== false
 ) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/tracing/express.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,7 @@ export function expressErrorHandler(options?: ExpressHandlerOptions): ExpressMid

 if (shouldHandleError(error)) {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // Check if the `SessionFlusher` is instantiated on the client to go into this branch that marks the
 // `requestSession.status` as `Crashed`, and this check is necessary because the `SessionFlusher` is only
Expand Down

8 changes: 6 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,6 +157,7 @@ function _init(
 logger.log(`Running in ${isCjs() ? 'CommonJS' : 'ESM'} mode.`);

 // TODO(V9): Remove this code since all of the logic should be in an integration
 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking) {
 startSessionTracking();
 }
Expand DownExpand Up@@ -218,9 +219,11 @@ function getClientOptions(
 const autoSessionTracking =
 typeof release !== 'string'
 ? false
 : options.autoSessionTracking === undefined
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking === undefined
 ? true
 : options.autoSessionTracking;
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
Expand DownExpand Up@@ -315,6 +318,7 @@ function updateScopeFromEnvVariables(): void {
 */
function startSessionTracking(): void {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 client.initSessionFlusher();
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/vercel-edge/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,14 +87,17 @@ export function init(options: VercelEdgeOptions = {}): Client | undefined {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = true;
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: Deprecate autoSessionTracking#14640

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.

 Sign up for GitHub

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

lforst
merged 3 commits into

from

Dec 11, 2024
 Merged


feat: Deprecate autoSessionTracking#14640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8f503c8

feat: Deprecate `autoSessionTracking`

Dec 10, 2024
c7ea053

lint

Dec 10, 2024
0846471

review

Dec 11, 2024

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


5 changes: 5 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,11 @@
 In v9, we will streamline this behavior so that passing `undefined` will result in tracing being disabled, the same as not passing the option at all.
 If you are relying on `undefined` being passed in and having tracing enabled because of this, you should update your config to set e.g. `tracesSampleRate: 0` instead, which will also enable tracing in v9.

- **The `autoSessionTracking` option is deprecated.**

 To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.

## `@sentry/utils`

- **The `@sentry/utils` package has been deprecated. Import everything from `@sentry/core` instead.**
Expand Down

1 change: 1 addition & 0 deletions
packages/angular/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ export function getDefaultIntegrations(options: BrowserOptions = {}): Integratio
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ export function getDefaultIntegrations(options: Options): Integration[] {
 httpContextIntegration(),
 ];

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking !== false) {
 integrations.push(browserSessionIntegration());
 }
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/server-runtime-client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -84,6 +84,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 // eslint-disable-next-line deprecation/deprecation
 const requestSession = getIsolationScope().getRequestSession();
Expand All@@ -106,6 +107,7 @@ export class ServerRuntimeClient<
 // The expectation is that session aggregates are only sent when `autoSessionTracking` is enabled.
 // TODO(v9): Our goal in the future is to not have the `autoSessionTracking` option and instead rely on integrations doing the creation and sending of sessions. We will not have a central kill-switch for sessions.
 // TODO(v9): This should move into the httpIntegration.
 // eslint-disable-next-line deprecation/deprecation
 if (this._options.autoSessionTracking && this._sessionFlusher) {
 const eventType = event.type || 'exception';
 const isException =
Expand Down

6 changes: 5 additions & 1 deletion
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp

 /**
 * A flag enabling Sessions Tracking feature.
 * By default, Sessions Tracking is enabled.
 * By default, Session Tracking is enabled.
 *
 * @deprecated Setting the `autoSessionTracking` option is deprecated.
 * To enable session tracking, it is recommended to unset `autoSessionTracking` and ensure that either, in browser environments the `browserSessionIntegration` is added, or in server environments the `httpIntegration` is added.
 * To disable session tracking, it is recommended unset `autoSessionTracking` and to remove the `browserSessionIntegration` in browser environments, or in server environments configure the `httpIntegration` with the `trackIncomingRequestsAsSessions` option set to `false`.
 */
 autoSessionTracking?: boolean;

Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -147,6 +147,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 });

 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // eslint-disable-next-line deprecation/deprecation
 isolationScope.setRequestSession({ status: 'ok' });
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ interface HttpOptions {
 *
 * Note: If `autoSessionTracking` is set to `false` in `Sentry.init()` or the Client owning this integration, this option will be ignored.
 */
 // TODO(v9): Remove the note above.
 trackIncomingRequestsAsSessions?: boolean;

 /**
Expand DownExpand Up@@ -218,6 +219,7 @@ function getConfigWithDefaults(options: Partial<HttpOptions> = {}): HttpInstrume

 if (
 client &&
 // eslint-disable-next-line deprecation/deprecation
 client.getOptions().autoSessionTracking !== false &&
 options.trackIncomingRequestsAsSessions !== false
 ) {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/integrations/tracing/express.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,6 +122,7 @@ export function expressErrorHandler(options?: ExpressHandlerOptions): ExpressMid

 if (shouldHandleError(error)) {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 // Check if the `SessionFlusher` is instantiated on the client to go into this branch that marks the
 // `requestSession.status` as `Crashed`, and this check is necessary because the `SessionFlusher` is only
Expand Down

8 changes: 6 additions & 2 deletions
packages/node/src/sdk/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,6 +157,7 @@ function _init(
 logger.log(`Running in ${isCjs() ? 'CommonJS' : 'ESM'} mode.`);

 // TODO(V9): Remove this code since all of the logic should be in an integration
 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking) {
 startSessionTracking();
 }
Expand DownExpand Up@@ -218,9 +219,11 @@ function getClientOptions(
 const autoSessionTracking =
 typeof release !== 'string'
 ? false
 : options.autoSessionTracking === undefined
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking === undefined
 ? true
 : options.autoSessionTracking;
 : // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking;

 if (options.spotlight == null) {
 const spotlightEnv = envToBool(process.env.SENTRY_SPOTLIGHT, { strict: true });
Expand DownExpand Up@@ -315,6 +318,7 @@ function updateScopeFromEnvVariables(): void {
 */
function startSessionTracking(): void {
 const client = getClient<NodeClient>();
 // eslint-disable-next-line deprecation/deprecation
 if (client && client.getOptions().autoSessionTracking) {
 client.initSessionFlusher();
 }
Expand Down

3 changes: 3 additions & 0 deletions
packages/vercel-edge/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,14 +87,17 @@ export function init(options: VercelEdgeOptions = {}): Client | undefined {
 options.release = detectedRelease;
 } else {
 // If release is not provided, then we should disable autoSessionTracking
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = false;
 }
 }

 options.environment =
 options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV;

 // eslint-disable-next-line deprecation/deprecation
 if (options.autoSessionTracking === undefined && options.dsn !== undefined) {
 // eslint-disable-next-line deprecation/deprecation
 options.autoSessionTracking = true;
 }

Expand Down