Skip to content

Commit f129e57

Browse files
authored
fix(develop): Clarify that before_send should not apply to check-ins (#14972)
1 parent 7a65d77 commit f129e57

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

develop-docs/sdk/expected-features/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ Whenever possible, avoid adding the attachment altogether if taking the screensh
233233

234234
## Before-Send Hook
235235

236-
Hook called with the event (and on some platforms the hint) that allows the user to decide whether an event should be sent or not. This can also be used to further modify the event. This only works for `error` events. For `transactions` it is recommended to have `beforeSendTransaction` implemented in SDKs. To understand when you should call this in your SDK, please refer to the [error filter ordering of sessions](/sdk/telemetry/sessions/#filter-order).
236+
Hook called with the event (and on some platforms the hint) that allows the user to decide whether an event should be sent or not. This can also be used to further modify the event. This only works for `error` events. Other event types like `transactions` and `check-ins` **should not** go through `beforeSend`. For `transactions` it is recommended to have `beforeSendTransaction` implemented in SDKs. For `check-ins` you can optionally implement `beforeSendCheckIn`. To understand when you should call this in your SDK, please refer to the [error filter ordering of sessions](/sdk/telemetry/sessions/#filter-order).
237237

238238
## Before-Breadcrumb Hook
239239

develop-docs/sdk/telemetry/check-ins.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,7 @@ monitors frontend APIs.
159159
`unit`
160160

161161
: **String, required**. The interval unit. Should be one of `year`, `month`, `week`, `day`, `hour`, `minute`.
162+
163+
## Interaction with `beforeSend`
164+
165+
Check-in events in the SDK should **not** go through `beforeSend`. SDKs can optionally implement a dedicated `beforeSendCheckIn` hook that only applies to check-in events.

0 commit comments

Comments
 (0)