From 8763d5d841711f04b2e0fcc75cefa83d445e9d2f Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Mon, 12 Aug 2024 15:31:45 +0000 Subject: [PATCH 1/2] docs(vercel-edge): Update `@sentry/vercel-edge` readme to remove alpha status and clarify usage recommendations --- packages/vercel-edge/README.md | 56 +++++----------------------------- 1 file changed, 8 insertions(+), 48 deletions(-) diff --git a/packages/vercel-edge/README.md b/packages/vercel-edge/README.md index 5f4744ac3c9d..b89183221160 100644 --- a/packages/vercel-edge/README.md +++ b/packages/vercel-edge/README.md @@ -4,7 +4,11 @@

-# Official Sentry SDK for Vercel Edge Runtime [ALPHA] +# Official Sentry SDK for Vercel Edge Runtime + +> **NOTICE:** It is discouraged to depend on this package directly. `@sentry/vercel-edge` is used as building block for +> higher level Sentry SDKs like `@sentry/nextjs`. The API of this `@sentry/vercel-edge` may break with any major and +> non-major version! [![npm version](https://img.shields.io/npm/v/@sentry/vercel-edge.svg)](https://www.npmjs.com/package/@sentry/vercel-edge) [![npm dm](https://img.shields.io/npm/dm/@sentry/vercel-edge.svg)](https://www.npmjs.com/package/@sentry/vercel-edge) @@ -12,50 +16,6 @@ ## Links -- [Official SDK Docs](https://docs.sentry.io/quickstart/) -- [TypeDoc](http://getsentry.github.io/sentry-javascript/) - -**Note: This SDK is still in an alpha state. Breaking changes can occur at any time.** - -## Usage - -To use this SDK, call `init(options)` as early as possible in the main entry module. This will initialize the SDK and -hook into the environment. Note that you can turn off almost all side effects using the respective options. - -```javascript -// CJS Syntax -const Sentry = require('@sentry/vercel-edge'); -// ESM Syntax -import * as Sentry from '@sentry/vercel-edge'; - -Sentry.init({ - dsn: '__DSN__', - // ... -}); -``` - -To set context information or send manual events, use the exported functions of `@sentry/vercel-edge`. Note that these -functions will not perform any action before you have called `init()`: - -```javascript -// 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: [ - // ... - ], -}); -``` +- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_vercel_edge) +- [Sentry Discord Server](https://discord.gg/Ww9hbqr) +- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry) From 4d8377306fd2296e573696d76349425e1137ef1c Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Tue, 13 Aug 2024 10:00:39 +0200 Subject: [PATCH 2/2] Update packages/vercel-edge/README.md --- packages/vercel-edge/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/vercel-edge/README.md b/packages/vercel-edge/README.md index b89183221160..56a6ca051887 100644 --- a/packages/vercel-edge/README.md +++ b/packages/vercel-edge/README.md @@ -4,7 +4,7 @@

-# Official Sentry SDK for Vercel Edge Runtime +# Internal Sentry Utilities for Vercel Edge Runtime > **NOTICE:** It is discouraged to depend on this package directly. `@sentry/vercel-edge` is used as building block for > higher level Sentry SDKs like `@sentry/nextjs`. The API of this `@sentry/vercel-edge` may break with any major and