Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(hapi/nestjs): Add hapi and Nest.js docs #10039

Merged
merged 3 commits into from
May 17, 2024
Merged

docs(hapi/nestjs): Add hapi and Nest.js docs #10039

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
60ea416
docs(hapi/nestjs): Add hapi and Nest.js docs
s1gr1d May 15, 2024
35ded1d
review comments
s1gr1d May 17, 2024
64a029c
review comments
s1gr1d May 17, 2024
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
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/best-practices/browser-extensions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
keywords:
[
"BrowserClient",
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/best-practices/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
---

<PageGrid />
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/best-practices/micro-frontends.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
keywords:
[
"micro frontend",
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/best-practices/multiple-sentry-instances.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
keywords:
[
"multiple instances",
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/best-practices/offline-caching.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
---

If your JavaScript application is designed to continue working offline,
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/best-practices/web-workers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
---

Sentry's Browser SDK supports [Web Workers API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). To capture unhandled errors from Web Workers:
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/configuration/application-not-responding.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ supported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
keywords:
[
"anr",
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/configuration/async-context.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ supported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
---

By default, the Sentry SDK will automatically isolate each request's scope and breadcrumbs. This means that any breadcrumbs or tags added will be isolated to the request. This is useful if you are finding that breadcrumbs and scope are leaking across requests. Take the following example:
Expand Down
6 changes: 4 additions & 2 deletions docs/platforms/javascript/common/configuration/integrations/breadcrumbs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ notSupported:
- javascript.aws-lambda
- javascript.azure-functions
- javascript.connect
- javascript.electron
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.electron
- javascript.nestjs
---

<Alert level="info">
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/configuration/integrations/browsertracing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
---

<Alert level="info">
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/console.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
- javascript.electron
- javascript.nextjs
- javascript.sveltekit
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/configuration/integrations/globalhandlers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
---

<Alert level="info">
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/http.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
- javascript.electron
- javascript.nextjs
- javascript.sveltekit
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/configuration/integrations/httpclient.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
---

<Alert level="info">
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/configuration/integrations/httpcontext.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
---

<Alert level="info">
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/localvariables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
- javascript.electron
- javascript.nextjs
- javascript.sveltekit
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/modulemetadata.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ notSupported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
---

<Alert level="info">
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/modules.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
- javascript.electron
- javascript.nextjs
- javascript.sveltekit
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/nodecontext.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
- javascript.electron
- javascript.nextjs
- javascript.sveltekit
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/nodefetch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
- javascript.electron
- javascript.nextjs
- javascript.sveltekit
Expand Down
2 changes: 2 additions & 0 deletions .../platforms/javascript/common/configuration/integrations/onuncaughtexception.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
- javascript.electron
- javascript.nextjs
- javascript.sveltekit
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/replay.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ notSupported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
---

<Alert level="info">
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/reportingobserver.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ notSupported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
---

<Alert level="info">
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/requestdata.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
- javascript.nextjs
- javascript.sveltekit
- javascript.remix
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/trycatch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ notSupported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
---

<Alert level="info">
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/unhandledrejection.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
- javascript.electron
- javascript.nextjs
- javascript.sveltekit
Expand Down
3 changes: 1 addition & 2 deletions docs/platforms/javascript/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,8 +336,7 @@ Options used to configure the transport. This is an object with the following po

</ConfigKey>

<ConfigKey name="shutdown-timeout" supported={["javascript.capacitor", "javascript.node", "javascript.aws-lambda", "javascript.azure-functions", "javascript.connect", "javascript.express", "javascript.gcp-functions", "javascript.koa", "javascript.fastify"
]}>
<ConfigKey name="shutdown-timeout" supported={["javascript.capacitor", "javascript.node", "javascript.aws-lambda", "javascript.azure-functions", "javascript.connect", "javascript.express", "javascript.gcp-functions", "javascript.hapi", "javascript.koa", "javascript.fastify", "javascript.nestjs"]}>

Controls how many seconds to wait before shutting down. Sentry SDKs send events from a background queue. This queue is given a certain amount to drain pending events. The default is SDK specific but typically around two seconds. Setting this value too low may cause problems for sending events from command line applications. Setting the value too high will cause the application to block for a long time for users experiencing network connectivity problems.

Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/common/configuration/transports.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
---

The JavaScript SDK uses a `transport` to send events to Sentry. On modern browsers, most transports use the browsers' `fetch` API to send events. Transports will drop an event if it fails to send due to a lack of connection.
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/configuration/tree-shaking/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ notSupported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
keywords: ["bundle size", "webpack", "rollup", "debug"]
---

Expand Down
6 changes: 4 additions & 2 deletions docs/platforms/javascript/common/crons/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,14 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
---

Once implemented, it'll allow you to get alerts and metrics to help you solve errors, detect timeouts, and prevent disruptions to your service.

<PlatformSection supported={["javascript.nextjs", "javascript.sveltekit", "javascript.remix", "javascript.astro", "javascript.bun", "javascript.deno", 'javascript.node', 'javascript.aws-lambda', 'javascript.azure-functions', 'javascript.connect', 'javascript.express', "javascript.fastify", 'javascript.gcp-functions', 'javascript.koa']}>
<PlatformSection supported={["javascript.nextjs", "javascript.sveltekit", "javascript.remix", "javascript.astro", "javascript.bun", "javascript.deno", 'javascript.node', 'javascript.aws-lambda', 'javascript.azure-functions', 'javascript.connect', 'javascript.express', "javascript.fastify", 'javascript.gcp-functions', 'javascript.hapi', 'javascript.koa', 'javascript.nestjs']}>

## Requirements

Expand All @@ -31,7 +33,7 @@ Once implemented, it'll allow you to get alerts and metrics to help you solve er

</PlatformSection>

<PlatformSection notSupported={["javascript.nextjs", "javascript.sveltekit", "javascript.remix", "javascript.astro", "javascript.bun", "javascript.deno", 'javascript.node', 'javascript.aws-lambda', 'javascript.azure-functions', 'javascript.connect', 'javascript.express', 'javascript.fastify', 'javascript.gcp-functions', 'javascript.koa']}>
<PlatformSection notSupported={["javascript.nextjs", "javascript.sveltekit", "javascript.remix", "javascript.astro", "javascript.bun", "javascript.deno", 'javascript.node', 'javascript.aws-lambda', 'javascript.azure-functions', 'javascript.connect', 'javascript.express', 'javascript.fastify', 'javascript.gcp-functions', 'javascript.hapi', 'javascript.koa', 'javascript.nestjs']}>

## Requirements

Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/crons/troubleshooting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ supported:
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.nestjs
---

<PlatformCategorySection supported={['server', 'serverless']}>
Expand Down
4 changes: 3 additions & 1 deletion ...tforms/javascript/common/distributed-tracing/dealing-with-cors-issues/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ notSupported:
- javascript.azure-functions
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.gcp-functions
- javascript.hapi
- javascript.koa
- javascript.fastify
- javascript.nestjs
---

If your frontend and backend are hosted on different domains (for example, your frontend is on `https://example.com` and your backend is on `https://api.example.com`), and the frontend does XHR/fetch requests to your backend, you'll need to configure your backend [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) headers to ensure requests aren't blocked.
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/javascript/common/install/commonjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ supported:
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.hapi
- javascript.koa
---

Expand Down
1 change: 1 addition & 0 deletions docs/platforms/javascript/common/install/esm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ supported:
- javascript.connect
- javascript.express
- javascript.fastify
- javascript.hapi
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: We also need to add this for the new esm-without-import install method :)

- javascript.koa
---

Expand Down
Loading
Loading