diff --git a/src/platform-includes/configuration/before-send-hint/javascript.mdx b/src/platform-includes/configuration/before-send-hint/javascript.mdx index b6f591024fd8c..69e60d1be94bc 100644 --- a/src/platform-includes/configuration/before-send-hint/javascript.mdx +++ b/src/platform-includes/configuration/before-send-hint/javascript.mdx @@ -3,17 +3,13 @@ Sentry.init({ // ... beforeSend(event, hint) { - const error = hint.originalException; if ( - error && - error.message && - error.message.match(/database unavailable/i) + hint.originalException instanceof DOMException && + hint.originalException.name === "NotSupportedError" ) { - event.fingerprint = ["database-unavailable"]; + return null; } return event; }, }); ``` - -For information about which hints are available see hints in JavaScript. diff --git a/src/platforms/common/configuration/filtering.mdx b/src/platforms/common/configuration/filtering.mdx index 994ce8f38b4cc..cf006290ca2c5 100644 --- a/src/platforms/common/configuration/filtering.mdx +++ b/src/platforms/common/configuration/filtering.mdx @@ -12,13 +12,13 @@ The Sentry SDKs have several configuration options to help you filter out events We also offer [Inbound Filters](/product/data-management-settings/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). -## Filtering Error Events +## Filtering Events -Configure your SDK to filter error events by using the callback method and configuring, enabling, or disabling integrations. +Configure your SDK to filter error and transaction events by using the and callback methods, respectively, by using event processors, or by configuring, enabling, or disabling integrations. -### Using +### Using and -All Sentry SDKs support the callback method. is called immediately before the event is sent to the server, so it’s the final place where you can edit its data. It receives the event object as a parameter, so you can use that to modify the event’s data or drop it completely (by returning `null`) based on custom logic and the data available on the event. +All Sentry SDKs support the callback method for error and message events. Some SDKs also support the callback method for transaction events. and are called immediately before the event is sent to the server, so they're the final place you can edit an event's data. They receive the event object as a parameter, which you can use to modify the event's data or to drop the event completely (by returning `null`) based on custom logic and the data available on the event. @@ -28,13 +28,19 @@ Note also that breadcrumbs can be filtered, as discussed in [our Breadcrumbs doc #### Event Hints -The callback is passed both the `event` and a second argument, `hint`, that holds one or more hints. +The and callbacks are passed both the event object and a second argument, `hint`, which holds extra data about the event. -Typically a `hint` holds the original exception so that additional data can be extracted or grouping is affected. In this example, the fingerprint is forced to a common value if an exception of a certain type has been caught: +When the SDK creates an event or breadcrumb for transmission, that transmission is typically created from some sort of source object. For instance, a message event is typically created from a log record and an error event is typically created from an exception instance. For better customization, SDKs pass these objects in the hint to , (on supported platforms), , and event processors. + +For example, for error events, `hint` holds the original exception so that additional data can be extracted or grouping behavior can be modified. + +In the snippet below, the event is conditionally dropped based on data in the hint: -When the SDK creates an event or breadcrumb for transmission, that transmission is typically created from some sort of source object. For instance, an error event is typically created from a log record or exception instance. For better customization, SDKs send these objects to certain callbacks (, or the event processor system in the SDK). +In this snippet, the fingerprint is forced to a common value if an exception of a certain type has been caught: + + @@ -42,30 +48,50 @@ When the SDK creates an event or breadcrumb for transmission, that transmission ### Using Hints -Hints are available in two places: - -1. / -2. `eventProcessors` - -Event and breadcrumb `hints` are objects containing various information used to put together an event or a breadcrumb. Typically `hints` hold the original exception so that additional data can be extracted or grouping can be affected. +Hints are available in four places: -For events, hints contain properties such as `event_id`, `originalException`, `syntheticException` (used internally to generate cleaner stack trace), and any other arbitrary `data` that you attach. +1. +2. (on supported platforms) +3. +4. event processors -For breadcrumbs, the use of `hints` is implementation dependent. For XHR requests, the hint contains the xhr object itself; for user interactions the hint contains the DOM element and event name and so forth. +Event and breadcrumb hints are objects containing various information used to put together an event or a breadcrumb. For example, for error events, hints hold the original exception so that additional data can be extracted or grouping can be affected. For breadcrumbs, the use of hints is implementation-dependent. For XHR requests for instance, the hint contains the xhr object itself; for user interactions the hint contains the DOM element and event name, and so forth. -In this example, the fingerprint is forced to a common value if an exception of a certain type has been caught: +#### Hints for Events - +`eventId` -#### Hints for Events +: A unique identifier for the event, searchable in the Sentry UI. Available in message, error, and transaction events. `originalException` -: The original exception that caused the Sentry SDK to create the event. This is useful for changing how the Sentry SDK groups events or to extract additional information. +: The original exception that caused the Sentry SDK to create the event. This is useful for changing how the Sentry SDK groups events or to extract additional information. Available in error events. `syntheticException` -: When a string or a non-error object is raised, Sentry creates a synthetic exception so you can get a basic stack trace. This exception is stored here for further data extraction. +: When a string or a non-error object is raised, Sentry creates a synthetic exception so you can get a basic stack trace. This exception is stored here for further data extraction. Available in error events. + + + +`captureContext` + +: Additional scope data passed as a second parameter to `captureMessage` and a third parameter to `captureException` and `captureEvent`. Available in message and error events. + + + + + +`attachments` + +: Files to be attached to the outgoing event. Available in message, error, and transaction events. + + + + + +Any other data passed in the second parameter to `captureException` or `captureEvent`. Available in message and error events. + + #### Hints for Breadcrumbs @@ -75,7 +101,9 @@ In this example, the fingerprint is forced to a common value if an exception of -### Decluttering Sentry +### Filtering by Script URL, Error Message, or Logger + +Depending on the SDK, you may be able to filter events automatically based on certain criteria.