Skip to content

Commit f7cd0ff

Browse files
docs(ruby-sdk): refactor config options page (#12690)
* docs(ruby-sdk): refactor config options page * docs(ruby-sdk): add toc for config options
1 parent 61d28a0 commit f7cd0ff

File tree

3 files changed

+92
-93
lines changed

3 files changed

+92
-93
lines changed

docs/platforms/javascript/guides/electron/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Select which Sentry features you'd like to install in addition to Error Monitori
2828

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

31-
**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.
31+
**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.
3232

3333
## Wizard
3434

docs/platforms/python/configuration/options.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The
6464

6565
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).
6666

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

6969
</SdkOption>
7070

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

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

102-
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).
102+
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).
103103

104104
</SdkOption>
105105

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

154154
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.
155155

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

158158
</SdkOption>
159159

@@ -323,17 +323,17 @@ sentry_sdk.init(
323323

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

326-
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.
326+
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.
327327

328-
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.
328+
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.
329329

330-
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.
330+
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.
331331

332332
</SdkOption>
333333

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

336-
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.
336+
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.
337337

338338
</SdkOption>
339339

@@ -345,7 +345,7 @@ The option may contain a list of strings or regex against which the URLs of outg
345345
If one of the entries in the list matches the URL of an outgoing request, trace data will be attached to that request.
346346
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.
347347

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

350350
</SdkOption>
351351

0 commit comments

Comments
 (0)