Skip to content

Commit 6b60dfc

Browse files
committed
review suggestions
1 parent 8259976 commit 6b60dfc

File tree

7 files changed

+34
-29
lines changed

7 files changed

+34
-29
lines changed

docs/platforms/javascript/common/configuration/options.mdx

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,21 @@ sidebar_order: 1
1818

1919
</SdkOption>
2020

21+
<PlatformCategorySection supported={["server", "serverless"]}>
22+
<SdkOption name="orgId" type='`${number}` | number'>
23+
24+
The organization ID for your Sentry project.
25+
26+
The SDK will try to extract the organization ID from the DSN. If it cannot be found, or if you need to override it,
27+
you can provide the ID with this option. The organization ID is used for trace propagation and features like `strictTraceContinuation`.
28+
29+
<Alert level="info">
30+
The organization ID is used for features like <PlatformLink to="/configuration/options#strictTraceContinuation">strict trace continuation</PlatformLink>.
31+
</Alert>
32+
33+
</SdkOption>
34+
</PlatformCategorySection>
35+
2136
<SdkOption name="debug" type='boolean' defaultValue='false'>
2237

2338
Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging information about what the SDK is doing.
@@ -386,22 +401,12 @@ If you want to disable trace propagation, you can set this option to `[]`.
386401
If set to `true`, the SDK will only continue a trace if the organization ID of the incoming trace found in the
387402
`baggage` header matches the organization ID of the current Sentry client.
388403

389-
The client's organization ID is extracted from the DSN or can be set with the `orgId` option.
404+
The client's organization ID is extracted from the DSN or can be set with the <PlatformLink to={'/configuration/options#orgId'}>`orgId` option</PlatformLink>.
390405

391406
If the organization IDs do not match, the SDK will start a new trace instead of continuing the incoming one.
392407
This is useful to prevent traces of unknown third-party services from being continued in your application.
393408

394409
</SdkOption>
395-
396-
<SdkOption name="orgId" type='`${number}` | number'>
397-
398-
The organization ID for your Sentry project.
399-
400-
The SDK will try to extract the organization ID from the DSN. If it cannot be found, or if you need to override it,
401-
you can provide the ID with this option. The organization ID is used for trace propagation and for features like `strictTraceContinuation`.
402-
403-
</SdkOption>
404-
405410
</PlatformCategorySection>
406411

407412
<PlatformCategorySection supported={['browser']}>

platform-includes/distributed-tracing/how-to-use/javascript.nextjs.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ If your app crashes while a user is uploading a photo, you can trace exactly whe
7676
_Available since SDK version 10_
7777

7878
When your application receives requests, they might include `sentry-trace` and `baggage` headers from an upstream service that is also using Sentry.
79-
By default, the SDK will continue the trace from the incoming headers. This can be undesirable if the requests are from a third-party service,
79+
By default, the SDK will continue the trace from these incoming headers. However, this behavior can be undesirable if the requests are from a third-party service,
8080
as it can lead to unwanted traces, increased billing, and skewed performance data.
8181

82-
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information.
83-
It only continues the trace if it belongs to the same Sentry organization. Otherwise, it starts a new trace.
82+
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information and only continues the trace if it belongs to the same Sentry organization.
83+
Otherwise, it starts a new trace.
8484
This is useful if your application is a public API or receives requests from services outside your organization.
8585

8686
```javascript {5}

platform-includes/distributed-tracing/how-to-use/javascript.node.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,11 @@ If your app crashes while a user is uploading a photo, you can trace exactly whe
6767
_Available since SDK version 10_
6868

6969
When your application receives requests, they might include `sentry-trace` and `baggage` headers from an upstream service that is also using Sentry.
70-
By default, the SDK will continue the trace from the incoming headers. This can be undesirable if the requests are from a third-party service,
70+
By default, the SDK will continue the trace from these incoming headers. However, this behavior can be undesirable if the requests are from a third-party service,
7171
as it can lead to unwanted traces, increased billing, and skewed performance data.
7272

73-
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information.
74-
It only continues the trace if it belongs to the same Sentry organization. Otherwise, it starts a new trace.
73+
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information and only continues the trace if it belongs to the same Sentry organization.
74+
Otherwise, it starts a new trace.
7575
This is useful if your application is a public API or receives requests from services outside your organization.
7676

7777
```javascript {5}

