From 9802ba091624196f2d1c9acda897c19991c9b793 Mon Sep 17 00:00:00 2001 From: Nicolas Hrubec Date: Wed, 23 Sep 2026 11:20:14 +0200 Subject: [PATCH] docs(remix): Point README to SDK documentation Co-Authored-By: GPT-6 --- packages/remix/README.md | 125 +++------------------------------------ 1 file changed, 7 insertions(+), 118 deletions(-) diff --git a/packages/remix/README.md b/packages/remix/README.md index ddb0c643a869..826159aa47c9 100644 --- a/packages/remix/README.md +++ b/packages/remix/README.md @@ -10,125 +10,14 @@ [![npm dm](https://img.shields.io/npm/dm/@sentry/remix.svg)](https://www.npmjs.com/package/@sentry/remix) [![npm dt](https://img.shields.io/npm/dt/@sentry/remix.svg)](https://www.npmjs.com/package/@sentry/remix) -## General +The official Sentry SDK for monitoring Remix applications. -This package is a wrapper around `@sentry/node` for the server and `@sentry/react` for the client, with added -functionality related to Remix. +## Documentation -To use this SDK, initialize Sentry in your Remix entry points for both the client and server. +- [Getting started](https://docs.sentry.io/platforms/javascript/guides/remix/) +- [Configuration](https://docs.sentry.io/platforms/javascript/guides/remix/configuration/) -```ts -// entry.client.tsx +## Support -import { useLocation, useMatches } from '@remix-run/react'; -import * as Sentry from '@sentry/remix'; -import { useEffect } from 'react'; - -Sentry.init({ - dsn: '__DSN__', - tracesSampleRate: 1, - integrations: [ - Sentry.browserTracingIntegration({ - useEffect, - useLocation, - useMatches, - }), - ], - // ... -}); -``` - -```ts -// entry.server.tsx - -import { prisma } from '~/db.server'; - -import * as Sentry from '@sentry/remix'; - -Sentry.init({ - dsn: '__DSN__', - tracesSampleRate: 1, - integrations: [Sentry.prismaIntegration()], - // ... -}); -``` - -Also, wrap your Remix root with `withSentry` to catch React component errors and to get parameterized router -transactions. - -```ts -// root.tsx - -import { - Links, - LiveReload, - Meta, - Outlet, - Scripts, - ScrollRestoration, -} from "@remix-run/react"; - -import { withSentry } from "@sentry/remix"; - -function App() { - return ( - - - - - - - - - - - - - ); -} - -export default withSentry(App); -``` - -To set context information or send manual events, use the exported functions of `@sentry/remix`. - -```ts -import * as Sentry from '@sentry/remix'; - -// Set user information, as well as tags and further extras -Sentry.setExtra('battery', 0.7); -Sentry.setTag('user_mode', 'admin'); -Sentry.setUser({ id: '4711' }); - -// Add a breadcrumb for future events -Sentry.addBreadcrumb({ - message: 'My Breadcrumb', - // ... -}); - -// Capture exceptions, messages or manual events -Sentry.captureMessage('Hello, world!'); -Sentry.captureException(new Error('Good bye')); -Sentry.captureEvent({ - message: 'Manual', - stacktrace: [ - // ... - ], -}); -``` - -## Sourcemaps and Releases - -The Remix SDK provides a script that automatically creates a release and uploads sourcemaps. To generate sourcemaps with -Remix, you need to call `remix build` with the `--sourcemap` option. - -On release, call the upload sourcemaps command to upload source maps and create a release: - -```bash -npx @sentry/remix --upload-sourcemaps -``` - -To see more details on how to use the command, run `npx @sentry/remix --upload-sourcemaps --help`. - -For more advanced configuration, -[directly use `sentry-cli` to upload source maps.](https://github.com/getsentry/sentry-cli). +- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose) +- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)