Skip to content

docs(JS): Add docs for ZodErrors #14630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 13, 2025
Merged

docs(JS): Add docs for ZodErrors #14630

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/zodErrors.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: ZodErrors
description: "Adds additional data to Zod validation errors."
---

_Import name: `Sentry.zodErrorsIntegration`_

The Zod Errors integration enhances error reporting for applications using [Zod](https://zod.dev/) schema validation.
When Zod validation fails, this integration captures detailed validation errors (`ZodError` instances) and attaches them
as additional data to Sentry events.

The Zod Errors integration is not enabled by default. You need to add it to your Sentry configuration:

```javascript
Sentry.init({
integrations: [
Sentry.zodErrorsIntegration(),
],
});
```

## Options

The `zodErrorsIntegration` accepts the following options:

### `limit`

_Type: `number`_
_Default: `10`_

Limits the number of Zod errors inlined in each Sentry event.

### `saveZodIssuesAsAttachment`

_Type: `boolean`_
_Default: `false`_

Save full list of Zod issues as a JSON attachment in Sentry.

## Example Additional Error Data

When a Zod validation error occurs, you'll see enhanced error information in Sentry like this:

```json
[
{
"code": "too_small",
"path": ["name"],
"message": "Name is required",
"minimum": 1,
"type": "string",
"inclusive": true,
"received": ""
},
{
"code": "invalid_string",
"path": ["email"],
"message": "Invalid email format",
"validation": "email",
"received": "invalid-email"
}
]
```
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.astro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,4 @@ Depending on whether an integration enhances the functionality of a particular r
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.aws-lambda.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,4 @@
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | |
| [`tediousIntegration`](./tedious) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.bun.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,4 @@
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.connect.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`prismaIntegration`](./prisma) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.deno.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | | ✓ |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
3 changes: 2 additions & 1 deletion platform-includes/configuration/integrations/javascript.fastify.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,6 @@
| [`localVariablesIntegration`](./localvariables) | | ✓ | | |
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.gcp-functions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,4 @@
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | |
| [`tediousIntegration`](./tedious) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.hapi.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,4 @@
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.nestjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,4 @@
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`unleashIntegration`](./unleash) | | | | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.nextjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`vercelAiIntegration`](./vercelai) | ✓ | | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |

### Edge Integrations

Expand Down
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.node.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@
| [`tediousIntegration`](./tedious) | ✓ | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.nuxt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,4 @@ Depending on whether an integration enhances the functionality of a particular r
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.remix.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,4 @@ Depending on whether an integration enhances the functionality of a particular r
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.solidstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,4 @@ Depending on whether an integration enhances the functionality of a particular r
| [`nodeProfilingIntegration`](./nodeprofiling) | | | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |
1 change: 1 addition & 0 deletions platform-includes/configuration/integrations/javascript.sveltekit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,4 @@ Depending on whether an integration enhances the functionality of a particular r
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | |
| [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ |
| [`openAIIntegration`](./openai) | ✓ | | ✓ | |
| [`zodErrorsIntegration`](./zodErrors) | | | | ✓ |