platform-includes/distributed-tracing/how-to-use/javascript.nuxt.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@ If your app crashes while a user is uploading a photo, you can trace exactly whe
6666
_Available since SDK version 10_
6767

6868
When your application receives requests, they might include `sentry-trace` and `baggage` headers from an upstream service that is also using Sentry.
69-
By default, the SDK will continue the trace from the incoming headers. This can be undesirable if the requests are from a third-party service,
69+
By default, the SDK will continue the trace from these incoming headers. However, this behavior can be undesirable if the requests are from a third-party service,
7070
as it can lead to unwanted traces, increased billing, and skewed performance data.
7171

72-
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information.
73-
It only continues the trace if it belongs to the same Sentry organization. Otherwise, it starts a new trace.
72+
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information and only continues the trace if it belongs to the same Sentry organization.
73+
Otherwise, it starts a new trace.
7474
This is useful if your application is a public API or receives requests from services outside your organization.
7575

7676
```javascript {5}

platform-includes/distributed-tracing/how-to-use/javascript.remix.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,11 @@ If your app crashes while a user is uploading a photo, you can trace exactly whe
105105
_Available since SDK version 10_
106106

107107
When your application receives requests, they might include `sentry-trace` and `baggage` headers from an upstream service that is also using Sentry.
108-
By default, the SDK will continue the trace from the incoming headers. This can be undesirable if the requests are from a third-party service,
108+
By default, the SDK will continue the trace from these incoming headers. However, this behavior can be undesirable if the requests are from a third-party service,
109109
as it can lead to unwanted traces, increased billing, and skewed performance data.
110110

111-
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information.
112-
It only continues the trace if it belongs to the same Sentry organization. Otherwise, it starts a new trace.
111+
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information and only continues the trace if it belongs to the same Sentry organization.
112+
Otherwise, it starts a new trace.
113113
This is useful if your application is a public API or receives requests from services outside your organization.
114114

115115
```javascript {5}

platform-includes/distributed-tracing/how-to-use/javascript.solidstart.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@ If your app crashes while a user is uploading a photo, you can trace exactly whe
9999
_Available since SDK version 10_
100100

101101
When your application receives requests, they might include `sentry-trace` and `baggage` headers from an upstream service that is also using Sentry.
102-
By default, the SDK will continue the trace from the incoming headers. This can be undesirable if the requests are from a third-party service,
102+
By default, the SDK will continue the trace from these incoming headers. However, this behavior can be undesirable if the requests are from a third-party service,
103103
as it can lead to unwanted traces, increased billing, and skewed performance data.
104104

105-
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information.
106-
It only continues the trace if it belongs to the same Sentry organization. Otherwise, it starts a new trace.
105+
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information and only continues the trace if it belongs to the same Sentry organization.
106+
Otherwise, it starts a new trace.
107107
This is useful if your application is a public API or receives requests from services outside your organization.
108108

109109
```javascript {5}

platform-includes/distributed-tracing/how-to-use/javascript.sveltekit.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ If your app crashes while a user is uploading a photo, you can trace exactly whe
7676
_Available since SDK version 10_
7777

7878
When your application receives requests, they might include `sentry-trace` and `baggage` headers from an upstream service that is also using Sentry.
79-
By default, the SDK will continue the trace from the incoming headers. This can be undesirable if the requests are from a third-party service,
79+
By default, the SDK will continue the trace from these incoming headers. However, this behavior can be undesirable if the requests are from a third-party service,
8080
as it can lead to unwanted traces, increased billing, and skewed performance data.
8181

82-
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information.
83-
It only continues the trace if it belongs to the same Sentry organization. Otherwise, it starts a new trace.
82+
To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming request for Sentry trace information and only continues the trace if it belongs to the same Sentry organization.
83+
Otherwise, it starts a new trace.
8484
This is useful if your application is a public API or receives requests from services outside your organization.
8585

8686
```javascript {5}

0 commit comments

Comments
 (0)