Skip to content

Commit abe2f92

Browse files
docs(python-sdk): reformat config options (#12607)
1 parent 89646e8 commit abe2f92

File tree

30 files changed

+331
-390
lines changed

30 files changed

+331
-390
lines changed

docs/concepts/key-terms/sample-rates.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Some of the options below aren't available in every SDK; check out our platform-
3333

3434
### Tracing
3535

36-
- **tracesSampleRate** - 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 `tracesSampler` must be defined to enable tracing.
36+
- **tracesSampleRate** - 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 `tracesSampler` must be defined to enable tracing.
3737

3838
- **tracesSampler** - A function responsible for determining the percentage chance a given transaction will be sent to Sentry. It will automatically be passed information about the transaction and the context in which it's being created, and must return a number between 0 (0% chance of being sent) and 1 (100% chance of being sent). Can also be used for filtering transactions, by returning 0 for those that are unwanted. Either this or `tracesSampleRate` must be defined to enable tracing.
3939

docs/platforms/android/configuration/options.mdx

+7-10
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
---
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."
44
sidebar_order: 1
55
---
66

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-
107
<PlatformContent includePath="configuration/config-intro" />
118

12-
## Common Options
9+
## Core Options
1310

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.
1512

1613
<ConfigKey name="dsn">
1714

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.
1916

2017
In runtimes without a process environment (such as the browser) that fallback does not apply.
2118

@@ -276,7 +273,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events
276273

277274
<ConfigKey name="traces-sample-rate">
278275

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.
280277

281278
</ConfigKey>
282279

@@ -308,7 +305,7 @@ Set this boolean to `false` to disable tracing for `OPTIONS` requests. This opti
308305

309306
<ConfigKey name="profiles-sample-rate">
310307

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.
312309

313310
</ConfigKey>
314311

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

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
---
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."
44
sidebar_order: 1
55
---
66

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-
107
<PlatformContent includePath="configuration/config-intro" />
118

12-
## Common Options
9+
## Core Options
1310

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.
1512

1613
<ConfigKey name="dsn">
1714

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.
1916

2017
In runtimes without a process environment (such as the browser) that fallback does not apply.
2118

@@ -244,7 +241,7 @@ The callback typically gets a second argument (called a "hint") which contains t
244241

245242
<ConfigKey name="traces-sample-rate">
246243

247-
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.
244+
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.
248245

249246
</ConfigKey>
250247

docs/platforms/dart/configuration/options.mdx

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
---
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."
44
sidebar_order: 1
55
---
66

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-
107
<PlatformContent includePath="configuration/config-intro" />
118

12-
## Common Options
9+
## Core Options
1310

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.
1512

1613
<ConfigKey name="dsn">
1714

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.
1916

2017
In runtimes without a process environment (such as the browser) that fallback does not apply.
2118

@@ -201,7 +198,7 @@ Switches out the transport used to send events. How this works depends on the SD
201198

202199
<ConfigKey name="traces-sample-rate">
203200

204-
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.
201+
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.
205202

206203
</ConfigKey>
207204

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

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
---
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."
44
sidebar_order: 1
55
---
66

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-
107
<PlatformContent includePath="configuration/config-intro" />
118

12-
## Common Options
9+
## Core Options
1310

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.
1512

1613
<ConfigKey name="dsn">
1714

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.
1916

2017
In runtimes without a process environment (such as the browser) that fallback does not apply.
2118

@@ -292,7 +289,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events
292289

293290
<ConfigKey name="traces-sample-rate">
294291

295-
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.
292+
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.
296293

297294
</ConfigKey>
298295

docs/platforms/elixir/configuration/logging.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Logs & Process Crashes
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."
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."
44
sidebar_order: 50
55
---
66

docs/platforms/elixir/configuration/options.mdx

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
---
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."
44
sidebar_order: 1
55
---
66

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-
107
<PlatformContent includePath="configuration/config-intro" />
118

12-
## Common Options
9+
## Core Options
1310

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.
1512

1613
<ConfigKey name="dsn">
1714

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.
1916

2017
In runtimes without a process environment (such as the browser) that fallback does not apply.
2118

docs/platforms/flutter/configuration/options.mdx

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
---
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."
44
sidebar_order: 1
55
---
66

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-
107
<PlatformContent includePath="configuration/config-intro" />
118

12-
## Common Options
9+
## Core Options
1310

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.
1512

1613
<ConfigKey name="dsn">
1714

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.
1916

2017
In runtimes without a process environment (such as the browser) that fallback does not apply.
2118

@@ -236,7 +233,7 @@ Switches out the transport used to send events. How this works depends on the SD
236233

237234
<ConfigKey name="traces-sample-rate">
238235

239-
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.
236+
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.
240237

241238
</ConfigKey>
242239

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

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
---
2-
title: Basic Options
2+
title: Options
33
sidebar_order: 0
4-
description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init method as an object."
4+
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."
55
---
66

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-
107
<PlatformContent includePath="configuration/config-intro" />
118

129
```go

docs/platforms/go/legacy-sdk/config.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ as well as helping you streamline your error tracking.
1919

2020
### `SetDSN`
2121

22-
The _DSN_ tells the SDK where to send the events. This option is always required
22+
The DSN tells the SDK where to send the events. This option is always required
2323
and the Sentry Go SDKs can pick this up from an environment variable (`SENTRY_DSN`).
2424
When set to an empty string, SDK won't send any events to Sentry, and all `Capture*` methods
2525
will effectively act as no-ops.

0 commit comments

Comments
 (0)