Skip to content

Python: Added some missing options #15052

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

Merged
merged 2 commits into from
Sep 26, 2025
Merged

Python: Added some missing options #15052

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d140322
Added some missing options
antonpirker Sep 26, 2025
1b8f63a
cleanup
antonpirker Sep 26, 2025
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
30 changes: 21 additions & 9 deletions docs/platforms/python/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENV

<SdkOption name='dsn' type='str' envVar='SENTRY_DSN' defaultValue='None'>

The DSN tells the SDK where to send the events. If this option is not set, the SDK will just not send any data. The `dsn` config option takes precedence over the environment variable. Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-utilization).
The DSN tells the SDK where to send the events. If this option is not set, the SDK will just not send any data. The `dsn` config option takes precedence over the environment variable. Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-utilization).

<PlatformContent includePath="configuration/dsn" />
<PlatformContent includePath="configuration/dsn" />

</SdkOption>

<SdkOption name='debug' type='bool' defaultValue='False' envVar='SENTRY_DEBUG'>

Turns debug mode on or off. When `True`, the SDK will attempt to print out debugging information. This can be useful if something goes wrong with event sending. The default is always `False`. It's generally not recommended to turn it on in production because of the increase in log output.
Turns debug mode on or off. When `True`, the SDK will attempt to print out debugging information. This can be useful if something goes wrong with event sending. The default is always `False`. It's generally not recommended to turn it on in production because of the increase in log output.

The `debug` config option takes precedence over the environment variable.
The `debug` config option takes precedence over the environment variable.

</SdkOption>

Expand All @@ -48,6 +48,12 @@ The `environment` config option takes precedence over the environment variable.

</SdkOption>

<SdkOption name="spotlight" type='str | bool' envVar='SENTRY_SPOTLIGHT' defaultValue='None'>

Enable [Sentry Spotlight](https://github.com/getsentry/spotlight). Specify the URL that Spotlight is running on. If set to the boolean `True` the default Spotlight URL `"http://localhost:8969/stream"` is used.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Enable [Sentry Spotlight](https://github.com/getsentry/spotlight). Specify the URL that Spotlight is running on. If set to the boolean `True` the default Spotlight URL `"http://localhost:8969/stream"` is used.
Enable [Sentry Spotlight](https://github.com/getsentry/spotlight). Specify the URL that Spotlight is running on. If set to the boolean `True`, the default Spotlight URL `"http://localhost:8969/stream"` is used.


</SdkOption>

<SdkOption name="dist" type='str' defaultValue='None'>

The distribution of the application. Distributions are used to disambiguate build or deployment variants of the same release of an application. The dist can be for example a build number.
Expand All @@ -71,9 +77,9 @@ If this configuration option is specified, the `sample_rate` option is ignored.
<SdkOption name='ignore_errors' type='list' defaultValue='[]'>
A list of exception class names that shouldn't be sent to Sentry. Errors that are an instance of these exceptions or a subclass of them, will be filtered out before they're sent to Sentry.

By default, all errors are sent.
</SdkOption>
By default, all errors are sent.

</SdkOption>

<SdkOption name="max_breadcrumbs" type='int' defaultValue='100'>

Expand Down Expand Up @@ -192,6 +198,12 @@ Set this boolean to `False` to disable sending of client reports. Client reports

</SdkOption>

<SdkOption name="auto_session_tracking" type='bool' defaultValue='True'>

Whether sessions should be automatically recorded and sent to Sentry.

</SdkOption>

## Integration Configuration

<SdkOption name="integrations" type='list[sentry_sdk.integrations.Integration]' defaultValue='[]'>
Expand All @@ -203,6 +215,7 @@ List of integrations to enable in addition to [auto-enabling integrations](/plat
<SdkOption name="disabled_integrations" type='list[sentry_sdk.integrations.Integration]' defaultValue='[]'>

List of integrations that will be disabled. This setting can be used to explicitly turn off specific [auto-enabling](/platforms/python/integrations/#available-integrations) or [default](/platforms/python/integrations/default-integrations/) integrations.

</SdkOption>

<SdkOption name="auto_enabling_integrations" type='bool' defaultValue='True'>
Expand All @@ -218,6 +231,7 @@ When set to `False`, no auto-enabling integrations will be enabled by default, e
Configures whether [default integrations](/platforms/python/integrations/default-integrations/) should be enabled.

Setting `default_integrations` to `False` disables all default integrations **as well as all auto-enabling integrations**, unless they are specifically added in the `integrations` option, described above.

</SdkOption>

## Hooks
Expand Down Expand Up @@ -257,14 +271,13 @@ New in SDK version `2.35.0`. Prior to `2.35.0`, this option was experimental.

<PlatformContent includePath="/performance/traces-sampler-config-option" />


## Transport Options

Transports are used to send events to Sentry. Transports can be customized to some degree to better support highly specific deployments.

<SdkOption name="transport" type='sentry_sdk.transport.Transport' defaultValue='None'>

Switches out the transport used to send events. How this works depends on the SDK. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication.
Switches out the transport used to send events. How this works depends on the SDK. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication.

</SdkOption>

Expand Down Expand Up @@ -432,7 +445,6 @@ A number between `0` and `1`, controlling the percentage chance a given session

</SdkOption>


## Logs Options

<SdkOption name="enable_logs" type='bool' defaultValue='False'>
Expand Down
Loading