Skip to content

Commit 5bdb15c

Browse files
mydeamatejminar
authored andcommitted
feat: Update node getting started pages (#10164)
1 parent 434170e commit 5bdb15c

File tree

9 files changed

+107
-407
lines changed

9 files changed

+107
-407
lines changed

docs/platforms/javascript/guides/connect/index.mdx

+1-58
Original file line numberDiff line numberDiff line change
@@ -11,61 +11,4 @@ categories:
1111

1212
This guide explains how to set up Sentry in your Connect application.
1313

14-
Don't already have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
15-
16-
<Note>
17-
This guide is for version 8.0.0 and up of `@sentry/node`.
18-
</Note>
19-
20-
## Install
21-
22-
Sentry captures data by using an SDK within your application’s runtime. This means that you have to add `@sentry/node` as a runtime dependency to your application:
23-
24-
```bash {tabTitle:npm}
25-
npm install --save @sentry/node
26-
```
27-
28-
```bash {tabTitle:Yarn}
29-
yarn add @sentry/node
30-
```
31-
32-
## Configure
33-
34-
Sentry should be initialized as early in your app as possible. It is essential that you call `Sentry.init` before you require any other modules in your application—otherwise, auto-instrumentation of these modules will _not_ work.
35-
36-
You need to create a file named `instrument.js` that imports and initializes Sentry:
37-
38-
<PlatformContent includePath="getting-started-config" />
39-
40-
If you set a `tracesSampleRate`, performance instrumentation will automatically be enabled for you. See <PlatformLink to="/performance/instrumentation/automatic-instrumentation">Automatic Instrumentation</PlatformLink> to learn about all the things that the SDK automatically instruments for you.
41-
42-
You can also manually capture performance data - see <PlatformLink to="/performance/instrumentation/custom-instrumentation">Custom Instrumentation</PlatformLink> for details.
43-
44-
## Use
45-
46-
You need to require or import the `instrument.js` file before requiring any other modules in your application. This is necessary to ensure that Sentry can automatically instrument all modules in your application:
47-
48-
<PlatformContent includePath="getting-started-use" />
49-
50-
<Alert level="warning" title="Running with ESM">
51-
52-
If you run your application with ESM, you need to import the Sentry Initialization file before importing any other modules. See <PlatformLink to="/install/esm">running Sentry with ESM</PlatformLink>.
53-
If you are unsure how you are running your application, see <PlatformLink to="/install">Installation Methods</PlatformLink> for more information.
54-
55-
</Alert>
56-
57-
<PlatformContent includePath="getting-started-sourcemaps" />
58-
59-
## Verify
60-
61-
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
62-
63-
<PlatformContent includePath="getting-started-verify" />
64-
65-
<Note>
66-
67-
Learn more about manually capturing an error or message in our <PlatformLink to="/usage/">Usage documentation</PlatformLink>.
68-
69-
</Note>
70-
71-
To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
14+
<PlatformContent includePath="getting-started-node" />

docs/platforms/javascript/guides/express/index.mdx

+1-58
Original file line numberDiff line numberDiff line change
@@ -11,61 +11,4 @@ categories:
1111

1212
This guide explains how to set up Sentry in your Express application.
1313

14-
Don't already have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
15-
16-
<Note>This guide is for version 8.0.0 and up of `@sentry/node`.</Note>
17-
18-
## Install
19-
20-
Sentry captures data by using an SDK within your application’s runtime. This means that you have to add `@sentry/node` as a runtime dependency to your application:
21-
22-
```bash {tabTitle:npm}
23-
npm install --save @sentry/node
24-
```
25-
26-
```bash {tabTitle:Yarn}
27-
yarn add @sentry/node
28-
```
29-
30-
## Configure
31-
32-
Sentry should be initialized as early in your app as possible. It is essential that you call `Sentry.init` before you require any other modules in your application—otherwise, auto-instrumentation of these modules will _not_ work.
33-
34-
Once this is done, Sentry's Node SDK captures unhandled exceptions as well as tracing data for your application.
35-
36-
You need to create a file named `instrument.js` that imports and initializes Sentry:
37-
38-
<PlatformContent includePath="getting-started-config" />
39-
40-
If you set a `tracesSampleRate`, performance instrumentation will automatically be enabled for you. See <PlatformLink to="/performance/instrumentation/automatic-instrumentation">Automatic Instrumentation</PlatformLink> to learn about all the things that the SDK automatically instruments for you.
41-
42-
You can also manually capture performance data - see <PlatformLink to="/performance/instrumentation/custom-instrumentation">Custom Instrumentation</PlatformLink> for details.
43-
44-
## Use
45-
46-
You need to require or import the `instrument.js` file before requiring any other modules in your application. This is necessary to ensure that Sentry can automatically instrument all modules in your application:
47-
48-
<PlatformContent includePath="getting-started-use" />
49-
50-
<Alert level="warning" title="Running with ESM">
51-
52-
If you run your application with ESM, you need to import the Sentry Initialization file before importing any other modules. See <PlatformLink to="/install/esm">running Sentry with ESM</PlatformLink>.
53-
If you are unsure how you are running your application, see <PlatformLink to="/install">Installation Methods</PlatformLink> for more information.
54-
55-
</Alert>
56-
57-
<PlatformContent includePath="getting-started-sourcemaps" />
58-
59-
## Verify
60-
61-
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
62-
63-
<PlatformContent includePath="getting-started-verify" />
64-
65-
<Note>
66-
67-
Learn more about manually capturing an error or message in our <PlatformLink to="/usage/">Usage documentation</PlatformLink>.
68-
69-
</Note>
70-
71-
To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
14+
<PlatformContent includePath="getting-started-node" />

docs/platforms/javascript/guides/fastify/index.mdx

+1-58
Original file line numberDiff line numberDiff line change
@@ -11,61 +11,4 @@ categories:
1111

1212
This guide explains how to set up Sentry in your Fastify application.
1313

14-
Don't already have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
15-
16-
<Note>This guide is for version 8.0.0 and up of `@sentry/node`.</Note>
17-
18-
## Install
19-
20-
Sentry captures data by using an SDK within your application’s runtime. This means that you have to add `@sentry/node` as a runtime dependency to your application:
21-
22-
```bash {tabTitle:npm}
23-
npm install --save @sentry/node
24-
```
25-
26-
```bash {tabTitle:Yarn}
27-
yarn add @sentry/node
28-
```
29-
30-
## Configure
31-
32-
Sentry should be initialized as early in your app as possible. It is essential that you call `Sentry.init` before you require any other modules in your application—otherwise, auto-instrumentation of these modules will _not_ work.
33-
34-
Once this is done, Sentry's Node SDK captures unhandled exceptions as well as tracing data for your application.
35-
36-
You need to create a file named `instrument.js` that imports and initializes Sentry:
37-
38-
<PlatformContent includePath="getting-started-config" />
39-
40-
If you set a `tracesSampleRate`, performance instrumentation will automatically be enabled for you. See <PlatformLink to="/performance/instrumentation/automatic-instrumentation">Automatic Instrumentation</PlatformLink> to learn about all the things that the SDK automatically instruments for you.
41-
42-
You can also manually capture performance data - see <PlatformLink to="/performance/instrumentation/custom-instrumentation">Custom Instrumentation</PlatformLink> for details.
43-
44-
## Use
45-
46-
You need to require or import the `instrument.js` file before requiring any other modules in your application. This is necessary to ensure that Sentry can automatically instrument all modules in your application:
47-
48-
<PlatformContent includePath="getting-started-use" />
49-
50-
<Alert level="warning" title="Running with ESM">
51-
52-
If you run your application with ESM, you need to import the Sentry Initialization file before importing any other modules. See <PlatformLink to="/install/esm">running Sentry with ESM</PlatformLink>.
53-
If you are unsure how you are running your application, see <PlatformLink to="/install">Installation Methods</PlatformLink> for more information.
54-
55-
</Alert>
56-
57-
<PlatformContent includePath="getting-started-sourcemaps" />
58-
59-
## Verify
60-
61-
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
62-
63-
<PlatformContent includePath="getting-started-verify" />
64-
65-
<Note>
66-
67-
Learn more about manually capturing an error or message in our <PlatformLink to="/usage/">Usage documentation</PlatformLink>.
68-
69-
</Note>
70-
71-
To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
14+
<PlatformContent includePath="getting-started-node" />

docs/platforms/javascript/guides/hapi/index.mdx

+1-60
Original file line numberDiff line numberDiff line change
@@ -11,63 +11,4 @@ categories:
1111

1212
This guide explains how to set up Sentry in your Hapi application.
1313

14-
Don't already have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
15-
16-
<Note>
17-
This guide is for version 8.0.0 and up of `@sentry/node`.
18-
</Note>
19-
20-
## Install
21-
22-
Sentry captures data by using an SDK within your application’s runtime. This means that you have to add `@sentry/node` as a runtime dependency to your application:
23-
24-
```bash {tabTitle:npm}
25-
npm install --save @sentry/node
26-
```
27-
28-
```bash {tabTitle:Yarn}
29-
yarn add @sentry/node
30-
```
31-
32-
## Configure
33-
34-
Sentry should be initialized as early in your app as possible. It is essential that you call `Sentry.init` before you require any other modules in your application—otherwise, auto-instrumentation of these modules will _not_ work.
35-
36-
Once this is done, Sentry's Node SDK captures unhandled exceptions as well as tracing data for your application.
37-
38-
You need to create a file named `instrument.js` that imports and initializes Sentry:
39-
40-
<PlatformContent includePath="getting-started-config" />
41-
42-
If you set a `tracesSampleRate`, performance instrumentation will automatically be enabled for you. See <PlatformLink to="/performance/instrumentation/automatic-instrumentation">Automatic Instrumentation</PlatformLink> to learn about all the things that the SDK automatically instruments for you.
43-
44-
You can also manually capture performance data - see <PlatformLink to="/performance/instrumentation/custom-instrumentation">Custom Instrumentation</PlatformLink> for details.
45-
46-
## Use
47-
48-
You need to require or import the `instrument.js` file before requiring any other modules in your application. This is necessary to ensure that Sentry can automatically instrument all modules in your application:
49-
50-
<PlatformContent includePath="getting-started-use" />
51-
52-
<Alert level="warning" title="Running with ESM">
53-
54-
If you run your application with ESM, you need to import the Sentry Initialization file before importing any other modules. See <PlatformLink to="/install/esm">running Sentry with ESM</PlatformLink>.
55-
If you are unsure how you are running your application, see <PlatformLink to="/install">Installation Methods</PlatformLink> for more information.
56-
57-
</Alert>
58-
59-
<PlatformContent includePath="getting-started-sourcemaps" />
60-
61-
## Verify
62-
63-
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
64-
65-
<PlatformContent includePath="getting-started-verify" />
66-
67-
<Note>
68-
69-
Learn more about manually capturing an error or message in our <PlatformLink to="/usage/">Usage documentation</PlatformLink>.
70-
71-
</Note>
72-
73-
To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
14+
<PlatformContent includePath="getting-started-node" />

docs/platforms/javascript/guides/koa/index.mdx

+1-60
Original file line numberDiff line numberDiff line change
@@ -11,63 +11,4 @@ categories:
1111

1212
This guide explains how to set up Sentry in your Koa application.
1313

14-
Don't already have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
15-
16-
<Note>
17-
This guide is for version 8.0.0 and up of `@sentry/node`.
18-
</Note>
19-
20-
## Install
21-
22-
Sentry captures data by using an SDK within your application’s runtime. This means that you have to add `@sentry/node` as a runtime dependency to your application:
23-
24-
```bash {tabTitle:npm}
25-
npm install --save @sentry/node
26-
```
27-
28-
```bash {tabTitle:Yarn}
29-
yarn add @sentry/node
30-
```
31-
32-
## Configure
33-
34-
Sentry should be initialized as early in your app as possible. It is essential that you call `Sentry.init` before you require any other modules in your application—otherwise, auto-instrumentation of these modules will _not_ work.
35-
36-
Once this is done, Sentry's Node SDK captures unhandled exceptions as well as tracing data for your application.
37-
38-
You need to create a file named `instrument.js` that imports and initializes Sentry:
39-
40-
<PlatformContent includePath="getting-started-config" />
41-
42-
If you set a `tracesSampleRate`, performance instrumentation will automatically be enabled for you. See <PlatformLink to="/performance/instrumentation/automatic-instrumentation">Automatic Instrumentation</PlatformLink> to learn about all the things that the SDK automatically instruments for you.
43-
44-
You can also manually capture performance data - see <PlatformLink to="/performance/instrumentation/custom-instrumentation">Custom Instrumentation</PlatformLink> for details.
45-
46-
## Use
47-
48-
You need to require or import the `instrument.js` file before requiring any other modules in your application. This is necessary to ensure that Sentry can automatically instrument all modules in your application:
49-
50-
<PlatformContent includePath="getting-started-use" />
51-
52-
<Alert level="warning" title="Running with ESM">
53-
54-
If you run your application with ESM, you need to import the Sentry Initialization file before importing any other modules. See <PlatformLink to="/install/esm">running Sentry with ESM</PlatformLink>.
55-
If you are unsure how you are running your application, see <PlatformLink to="/install">Installation Methods</PlatformLink> for more information.
56-
57-
</Alert>
58-
59-
<PlatformContent includePath="getting-started-sourcemaps" />
60-
61-
## Verify
62-
63-
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
64-
65-
<PlatformContent includePath="getting-started-verify" />
66-
67-
<Note>
68-
69-
Learn more about manually capturing an error or message in our <PlatformLink to="/usage/">Usage documentation</PlatformLink>.
70-
71-
</Note>
72-
73-
To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
14+
<PlatformContent includePath="getting-started-node" />

docs/platforms/javascript/guides/nestjs/index.mdx

+1-53
Original file line numberDiff line numberDiff line change
@@ -11,56 +11,4 @@ categories:
1111

1212
This guide explains how to set up Sentry in your Nest.js application.
1313

14-
Don't already have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
15-
16-
<Note>
17-
This guide is for version 8.0.0 and up of `@sentry/node`.
18-
</Note>
19-
20-
## Install
21-
22-
Sentry captures data by using an SDK within your application’s runtime. This means that you have to add `@sentry/node` as a runtime dependency to your application:
23-
24-
```bash {tabTitle:npm}
25-
npm install --save @sentry/node
26-
```
27-
28-
```bash {tabTitle:Yarn}
29-
yarn add @sentry/node
30-
```
31-
32-
## Configure
33-
34-
Sentry should be initialized as early in your app as possible. It is essential that you call `Sentry.init` before you require any other modules in your application—otherwise, auto-instrumentation of these modules will _not_ work.
35-
36-
Once this is done, Sentry's Node SDK captures unhandled exceptions as well as tracing data for your application.
37-
38-
You need to create a file named `instrument.js` that imports and initializes Sentry:
39-
40-
<PlatformContent includePath="getting-started-config" />
41-
42-
If you set a `tracesSampleRate`, performance instrumentation will automatically be enabled for you. See <PlatformLink to="/performance/instrumentation/automatic-instrumentation">Automatic Instrumentation</PlatformLink> to learn about all the things that the SDK automatically instruments for you.
43-
44-
You can also manually capture performance data - see <PlatformLink to="/performance/instrumentation/custom-instrumentation">Custom Instrumentation</PlatformLink> for details.
45-
46-
## Use
47-
48-
You need to require or import the `instrument.js` file before requiring any other modules in your application. This is necessary to ensure that Sentry can automatically instrument all modules in your application:
49-
50-
<PlatformContent includePath="getting-started-use" />
51-
52-
<PlatformContent includePath="getting-started-sourcemaps" />
53-
54-
## Verify
55-
56-
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
57-
58-
<PlatformContent includePath="getting-started-verify" />
59-
60-
<Note>
61-
62-
Learn more about manually capturing an error or message in our <PlatformLink to="/usage/">Usage documentation</PlatformLink>.
63-
64-
</Note>
65-
66-
To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
14+
<PlatformContent includePath="getting-started-node" />

0 commit comments

Comments
 (0)