From 8c2d063a77aa868d21d0facd27865d9a271bfb6b Mon Sep 17 00:00:00 2001 From: Nicolas Hrubec Date: Wed, 23 Sep 2026 12:18:23 +0200 Subject: [PATCH 1/4] docs: Point Effect, Elysia, and Wasm READMEs to documentation Co-Authored-By: GPT-6 --- packages/effect/README.md | 107 +++----------------------------------- packages/elysia/README.md | 29 +++-------- packages/wasm/README.md | 12 +++-- 3 files changed, 23 insertions(+), 125 deletions(-) diff --git a/packages/effect/README.md b/packages/effect/README.md index 1a2f3abd2f0c..718ba0020519 100644 --- a/packages/effect/README.md +++ b/packages/effect/README.md @@ -1,108 +1,17 @@ -# Official Sentry SDK for Effect.ts (Alpha) +# Official Sentry SDK for Effect.ts [![npm version](https://img.shields.io/npm/v/@sentry/effect.svg)](https://www.npmjs.com/package/@sentry/effect) [![npm dm](https://img.shields.io/npm/dm/@sentry/effect.svg)](https://www.npmjs.com/package/@sentry/effect) [![npm dt](https://img.shields.io/npm/dt/@sentry/effect.svg)](https://www.npmjs.com/package/@sentry/effect) -> NOTICE: This package is in alpha state and may be subject to breaking changes. +The official Sentry SDK for monitoring Effect applications. -`@sentry/effect` supports both Effect v3 and Effect v4 (beta). The integration -auto-detects the installed Effect version at runtime, but the layer composition -APIs differ between the two major versions, so the setup code is slightly -different. +## Documentation -## Getting Started +- [Getting started](https://docs.sentry.io/platforms/javascript/guides/effect/) +- [Configuration](https://docs.sentry.io/platforms/javascript/guides/effect/configuration/) -This SDK does not have docs yet. Stay tuned. +## Support -## Usage with Effect v3 - -```typescript -import * as Sentry from '@sentry/effect/server'; -import { NodeRuntime } from '@effect/platform-node'; -import { Layer, Logger } from 'effect'; -import { HttpLive } from './Http.js'; - -const SentryLive = Layer.mergeAll( - Sentry.effectLayer({ - dsn: '__DSN__', - tracesSampleRate: 1.0, - }), - Layer.setTracer(Sentry.SentryEffectTracer), - Logger.replace(Logger.defaultLogger, Sentry.SentryEffectLogger), - Sentry.SentryEffectMetricsLayer, -); - -const MainLive = HttpLive.pipe(Layer.provide(SentryLive)); -MainLive.pipe(Layer.launch, NodeRuntime.runMain); -``` - -## Usage with Effect v4 - -Effect v4 reorganized the `Tracer` and `Logger` layer APIs, so the wiring looks -slightly different. The `effectLayer`, `SentryEffectTracer`, -`SentryEffectLogger`, and `SentryEffectMetricsLayer` exports themselves are the -same. - -```typescript -import * as Sentry from '@sentry/effect/server'; -import { NodeHttpServer, NodeRuntime } from '@effect/platform-node'; -import * as Layer from 'effect/Layer'; -import * as Logger from 'effect/Logger'; -import * as Tracer from 'effect/Tracer'; -import { HttpRouter } from 'effect/unstable/http'; -import { createServer } from 'http'; -import { Routes } from './Routes.js'; - -const SentryLive = Layer.mergeAll( - Sentry.effectLayer({ - dsn: '__DSN__', - tracesSampleRate: 1.0, - }), - Layer.succeed(Tracer.Tracer, Sentry.SentryEffectTracer), - Logger.layer([Sentry.SentryEffectLogger]), - Sentry.SentryEffectMetricsLayer, -); - -const HttpLive = HttpRouter.serve(Routes).pipe( - Layer.provide(NodeHttpServer.layer(() => createServer(), { port: 3030 })), - Layer.provide(SentryLive), -); - -NodeRuntime.runMain(Layer.launch(HttpLive)); -``` - -### Error reporting - -On Effect v4, `Sentry.effectLayer` registers a Sentry `ErrorReporter`. Failures -that pass through `Effect.withErrorReporting`, `ErrorReporter.report` or the -built-in HTTP and RPC reporting boundaries are captured automatically. The -`ErrorReporter.ignore`, `ErrorReporter.severity` and `ErrorReporter.attributes` -annotations are respected: ignored errors are skipped, the severity becomes the -event level and the attributes are attached as extra data. - -```typescript -import { Data, Effect, ErrorReporter } from 'effect'; - -class RateLimitError extends Data.TaggedError('RateLimitError')<{ readonly retryAfter: number }> { - readonly [ErrorReporter.severity] = 'Warn' as const; - readonly [ErrorReporter.attributes] = { retryAfter: this.retryAfter }; -} - -const program = Effect.fail(new RateLimitError({ retryAfter: 60 })).pipe(Effect.withErrorReporting); -``` - -Reporters registered with `ErrorReporter.layer` replace the current set, so add -your own reporters with `mergeWithExisting: true` or provide them below the -Sentry layer to keep the Sentry reporter: - -```typescript -const SentryLive = Sentry.effectLayer({ dsn: '__DSN__' }).pipe(Layer.provide(ErrorReporter.layer([consoleReporter]))); -``` - -## Links - -- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/effect/) -- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_effect) -- [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) diff --git a/packages/elysia/README.md b/packages/elysia/README.md index 7565ad83ff40..beaeffbe69c6 100644 --- a/packages/elysia/README.md +++ b/packages/elysia/README.md @@ -4,35 +4,20 @@

