Capturing messages or exceptions from library won't be included in the Sentry client of the application

[Zandor300]

Capturing messages or exceptions from library won't be included in the Sentry client of the application

[mydea]

Hello,

so just to clarify, what you are doing is: You have a library, that other users (or teams) embed in their applications. These applications have dedicated Sentry SDK setups (e.g. each has it's own init) and each app runs separately from each other. And you'd like to capture errors from the library to the host-apps Sentry.

Did I get that correctly?

If this is the case, what you should do is depend on @sentry/core and do this:

import { captureException } from '@sentry/core';

captureException(...);

This should capture to the host app. However, please bear in mind that in order for this to work, it is essential that the version of Sentry SDKs are fully aligned - e.g. if the host app uses @sentry/[email protected], the library must also use @sentry/[email protected]. Otherwise, if the versions mismatch, you may not capture stuff correctly.

[Zandor300]

@mydea Thanks! Alternative would be to init a Sentry instance for the library itself? But that would mean you have the Sentry SDK for the application running and another for the library. Then you wouldn’t have issues with version mismatches?

Will calls to captureException go to the SDK instance of the library when called from the library? Or do you need to reference the SDK instance of the library specifically to achieve that?

What would be the best approach with the least possibility of issues?

[AbhiPrasad]

Alternative would be to init a Sentry instance for the library itself? But that would mean you have the Sentry SDK for the application running and another for the library. Then you wouldn’t have issues with version mismatches?

Yes there would be, so we recommend that the library instance does not do any global patching. We have docs around browser extensions which is basically the same scenario as this: https://docs.sentry.io/platforms/javascript/best-practices/browser-extensions/

Will calls to captureException go to the SDK instance of the library when called from the library? Or do you need to reference the SDK instance of the library specifically to achieve that?

A global Sentry.captureException call will go to the currently active client, which usually is the host that wraps the library. Hence we recommend directly using a client and capturing exceptions as needed in the library.

Please note that diverging versions of an SDK will add to your bundle size! You'll have multiple versions of sentry js code loaded for your users.