Skip to content

Commit 22643ef

Browse files
committed
improve wording, add todos
1 parent 77bcd32 commit 22643ef

File tree

1 file changed

+5
-4
lines changed
  • packages/aws-serverless/src

1 file changed

+5
-4
lines changed

packages/aws-serverless/src/sdk.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,10 @@ export interface WrapperOptions {
4545
* @default false
4646
*/
4747
captureAllSettledReasons: boolean;
48+
// TODO(v11): Remove this option since its no longer used.
4849
/**
49-
* @deprecated This option has no effect since OpenTelemetry always traces the handler.
50-
* If you want to disable tracing, set `SENTRY_TRACES_SAMPLE_RATE` to `0.0`.
50+
* @deprecated This option has no effect and will be removed in a future major version.
51+
* If you want to disable tracing, set `SENTRY_TRACES_SAMPLE_RATE` to `0.0`, otherwise OpenTelemetry will automatically trace the handler.
5152
*/
5253
startTrace: boolean;
5354
}
@@ -215,7 +216,7 @@ export function wrapHandler<TEvent, TResult>(
215216
consoleSandbox(() => {
216217
// eslint-disable-next-line no-console
217218
console.warn(
218-
'The `startTrace` option is deprecated and has no effect since OpenTelemetry always traces the handler. If you want to disable tracing, set `SENTRY_TRACES_SAMPLE_RATE` to `0.0`.',
219+
'The `startTrace` option is deprecated and will be removed in a future major version. If you want to disable tracing, set `SENTRY_TRACES_SAMPLE_RATE` to `0.0`.',
219220
);
220221
});
221222
}
@@ -226,7 +227,7 @@ export function wrapHandler<TEvent, TResult>(
226227
captureTimeoutWarning: true,
227228
timeoutWarningLimit: 500,
228229
captureAllSettledReasons: false,
229-
startTrace: true,
230+
startTrace: true, // TODO(v11): Remove this option. Set to true here to satisfy the type, but has no effect.
230231
...wrapOptions,
231232
};
232233

0 commit comments

Comments
 (0)