-> NOTICE: This package is in alpha state and may be subject to breaking changes. - # Official Sentry SDK for Elysia [![npm version](https://img.shields.io/npm/v/@sentry/elysia.svg)](https://www.npmjs.com/package/@sentry/elysia) [![npm dm](https://img.shields.io/npm/dm/@sentry/elysia.svg)](https://www.npmjs.com/package/@sentry/elysia) [![npm dt](https://img.shields.io/npm/dt/@sentry/elysia.svg)](https://www.npmjs.com/package/@sentry/elysia) -> **Alpha**: This SDK is in alpha stage and may have breaking changes in future releases. - -## Usage - -```javascript -import * as Sentry from '@sentry/elysia'; -import { Elysia } from 'elysia'; - -Sentry.init({ - dsn: '__DSN__', - tracesSampleRate: 1.0, -}); +The official Sentry SDK for monitoring Elysia applications. -const app = Sentry.withElysia(new Elysia()) - .get('/', () => 'Hello World') - .listen(3000); -``` +## Documentation -## Links +- [Getting started](https://docs.sentry.io/platforms/javascript/guides/elysia/) +- [Configuration](https://docs.sentry.io/platforms/javascript/guides/elysia/configuration/) - +## Support -- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_elysia) -- [Sentry Discord Server](https://discord.gg/Ww9hbqr) +- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose) +- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md) diff --git a/packages/wasm/README.md b/packages/wasm/README.md index 3343f6b9730c..a31e43d71ce5 100644 --- a/packages/wasm/README.md +++ b/packages/wasm/README.md @@ -10,10 +10,14 @@ [![npm dm](https://img.shields.io/npm/dm/@sentry/wasm.svg)](https://www.npmjs.com/package/@sentry/wasm) [![npm dt](https://img.shields.io/npm/dt/@sentry/wasm.svg)](https://www.npmjs.com/package/@sentry/wasm) -## Links +WebAssembly stack-trace support for the Sentry JavaScript SDK. -- [Official SDK Docs](https://docs.sentry.io/quickstart/) +## Documentation -## General +- [Getting started](https://docs.sentry.io/platforms/javascript/guides/wasm/) +- [Configuration](https://docs.sentry.io/platforms/javascript/guides/wasm/configuration/) -This package provides support for WebAssembly in stack traces. +## Support + +- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose) +- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md) From 57b1a2246e4702b89e40c455f95c5fede6deae4e Mon Sep 17 00:00:00 2001 From: Nicolas Hrubec Date: Wed, 23 Sep 2026 12:33:27 +0200 Subject: [PATCH 2/4] docs: Preserve SDK alpha and beta notices Co-Authored-By: GPT-6 --- packages/effect/README.md | 4 +++- packages/elysia/README.md | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/packages/effect/README.md b/packages/effect/README.md index 718ba0020519..317320553f23 100644 --- a/packages/effect/README.md +++ b/packages/effect/README.md @@ -1,4 +1,4 @@ -# Official Sentry SDK for Effect.ts +# Official Sentry SDK for Effect.ts (Alpha) [![npm version](https://img.shields.io/npm/v/@sentry/effect.svg)](https://www.npmjs.com/package/@sentry/effect) [![npm dm](https://img.shields.io/npm/dm/@sentry/effect.svg)](https://www.npmjs.com/package/@sentry/effect) @@ -6,6 +6,8 @@ The official Sentry SDK for monitoring Effect applications. +> NOTICE: This package is in alpha state and may be subject to breaking changes. + ## Documentation - [Getting started](https://docs.sentry.io/platforms/javascript/guides/effect/) diff --git a/packages/elysia/README.md b/packages/elysia/README.md index beaeffbe69c6..0d306120696e 100644 --- a/packages/elysia/README.md +++ b/packages/elysia/README.md @@ -12,6 +12,10 @@ The official Sentry SDK for monitoring Elysia applications. +> NOTICE: This package is in alpha state and may be subject to breaking changes. + +> **Alpha**: This SDK is in alpha stage and may have breaking changes in future releases. + ## Documentation - [Getting started](https://docs.sentry.io/platforms/javascript/guides/elysia/) From 56db424ba98a5c5816e07c7c7f10e09bdd2c4fd5 Mon Sep 17 00:00:00 2001 From: Nicolas Hrubec Date: Wed, 23 Sep 2026 12:43:10 +0200 Subject: [PATCH 3/4] docs(elysia): Remove duplicate alpha notice Co-Authored-By: GPT-6 --- packages/elysia/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/packages/elysia/README.md b/packages/elysia/README.md index 0d306120696e..983d96dfbf59 100644 --- a/packages/elysia/README.md +++ b/packages/elysia/README.md @@ -12,8 +12,6 @@ The official Sentry SDK for monitoring Elysia applications. -> NOTICE: This package is in alpha state and may be subject to breaking changes. - > **Alpha**: This SDK is in alpha stage and may have breaking changes in future releases. ## Documentation From 77462a7bd65b33718f3477037027d9790f53980e Mon Sep 17 00:00:00 2001 From: Nicolas Hrubec Date: Wed, 23 Sep 2026 12:45:46 +0200 Subject: [PATCH 4/4] docs(elysia): Align alpha notice wording Co-Authored-By: GPT-6 --- packages/elysia/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/elysia/README.md b/packages/elysia/README.md index 983d96dfbf59..741414a34b3c 100644 --- a/packages/elysia/README.md +++ b/packages/elysia/README.md @@ -12,7 +12,7 @@ The official Sentry SDK for monitoring Elysia applications. -> **Alpha**: This SDK is in alpha stage and may have breaking changes in future releases. +> NOTICE: This package is in alpha state and may be subject to breaking changes. ## Documentation