Skip to content

Commit 7f4ad8c

Browse files
committed
feat(js): Add docs for disableInstrumentationWarnings
1 parent 4cb86f3 commit 7f4ad8c

File tree

1 file changed

+14
-0
lines changed
  • docs/platforms/javascript/common/configuration

1 file changed

+14
-0
lines changed

docs/platforms/javascript/common/configuration/options.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,20 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events
237237

238238
</SdkOption>
239239

240+
<SdkOption name="disableInstrumentationWarnings" type='boolean' defaultValue='false' categorySupported={['server']}>
241+
242+
Depending on your setup, the Sentry SDK will try to detect if it has been incorrectly set up. This can result in warnings like this being logged:
243+
244+
> [Sentry] < libraryName > is not instrumented. This is likely because you required/imported < libraryName > before calling `Sentry.init()`.
245+
246+
Or
247+
248+
> [Sentry] < libraryName > is not instrumented. Please make sure to initialize Sentry in a separate file that you \`--import\` when running node, see: < docs link >.
249+
250+
This means that the SDK detected the library to not have been wrapped for auto performance instrumentation. This may result in some spans not being correctly reported. If this is not affecting you (e.g. because the warning is a false positive or you do not care about these specific spans), you can disable this warning by setting this option to `true`.
251+
252+
</SdkOption>
253+
240254
<PlatformSection supported={['javascript.electron']}>
241255
<SdkOption name="ipcMode" type="'IPCMode.Classic' | 'IPCMode.Protocol' | 'IPCMode.Both'" defaultValue="'IPCMode.Both'">
242256

0 commit comments

Comments
 (0)