diff --git a/docs/platforms/javascript/common/configuration/integrations/pino.mdx b/docs/platforms/javascript/common/configuration/integrations/pino.mdx new file mode 100644 index 0000000000000..a5339e69ac7d6 --- /dev/null +++ b/docs/platforms/javascript/common/configuration/integrations/pino.mdx @@ -0,0 +1,101 @@ +--- +title: Pino +description: "Capture logs and errors from Pino." +supported: + - javascript.node + - javascript.astro + - javascript.aws-lambda + - javascript.azure-functions + - javascript.connect + - javascript.deno + - javascript.express + - javascript.fastify + - javascript.gcp-functions + - javascript.hapi + - javascript.hono + - javascript.koa + - javascript.electron + - javascript.nestjs + - javascript.nextjs + - javascript.nuxt + - javascript.solidstart + - javascript.sveltekit + - javascript.remix + - javascript.react-router + - javascript.astro + - javascript.bun + - javascript.tanstackstart-react +--- + + + +This integration only works in the Node.js and Bun runtimes. Requires SDK version `10.18.0` or higher. + + + +_Import name: `Sentry.pinoIntegration`_ + +The `pinoIntegration` adds instrumentation for the `pino` library so that calls to the pino logger as captured as logs. Optionally, you can capture calls to the pino logger as errors. + +```JavaScript +Sentry.init({ + integrations: [Sentry.pinoIntegration()], +}); +``` + +## Options + +### `error` + +Configure how pino logs are captured as Sentry errors. + +#### `levels` + +- Type: `Array<'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal'>` +- Default: `[]` + +Levels that trigger capturing of events. When a pino log message is logged at one of these levels, it will be captured as a Sentry error event. + +#### `handled` + +- Type: `boolean` +- Default: `true` + +By default, Sentry will mark captured errors as handled. Set this to `false` if you want to mark them as unhandled instead. + +### `log` + +Configure how pino logs are captured as Sentry logs. + +#### `levels` + +- Type: `Array<'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal'>` +- Default: `["trace", "debug", "info", "warn", "error", "fatal"]` + +Levels that trigger capturing of logs. Logs are only captured if `enableLogs` is enabled in your Sentry configuration. + +## Supported Versions + +- `pino`: `>=8.0.0 <10` + +## Examples + +### Send only info, error, and warn log levels to Sentry + +```js +Sentry.init({ + integrations: [ + Sentry.pinoIntegration({ log: { levels: ["info", "warn", "error"] } }), + ], +}); +``` + +### Send errors to Sentry + +```js +Sentry.init({ + integrations: [ + Sentry.pinoIntegration({ error: { levels: ["warn", "error"] } }), + ], +}); +``` diff --git a/includes/logs/javascript-pino-integration.mdx b/includes/logs/javascript-pino-integration.mdx new file mode 100644 index 0000000000000..c692d731bace0 --- /dev/null +++ b/includes/logs/javascript-pino-integration.mdx @@ -0,0 +1,11 @@ +### Pino Integration + +In `10.18.0` and above of the JavaScript SDKs, we've added support to send logs via the pino logging library. To add the pino integration, you need to add the `pinoIntegration` to your Sentry initialization. + +```js +Sentry.init({ + integrations: [Sentry.pinoIntegration()], +}); +``` + +You can look at the Pino integration documentation for more information on the options you can pass to the `pinoIntegration`. diff --git a/includes/logs/javascript-upcoming-integrations.mdx b/includes/logs/javascript-upcoming-integrations.mdx index 53b44e3a275f0..1eba5b684ab8e 100644 --- a/includes/logs/javascript-upcoming-integrations.mdx +++ b/includes/logs/javascript-upcoming-integrations.mdx @@ -2,5 +2,4 @@ We're actively working on adding more integration support for Logs. You can follow progress on the following GitHub issues or open a [new one](https://github.com/getsentry/sentry-javascript/issues/new/choose) for any integration you would like to see. -- [Pino](https://github.com/getsentry/sentry-javascript/issues/15952) - [Node Bunyan](https://github.com/getsentry/sentry-javascript/issues/16474) diff --git a/platform-includes/configuration/integrations/javascript.astro.mdx b/platform-includes/configuration/integrations/javascript.astro.mdx index 7c6a0f5ff9791..f17c7c42e1d4e 100644 --- a/platform-includes/configuration/integrations/javascript.astro.mdx +++ b/platform-includes/configuration/integrations/javascript.astro.mdx @@ -85,3 +85,4 @@ Depending on whether an integration enhances the functionality of a particular r | [`anthropicAIIntegration`](./anthropic) | ✓ | ✓ | ✓ | | | [`googleGenAIIntegration`](./google-genai) | ✓ | ✓ | ✓ | | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.aws-lambda.mdx b/platform-includes/configuration/integrations/javascript.aws-lambda.mdx index bbb14eaa5525a..8105f1ea9edf5 100644 --- a/platform-includes/configuration/integrations/javascript.aws-lambda.mdx +++ b/platform-includes/configuration/integrations/javascript.aws-lambda.mdx @@ -47,3 +47,4 @@ | [`tediousIntegration`](./tedious) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.bun.mdx b/platform-includes/configuration/integrations/javascript.bun.mdx index 2781ceb37e95f..021547c2c5fe0 100644 --- a/platform-includes/configuration/integrations/javascript.bun.mdx +++ b/platform-includes/configuration/integrations/javascript.bun.mdx @@ -41,3 +41,4 @@ | [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.connect.mdx b/platform-includes/configuration/integrations/javascript.connect.mdx index fc558e9ea6fc8..35599d910c3d7 100644 --- a/platform-includes/configuration/integrations/javascript.connect.mdx +++ b/platform-includes/configuration/integrations/javascript.connect.mdx @@ -46,3 +46,4 @@ | [`prismaIntegration`](./prisma) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.fastify.mdx b/platform-includes/configuration/integrations/javascript.fastify.mdx index 7c9728ad92d5a..52d52af56def7 100644 --- a/platform-includes/configuration/integrations/javascript.fastify.mdx +++ b/platform-includes/configuration/integrations/javascript.fastify.mdx @@ -47,3 +47,4 @@ | [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.gcp-functions.mdx b/platform-includes/configuration/integrations/javascript.gcp-functions.mdx index 22c4d28e00f61..e34bfcda64b73 100644 --- a/platform-includes/configuration/integrations/javascript.gcp-functions.mdx +++ b/platform-includes/configuration/integrations/javascript.gcp-functions.mdx @@ -47,3 +47,4 @@ | [`tediousIntegration`](./tedious) | | | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.hapi.mdx b/platform-includes/configuration/integrations/javascript.hapi.mdx index f4bbde8c64242..60f182035f203 100644 --- a/platform-includes/configuration/integrations/javascript.hapi.mdx +++ b/platform-includes/configuration/integrations/javascript.hapi.mdx @@ -47,3 +47,4 @@ | [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | | [`trpcMiddleware`](./trpc) | | ✓ | ✓ | ✓ | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.nestjs.mdx b/platform-includes/configuration/integrations/javascript.nestjs.mdx index dc7cef49380ed..b404fb4148350 100644 --- a/platform-includes/configuration/integrations/javascript.nestjs.mdx +++ b/platform-includes/configuration/integrations/javascript.nestjs.mdx @@ -48,3 +48,4 @@ | [`anthropicAIIntegration`](./anthropic) | ✓ | ✓ | ✓ | | | [`googleGenAIIntegration`](./google-genai) | ✓ | ✓ | ✓ | | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.nextjs.mdx b/platform-includes/configuration/integrations/javascript.nextjs.mdx index 618bb63034f52..8583f9ef44c45 100644 --- a/platform-includes/configuration/integrations/javascript.nextjs.mdx +++ b/platform-includes/configuration/integrations/javascript.nextjs.mdx @@ -91,6 +91,7 @@ Depending on whether an integration enhances the functionality of a particular r | [`anthropicAIIntegration`](./anthropic) | ✓ | ✓ | ✓ | | | [`googleGenAIIntegration`](./google-genai) | ✓ | ✓ | ✓ | | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | ### Edge Integrations diff --git a/platform-includes/configuration/integrations/javascript.node.mdx b/platform-includes/configuration/integrations/javascript.node.mdx index f61cfaabc1889..7359a7973472f 100644 --- a/platform-includes/configuration/integrations/javascript.node.mdx +++ b/platform-includes/configuration/integrations/javascript.node.mdx @@ -46,3 +46,4 @@ | [`anthropicAIIntegration`](./anthropic) | ✓ | ✓ | ✓ | | | [`googleGenAIIntegration`](./google-genai) | ✓ | ✓ | ✓ | | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.nuxt.mdx b/platform-includes/configuration/integrations/javascript.nuxt.mdx index f782961390645..15ab6196325eb 100644 --- a/platform-includes/configuration/integrations/javascript.nuxt.mdx +++ b/platform-includes/configuration/integrations/javascript.nuxt.mdx @@ -84,3 +84,4 @@ Depending on whether an integration enhances the functionality of a particular r | [`anthropicAIIntegration`](./anthropic) | ✓ | ✓ | ✓ | | | [`googleGenAIIntegration`](./google-genai) | ✓ | ✓ | ✓ | | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.remix.mdx b/platform-includes/configuration/integrations/javascript.remix.mdx index 87a6b5a839bee..869aa4c279ac5 100644 --- a/platform-includes/configuration/integrations/javascript.remix.mdx +++ b/platform-includes/configuration/integrations/javascript.remix.mdx @@ -84,3 +84,4 @@ Depending on whether an integration enhances the functionality of a particular r | [`anthropicAIIntegration`](./anthropic) | ✓ | ✓ | ✓ | | | [`googleGenAIIntegration`](./google-genai) | ✓ | ✓ | ✓ | | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.solidstart.mdx b/platform-includes/configuration/integrations/javascript.solidstart.mdx index cf959ef3217a1..fba8b294a4f22 100644 --- a/platform-includes/configuration/integrations/javascript.solidstart.mdx +++ b/platform-includes/configuration/integrations/javascript.solidstart.mdx @@ -84,3 +84,4 @@ Depending on whether an integration enhances the functionality of a particular r | [`anthropicAIIntegration`](./anthropic) | ✓ | ✓ | ✓ | | | [`googleGenAIIntegration`](./google-genai) | ✓ | ✓ | ✓ | | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/configuration/integrations/javascript.sveltekit.mdx b/platform-includes/configuration/integrations/javascript.sveltekit.mdx index 2868b657a625f..1907f44d1e156 100644 --- a/platform-includes/configuration/integrations/javascript.sveltekit.mdx +++ b/platform-includes/configuration/integrations/javascript.sveltekit.mdx @@ -84,3 +84,4 @@ Depending on whether an integration enhances the functionality of a particular r | [`anthropicAIIntegration`](./anthropic) | ✓ | ✓ | ✓ | | | [`googleGenAIIntegration`](./google-genai) | ✓ | ✓ | ✓ | | | [`zodErrorsIntegration`](./zodErrors) | | | | ✓ | +| [`pinoIntegration`](./pino) | | ✓ | | | diff --git a/platform-includes/logs/integrations/javascript.astro.mdx b/platform-includes/logs/integrations/javascript.astro.mdx index e49634f46b035..089a64815d2a3 100644 --- a/platform-includes/logs/integrations/javascript.astro.mdx +++ b/platform-includes/logs/integrations/javascript.astro.mdx @@ -1,5 +1,7 @@ + + diff --git a/platform-includes/logs/integrations/javascript.nextjs.mdx b/platform-includes/logs/integrations/javascript.nextjs.mdx index e49634f46b035..089a64815d2a3 100644 --- a/platform-includes/logs/integrations/javascript.nextjs.mdx +++ b/platform-includes/logs/integrations/javascript.nextjs.mdx @@ -1,5 +1,7 @@ + + diff --git a/platform-includes/logs/integrations/javascript.node.mdx b/platform-includes/logs/integrations/javascript.node.mdx index e49634f46b035..089a64815d2a3 100644 --- a/platform-includes/logs/integrations/javascript.node.mdx +++ b/platform-includes/logs/integrations/javascript.node.mdx @@ -1,5 +1,7 @@ + + diff --git a/platform-includes/logs/integrations/javascript.nuxt.mdx b/platform-includes/logs/integrations/javascript.nuxt.mdx index e49634f46b035..089a64815d2a3 100644 --- a/platform-includes/logs/integrations/javascript.nuxt.mdx +++ b/platform-includes/logs/integrations/javascript.nuxt.mdx @@ -1,5 +1,7 @@ + + diff --git a/platform-includes/logs/integrations/javascript.react-router.mdx b/platform-includes/logs/integrations/javascript.react-router.mdx index e49634f46b035..089a64815d2a3 100644 --- a/platform-includes/logs/integrations/javascript.react-router.mdx +++ b/platform-includes/logs/integrations/javascript.react-router.mdx @@ -1,5 +1,7 @@ + + diff --git a/platform-includes/logs/integrations/javascript.remix.mdx b/platform-includes/logs/integrations/javascript.remix.mdx index e49634f46b035..089a64815d2a3 100644 --- a/platform-includes/logs/integrations/javascript.remix.mdx +++ b/platform-includes/logs/integrations/javascript.remix.mdx @@ -1,5 +1,7 @@ + + diff --git a/platform-includes/logs/integrations/javascript.solidstart.mdx b/platform-includes/logs/integrations/javascript.solidstart.mdx index e49634f46b035..089a64815d2a3 100644 --- a/platform-includes/logs/integrations/javascript.solidstart.mdx +++ b/platform-includes/logs/integrations/javascript.solidstart.mdx @@ -1,5 +1,7 @@ + + diff --git a/platform-includes/logs/integrations/javascript.sveltekit.mdx b/platform-includes/logs/integrations/javascript.sveltekit.mdx index e49634f46b035..089a64815d2a3 100644 --- a/platform-includes/logs/integrations/javascript.sveltekit.mdx +++ b/platform-includes/logs/integrations/javascript.sveltekit.mdx @@ -1,5 +1,7 @@ + + diff --git a/platform-includes/logs/integrations/javascript.tanstackstart-react.mdx b/platform-includes/logs/integrations/javascript.tanstackstart-react.mdx index e49634f46b035..089a64815d2a3 100644 --- a/platform-includes/logs/integrations/javascript.tanstackstart-react.mdx +++ b/platform-includes/logs/integrations/javascript.tanstackstart-react.mdx @@ -1,5 +1,7 @@ + +