Skip to content

docs(ruby-sdk): refactor config options page #12690

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
Feb 12, 2025
Merged

docs(ruby-sdk): refactor config options page #12690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7ad1e5
docs(ruby-sdk): refactor config options page
stephanie-anderson Feb 12, 2025
d27ff49
docs(ruby-sdk): add toc for config options
stephanie-anderson Feb 12, 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
2 changes: 1 addition & 1 deletion docs/platforms/javascript/guides/electron/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Select which Sentry features you'd like to install in addition to Error Monitori

Once configured, all unhandled exceptions and native crashes are automatically captured by Sentry.

**Important:** Note your DSN. The _DSN_ (Data Source Name) tells the SDK where to send events. If you forget it, view _Settings -> Projects -> Client Keys (DSN)_ in the Sentry web UI.
**Important:** Note your DSN. The DSN (Data Source Name) tells the SDK where to send events. If you forget it, view _Settings -> Projects -> Client Keys (DSN)_ in the Sentry web UI.

## Wizard

Expand Down
16 changes: 8 additions & 8 deletions docs/platforms/python/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The

Dynamically configures the sample rate for error events on a per-event basis. This configuration option accepts a function, which takes two parameters (the `event` and the `hint`), and which returns a boolean (indicating whether the event should be sent to Sentry) or a floating-point number between `0.0` and `1.0`, inclusive (where the number indicates the probability the event is sent to Sentry; the SDK will randomly decide whether to send the event with the given probability).

If this configuration option is specified, the <PlatformIdentifier name="sample_rate" /> option is ignored.
If this configuration option is specified, the `sample_rate` option is ignored.

</SdkOption>

Expand Down Expand Up @@ -99,7 +99,7 @@ If you enable this option, be sure to manually remove what you don't want to sen

<SdkOption name="event_scrubber" type='sentry_sdk.scrubber.EventScrubber' defaultValue='None'>

Scrubs the event payload for sensitive information such as cookies, sessions, and passwords from a `denylist`. It can additionally be used to scrub from another `pii_denylist` if <PlatformIdentifier name="send_default_pii" /> is disabled. See how to [configure the scrubber here](../../data-management/sensitive-data/#event-scrubber).
Scrubs the event payload for sensitive information such as cookies, sessions, and passwords from a `denylist`. It can additionally be used to scrub from another `pii_denylist` if `send_default_pii` is disabled. See how to [configure the scrubber here](../../data-management/sensitive-data/#event-scrubber).

</SdkOption>

Expand Down Expand Up @@ -153,7 +153,7 @@ Sentry differentiates stack frames that are directly related to your application

A list of string prefixes of module names that do not belong to the app, but rather to third-party packages. Modules considered not part of the app will be hidden from stack traces by default.

This option can be overridden using <PlatformIdentifier name="in_app_include" />.
This option can be overridden using `in_app_include`.

</SdkOption>

Expand Down Expand Up @@ -323,17 +323,17 @@ sentry_sdk.init(

<SdkOption name="traces_sample_rate" type='float' defaultValue='None'>

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.
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 `traces_sampler` must be defined to enable tracing.

If <PlatformIdentifier name="traces_sample_rate" /> is `0`, this means that no new traces will be created. However, if you have another service (for example a JS frontend) that makes requests to your service that include trace information, those traces will be continued and thus transactions will be sent to Sentry.
If `traces_sample_rate` is `0`, this means that no new traces will be created. However, if you have another service (for example a JS frontend) that makes requests to your service that include trace information, those traces will be continued and thus transactions will be sent to Sentry.

If you want to disable all tracing you need to set <PlatformIdentifier name="traces_sample_rate" />`=None`. In this case, no new traces will be started and no incoming traces will be continued.
If you want to disable all tracing you need to set `traces_sample_rate=None`. In this case, no new traces will be started and no incoming traces will be continued.

</SdkOption>

<SdkOption name="traces_sampler" type='function' defaultValue='None'>

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 <PlatformIdentifier name="traces_sample_rate" /> must be defined to enable tracing.
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 `traces_sample_rate` must be defined to enable tracing.

</SdkOption>

Expand All @@ -345,7 +345,7 @@ The option may contain a list of strings or regex against which the URLs of outg
If one of the entries in the list matches the URL of an outgoing request, trace data will be attached to that request.
String entries do not have to be full matches, meaning the URL of a request is matched when it _contains_ a string provided through the option.

If <PlatformIdentifier name="trace_propagation_targets" /> is not provided, trace data is attached to every outgoing request from the instrumented client.
If `trace_propagation_targets` is not provided, trace data is attached to every outgoing request from the instrumented client.

</SdkOption>

Expand Down
Loading