|
1 | 1 | ---
|
2 |
| -title: Basic Options |
3 |
| -description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function as an object." |
| 2 | +title: Options |
| 3 | +description: "Learn more about how the SDK can be configured via options. These are being passed to the init function and therefore set when the SDK is first initialized." |
4 | 4 | sidebar_order: 1
|
5 | 5 | ---
|
6 | 6 |
|
7 |
| -SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first |
8 |
| -initialized. |
9 |
| - |
10 | 7 | <PlatformContent includePath="configuration/config-intro" />
|
11 | 8 |
|
12 |
| -## Common Options |
| 9 | +## Core Options |
13 | 10 |
|
14 |
| -The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. |
| 11 | +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. |
15 | 12 |
|
16 | 13 | <ConfigKey name="dsn">
|
17 | 14 |
|
18 |
| -The _DSN_ tells the SDK where to send the events. If this value is not provided, the SDK will try to read it from the `SENTRY_DSN` environment variable. If that variable also does not exist, the SDK will just not send any events. |
| 15 | +The DSN tells the SDK where to send the events. If this value is not provided, the SDK will try to read it from the `SENTRY_DSN` environment variable. If that variable also does not exist, the SDK will just not send any events. |
19 | 16 |
|
20 | 17 | In runtimes without a process environment (such as the browser) that fallback does not apply.
|
21 | 18 |
|
@@ -276,7 +273,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events
|
276 | 273 |
|
277 | 274 | <ConfigKey name="traces-sample-rate">
|
278 | 275 |
|
279 |
| -A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing. |
| 276 | +A number between `0` and `1`, controlling the percentage chance a given transaction will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. Either this or <PlatformIdentifier name="traces-sampler" /> must be defined to enable tracing. |
280 | 277 |
|
281 | 278 | </ConfigKey>
|
282 | 279 |
|
@@ -308,7 +305,7 @@ Set this boolean to `false` to disable tracing for `OPTIONS` requests. This opti
|
308 | 305 |
|
309 | 306 | <ConfigKey name="profiles-sample-rate">
|
310 | 307 |
|
311 |
| -A number between 0 and 1, controlling the percentage chance a given profile will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies only to sampled transactions created in the app. Either this or <PlatformIdentifier name="profiles-sampler" /> must be defined to enable profiling. |
| 308 | +A number between `0` and `1`, controlling the percentage chance a given profile will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Applies only to sampled transactions created in the app. Either this or <PlatformIdentifier name="profiles-sampler" /> must be defined to enable profiling. |
312 | 309 |
|
313 | 310 | </ConfigKey>
|
314 | 311 |
|
|
0 commit comments