Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 7 additions & 43 deletions packages/nextjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,50 +10,14 @@
[![npm dm](https://img.shields.io/npm/dm/@sentry/nextjs.svg)](https://www.npmjs.com/package/@sentry/nextjs)
[![npm dt](https://img.shields.io/npm/dt/@sentry/nextjs.svg)](https://www.npmjs.com/package/@sentry/nextjs)

> See the [Official Sentry Next.js SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/) to get started.
The official Sentry SDK for monitoring Next.js applications.

## Compatibility
## Documentation

Currently, the minimum supported version of Next.js is `14.0.0`.
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/nextjs/)
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/)

## Installation
## Support

To get started installing the SDK, use the Sentry Next.js Wizard by running the following command in your terminal or
read the [Getting Started Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/):

```sh
npx @sentry/wizard@latest -i nextjs
```

The wizard will prompt you to log in to Sentry. After the wizard setup is completed, the SDK will automatically capture
unhandled errors, and monitor performance.

## Custom Usage

To set context information or to send manual events, you can use `@sentry/nextjs` as follows:

```ts
import * as Sentry from '@sentry/nextjs';

// Set user information, as well as tags and further extras
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
Sentry.setContext('application_area', { location: 'checkout' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: '"Add to cart" clicked',
// ...
});

// Capture exceptions or messages
Sentry.captureException(new Error('Oh no.'));
Sentry.captureMessage('Hello, world!');
```

## Links

- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/)
- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_nextjs)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)
28 changes: 8 additions & 20 deletions packages/nuxt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,15 @@
[![npm dm](https://img.shields.io/npm/dm/@sentry/nuxt.svg)](https://www.npmjs.com/package/@sentry/nuxt)
[![npm dt](https://img.shields.io/npm/dt/@sentry/nuxt.svg)](https://www.npmjs.com/package/@sentry/nuxt)

This SDK is for [Nuxt](https://nuxt.com/). If you're using [Vue](https://vuejs.org/) see our
[Vue SDK here](https://github.com/getsentry/sentry-javascript/tree/develop/packages/vue).
The official Sentry SDK for monitoring Nuxt applications.

## Setup Instructions and Documentation
## Documentation

Check out the [Official Nuxt SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nuxt/) for further information on configuration and usage.
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/nuxt/)
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/nuxt/configuration/)
- [Nuxt-specific features](https://docs.sentry.io/platforms/javascript/guides/nuxt/features/)

## Compatibility
## Support

The minimum supported version of Nuxt is `3.7.0` (`3.14.0+` recommended).

## General

This package is a wrapper around `@sentry/node` for the server and `@sentry/vue` for the client side, with added
functionality related to Nuxt.

## Troubleshoot

If your server-side auto-instrumentation stops recording spans after bundling (e.g. certain Nitro
presets), make sure `@sentry/server-runtime-injection` is kept **external** in the Nitro/server build rather than
inlined, as its runtime module hook must resolve from `node_modules`. `@sentry/node` logs a warning
the first time an instrumented dependency loads uninstrumented.

If you encounter any issues with error tracking or integrations, refer to the official [Sentry Nuxt SDK documentation](https://docs.sentry.io/platforms/javascript/guides/nuxt/). If the documentation does not provide the necessary information, consider opening an issue on GitHub.
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)
33 changes: 7 additions & 26 deletions packages/sveltekit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,14 @@
[![npm dm](https://img.shields.io/npm/dm/@sentry/sveltekit.svg)](https://www.npmjs.com/package/@sentry/sveltekit)
[![npm dt](https://img.shields.io/npm/dt/@sentry/sveltekit.svg)](https://www.npmjs.com/package/@sentry/sveltekit)

## Compatibility
The official Sentry SDK for monitoring SvelteKit applications.

The minimum supported version of SvelteKit is `2.0.0`. The SDK works best with Vite 4.2 and newer. Older Vite versions
might not generate source maps correctly.
## Documentation

Check our docs for [SvelteKit adapter](https://docs.sentry.io/platforms/javascript/guides/sveltekit/#prerequisites) compatibility.
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/sveltekit/)
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/sveltekit/configuration/)

## General
## Support

This package is a wrapper around `@sentry/node` for the server and `@sentry/svelte` for the client side, with added
functionality related to SvelteKit.

## Installation

To get started installing the SDK, use the Sentry Next.js Wizard by running the following command in your terminal or
read the [Getting Started Docs](https://docs.sentry.io/platforms/javascript/guides/sveltekit/):

```sh
npx @sentry/wizard@latest -i sveltekit
```

The wizard will guide you throuhg logging in to Sentry and setting up the SDK. After the wizard setup is completed, the SDK will automatically capture
unhandled errors, and optionally, traces and replays.

## Links

- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/sveltekit/)
- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_sveltekit)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)
41 changes: 9 additions & 32 deletions packages/tanstackstart-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,41 +10,18 @@
[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)

The official Sentry SDK for monitoring TanStack Start React applications.

> This SDK is currently in **BETA**. Beta features are still in progress and may have bugs. Please reach out on
> [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns.

> See the [Official Sentry TanStack Start SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) to get started.

## Compatibility

The minimum supported version of TanStack Start is `1.111.12`.

## Custom Usage

To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:

```ts
import * as Sentry from '@sentry/tanstackstart-react';

// Set user information, as well as tags and further extras
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
Sentry.setContext('application_area', { location: 'checkout' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: '"Add to cart" clicked',
// ...
});
## Documentation

// Capture exceptions or messages
Sentry.captureException(new Error('Oh no.'));
Sentry.captureMessage('Hello, world!');
```
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/)
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/configuration/)
- [TanStack Start React-specific features](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/features/)

## Links
## Support

- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/)
- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)
Loading