Sentry integration

Integrate Sentry to monitor errors from a Supabase client

You can use Sentry to monitor errors thrown from a Supabase JavaScript client. Install the Supabase Sentry integration to get started.

The Sentry integration supports browser, Node, and edge environments.

Installation#

Install the Sentry integration using your package manager:

1
npm install @supabase/sentry-js-integration

Use#

To use the Supabase Sentry integration, add it to your integrations list when initializing your Sentry client.

You can supply either the Supabase Client constructor or an already-initiated instance of a Supabase Client.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import * as Sentry from '@sentry/browser'import { SupabaseClient } from '@supabase/supabase-js'import { supabaseIntegration } from '@supabase/sentry-js-integration'Sentry.init({  dsn: SENTRY_DSN,  integrations: [    supabaseIntegration(SupabaseClient, Sentry, {      tracing: true,      breadcrumbs: true,      errors: true,    }),  ],})

All available configuration options are available in our supabase-community/sentry-integration-js repository.

Deduplicating spans#

If you're already monitoring HTTP errors in Sentry, for example with the HTTP, Fetch, or Undici integrations, you will get duplicate spans for Supabase calls. You can deduplicate the spans by skipping them in your other integration:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
import * as Sentry from '@sentry/browser'import { SupabaseClient } from '@supabase/supabase-js'import { supabaseIntegration } from '@supabase/sentry-js-integration'Sentry.init({  dsn: SENTRY_DSN,  integrations: [    supabaseIntegration(SupabaseClient, Sentry, {      tracing: true,      breadcrumbs: true,      errors: true,    }),    // @sentry/browser    Sentry.browserTracingIntegration({      shouldCreateSpanForRequest: (url) => {        return !url.startsWith(`${SUPABASE_URL}/rest`)      },    }),    // or @sentry/node    Sentry.httpIntegration({      tracing: {        ignoreOutgoingRequests: (url) => {          return url.startsWith(`${SUPABASE_URL}/rest`)        },      },    }),    // or @sentry/node with Fetch support    Sentry.nativeNodeFetchIntegration({      ignoreOutgoingRequests: (url) => {        return url.startsWith(`${SUPABASE_URL}/rest`)      },    }),    // or @sentry/WinterCGFetch for Next.js Middleware & Edge Functions    Sentry.winterCGFetchIntegration({      breadcrumbs: true,      shouldCreateSpanForRequest: (url) => {        return !url.startsWith(`${SUPABASE_URL}/rest`)      },    }),  ],})

Example Next.js configuration#

See this example for a setup with Next.js to cover browser, server, and edge environments. First, run through the Sentry Next.js wizard to generate the base Next.js configuration. Then add the Supabase Sentry Integration to all your Sentry.init calls with the appropriate filters.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
import * as Sentry from '@sentry/nextjs'import { SupabaseClient } from '@supabase/supabase-js'import { supabaseIntegration } from '@supabase/sentry-js-integration'Sentry.init({  dsn: SENTRY_DSN,  integrations: [    supabaseIntegration(SupabaseClient, Sentry, {      tracing: true,      breadcrumbs: true,      errors: true,    }),    Sentry.browserTracingIntegration({      shouldCreateSpanForRequest: (url) => {        return !url.startsWith(`${process.env.NEXT_PUBLIC_SUPABASE_URL}/rest`)      },    }),  ],  // Adjust this value in production, or use tracesSampler for greater control  tracesSampleRate: 1,  // Setting this option to true will print useful information to the console while you're setting up Sentry.  debug: true,})

Afterwards, build your application (npm run build) and start it locally (npm run start). You will now see the transactions being logged in the terminal when making supabase-js requests.