diff --git a/docs/concepts/key-terms/sample-rates.mdx b/docs/concepts/key-terms/sample-rates.mdx index a4a6eaa65d4be..1ceac3b664a46 100644 --- a/docs/concepts/key-terms/sample-rates.mdx +++ b/docs/concepts/key-terms/sample-rates.mdx @@ -33,7 +33,7 @@ Some of the options below aren't available in every SDK; check out our platform- ### Tracing -- **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. +- **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. - **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. diff --git a/docs/platforms/android/configuration/options.mdx b/docs/platforms/android/configuration/options.mdx index 84c92f51d440c..53a8187d0c0db 100644 --- a/docs/platforms/android/configuration/options.mdx +++ b/docs/platforms/android/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -276,7 +273,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events -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 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 must be defined to enable tracing. @@ -308,7 +305,7 @@ Set this boolean to `false` to disable tracing for `OPTIONS` requests. This opti -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 must be defined to enable profiling. +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 must be defined to enable profiling. diff --git a/docs/platforms/apple/common/configuration/options.mdx b/docs/platforms/apple/common/configuration/options.mdx index 3117c71ee6e26..26c7f99174b34 100644 --- a/docs/platforms/apple/common/configuration/options.mdx +++ b/docs/platforms/apple/common/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -244,7 +241,7 @@ The callback typically gets a second argument (called a "hint") which contains t -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 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 must be defined to enable tracing. diff --git a/docs/platforms/dart/configuration/options.mdx b/docs/platforms/dart/configuration/options.mdx index f8a39d6d07e9c..b7088af5fcfe9 100644 --- a/docs/platforms/dart/configuration/options.mdx +++ b/docs/platforms/dart/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -201,7 +198,7 @@ Switches out the transport used to send events. How this works depends on the SD -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 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 must be defined to enable tracing. diff --git a/docs/platforms/dotnet/common/configuration/options.mdx b/docs/platforms/dotnet/common/configuration/options.mdx index a2b34afeaba3e..fd0c639c7a8db 100644 --- a/docs/platforms/dotnet/common/configuration/options.mdx +++ b/docs/platforms/dotnet/common/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -292,7 +289,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events -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 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 must be defined to enable tracing. diff --git a/docs/platforms/elixir/configuration/logging.mdx b/docs/platforms/elixir/configuration/logging.mdx index 3de2873673fec..1a31f73f7ea6b 100644 --- a/docs/platforms/elixir/configuration/logging.mdx +++ b/docs/platforms/elixir/configuration/logging.mdx @@ -1,6 +1,6 @@ --- title: Logs & Process Crashes -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." +description: "Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the init function." sidebar_order: 50 --- diff --git a/docs/platforms/elixir/configuration/options.mdx b/docs/platforms/elixir/configuration/options.mdx index 2553df8fef794..f29b7d44afed1 100644 --- a/docs/platforms/elixir/configuration/options.mdx +++ b/docs/platforms/elixir/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. diff --git a/docs/platforms/flutter/configuration/options.mdx b/docs/platforms/flutter/configuration/options.mdx index 25044b135e265..8da1fb593a0cd 100644 --- a/docs/platforms/flutter/configuration/options.mdx +++ b/docs/platforms/flutter/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -236,7 +233,7 @@ Switches out the transport used to send events. How this works depends on the SD -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 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 must be defined to enable tracing. diff --git a/docs/platforms/go/common/configuration/options.mdx b/docs/platforms/go/common/configuration/options.mdx index cfb80eb91a3c2..28d0ee778c9de 100644 --- a/docs/platforms/go/common/configuration/options.mdx +++ b/docs/platforms/go/common/configuration/options.mdx @@ -1,12 +1,9 @@ --- -title: Basic Options +title: Options sidebar_order: 0 -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." +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." --- -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 -initialized. - ```go diff --git a/docs/platforms/go/legacy-sdk/config.mdx b/docs/platforms/go/legacy-sdk/config.mdx index 17200713e4904..83c55cd138172 100644 --- a/docs/platforms/go/legacy-sdk/config.mdx +++ b/docs/platforms/go/legacy-sdk/config.mdx @@ -19,7 +19,7 @@ as well as helping you streamline your error tracking. ### `SetDSN` -The _DSN_ tells the SDK where to send the events. This option is always required +The DSN tells the SDK where to send the events. This option is always required and the Sentry Go SDKs can pick this up from an environment variable (`SENTRY_DSN`). When set to an empty string, SDK won't send any events to Sentry, and all `Capture*` methods will effectively act as no-ops. diff --git a/docs/platforms/java/common/configuration/options.mdx b/docs/platforms/java/common/configuration/options.mdx index a139e9da4f1db..964585e7ef876 100644 --- a/docs/platforms/java/common/configuration/options.mdx +++ b/docs/platforms/java/common/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -239,7 +236,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events -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 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 must be defined to enable tracing. diff --git a/docs/platforms/javascript/common/configuration/options.mdx b/docs/platforms/javascript/common/configuration/options.mdx index c5baab1ff31c0..45643e758826f 100644 --- a/docs/platforms/javascript/common/configuration/options.mdx +++ b/docs/platforms/javascript/common/configuration/options.mdx @@ -1,12 +1,10 @@ --- title: Options -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." +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." customCanonicalTag: "/platforms/javascript/configuration/options/" sidebar_order: 1 --- - - ## Available Options @@ -14,15 +12,15 @@ sidebar_order: 1 ## Core Options -The _DSN_ tells the SDK where to send the events. If this is not set, the SDK will not send any events. + The DSN tells the SDK where to send the events. If this is not set, the SDK will not send any events. Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-utilization). -Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-utilization). + -Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging information about what the SDK is going. +Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging information about what the SDK is doing. @@ -298,7 +296,7 @@ By the time `beforeSend` is executed, all scope data has already been applied to -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. +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. @@ -382,7 +380,7 @@ The sample rate for replays that are recorded when an error happens. This type o -A number between 0 and 1, controlling the percentage chance a given sampled transaction will be profiled. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. This is relative to the tracing sample rate - e.g. `0.5` means 50% of sampled transactions will be profiled. +A number between `0` and `1`, controlling the percentage chance a given sampled transaction will be profiled. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. This is relative to the tracing sample rate - e.g. `0.5` means 50% of sampled transactions will be profiled. diff --git a/docs/platforms/kotlin/guides/kotlin-multiplatform/configuration/options.mdx b/docs/platforms/kotlin/guides/kotlin-multiplatform/configuration/options.mdx index 8bd8094835110..20676db38e75f 100644 --- a/docs/platforms/kotlin/guides/kotlin-multiplatform/configuration/options.mdx +++ b/docs/platforms/kotlin/guides/kotlin-multiplatform/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -114,7 +111,7 @@ The callback typically gets a second argument (called a "hint") which contains t -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 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 must be defined to enable tracing. diff --git a/docs/platforms/native/common/configuration/options.mdx b/docs/platforms/native/common/configuration/options.mdx index 8d8cbd174a120..a65f186e391ba 100644 --- a/docs/platforms/native/common/configuration/options.mdx +++ b/docs/platforms/native/common/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. diff --git a/docs/platforms/php/common/configuration/options.mdx b/docs/platforms/php/common/configuration/options.mdx index 8c5ec9894a1b8..444feb23deeac 100644 --- a/docs/platforms/php/common/configuration/options.mdx +++ b/docs/platforms/php/common/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -228,7 +225,7 @@ The maximum execution time, in seconds, for the request+response as a whole. The -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 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 must be defined to enable tracing. diff --git a/docs/platforms/php/guides/laravel/configuration/laravel-options.mdx b/docs/platforms/php/guides/laravel/configuration/laravel-options.mdx index efedea58cdc83..da293f8d9ae54 100644 --- a/docs/platforms/php/guides/laravel/configuration/laravel-options.mdx +++ b/docs/platforms/php/guides/laravel/configuration/laravel-options.mdx @@ -1,7 +1,7 @@ --- title: Laravel Options sidebar_order: 1 -description: "Learn about Sentry's integration with Laravel and its options for breadcrumbs, and performance." +description: "Learn about Sentry's integration with Laravel and its options for breadcrumbs, and tracing." --- Most configuration for Laravel is done in your `.env` file. diff --git a/docs/platforms/powershell/configuration/options.mdx b/docs/platforms/powershell/configuration/options.mdx index 79f0e7b1ffc4a..b1785303dbc75 100644 --- a/docs/platforms/powershell/configuration/options.mdx +++ b/docs/platforms/powershell/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -166,7 +163,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events -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 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 must be defined to enable tracing. diff --git a/docs/platforms/python/configuration/options.mdx b/docs/platforms/python/configuration/options.mdx index ca6296e4b73c4..f874200aa75a9 100644 --- a/docs/platforms/python/configuration/options.mdx +++ b/docs/platforms/python/configuration/options.mdx @@ -1,43 +1,36 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options - -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. - - +## Available Options -Environment variable: `SENTRY_DSN` + -The _DSN_ tells the SDK where to send the events. If this option is not sent, the SDK will just not send any data. +## Core Options -The `dsn` config option takes precedence over the environment variable. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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). - + -Environment variable: `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. + -The `debug` config option takes precedence over the environment variable. + 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. - + -Environment variable: `SENTRY_RELEASE` + Sets the release. If not set, the SDK will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations. Release names are strings, but some formats are detected by Sentry and might be rendered differently. See [the releases documentation](/platforms/python/configuration/releases/) to learn how the SDK tries to automatically configure a release. @@ -45,137 +38,126 @@ The `release` config option takes precedence over the environment variable. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in [the product documentation](/product/releases/) or the sandbox. - + - - -Environment variable: `SENTRY_ENVIRONMENT` + Sets the environment. This string is freeform and set to `production` by default. A release can be associated with more than one environment to separate them in the UI (think `staging` vs `production` or similar). The `environment` config option takes precedence over the environment variable. - + - + 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. - + - + Configures the sample rate for error events, in the range of `0.0` to `1.0`. The default is `1.0`, which means that 100% of error events will be sent. If set to `0.1`, only 10% of error events will be sent. Events are picked randomly. - + - + -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). +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 option is ignored. +If this configuration option is specified, the option is ignored. - + - + + 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. -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. + By default, all errors are sent. + - - + -When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages. - -This option is turned off by default. - -Grouping in Sentry is different for events with stack traces and without. As a result, you will get new groups as you enable or disable this flag for certain events. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. - + - + -If this flag is enabled, [certain personally identifiable information (PII)](/platforms/python/data-management/data-collected/) is added by active integrations. By default, no such data is sent. +When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages. - +Grouping in Sentry is different for events with stack traces and without. As a result, you will get new groups as you enable or disable this flag for certain events. -If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. + - + -This option is turned off by default. +If this flag is enabled, [certain personally identifiable information (PII)](/platforms/python/data-management/data-collected/) is added by active integrations. If you enable this option, be sure to manually remove what you don't want to send using our features for managing [_Sensitive Data_](../../data-management/sensitive-data/). - + - + -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 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 is disabled. See how to [configure the scrubber here](../../data-management/sensitive-data/#event-scrubber). - + - + When enabled, source context will be included in events sent to Sentry. This source context includes the five lines of code above and below the line of code where an error happened. -The option is enabled by default. + - - - + When enabled, the SDK will capture a snapshot of local variables to send with the event to help with debugging. -This option is on by default. - - + - + -When capturing errors, Sentry stack traces typically only include frames that start the moment an error occurs. But if the "add-full-stack" option is enabled (set to `True`), all frames from the start of execution will be included in the stack trace sent to Sentry. By default, this option is set to `False`. +When capturing errors, Sentry stack traces typically only include frames that start the moment an error occurs. But if the `add_full_stack` option is enabled (set to `True`), all frames from the start of execution will be included in the stack trace sent to Sentry. - + - + -This option limits the number of stack frames that will be captured when `add_full_stack` is enabled. The default value is `100`. +This option limits the number of stack frames that will be captured when `add_full_stack` is enabled. - + - + -This option can be used to supply a "server name." When provided, the name of the server is sent along and persisted in the event. For many integrations, the server name actually corresponds to the device hostname, even in situations where the machine is not actually a server. +This option can be used to supply a server name. When provided, the name of the server is sent along and persisted in the event. For many integrations, the server name actually corresponds to the device hostname, even in situations where the machine is not actually a server. -Most SDKs will attempt to auto-discover this value. + - + - - -The full path to the root directory of your application. Defaults to `os.getcwd()`. +The full path to the root directory of your application. The `project_root` is used to mark frames in a stack trace either as being in your application or outside of the application. - + - + -A list of string prefixes of module names that belong to the app. This option takes precedence over `in-app-exclude`. +A list of string prefixes of module names that belong to the app. This option takes precedence over `in_app_exclude`. Sentry differentiates stack frames that are directly related to your application ("in application") from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The application package is automatically marked as `inApp`. The difference is visible in [sentry.io](https://sentry.io), where only the "in application" frames are displayed by default. - + - + 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 . +This option can be overridden using . - + - + This parameter controls whether integrations should capture HTTP request bodies. It can be set to one of the following values: @@ -186,132 +168,141 @@ This parameter controls whether integrations should capture HTTP request bodies. Please note that the Sentry server [limits HTTP request body size](https://develop.sentry.dev/sdk/expected-features/data-handling/#variable-size). The server always enforces its size limit, regardless of how you configure this option. - + - + -The number of characters after which the values containing text in the event payload will be truncated (defaults to `1024`). +The number of characters after which the values containing text in the event payload will be truncated. - + If the value you set for this is exceptionally large, the event may exceed 1 MiB and will be dropped by Sentry. - + - + A path to an alternative CA bundle file in PEM-format. - + - + Set this boolean to `False` to disable sending of client reports. Client reports allow the client to send status reports about itself to Sentry, such as information about events that were dropped before being sent. - + ## Integration Configuration - + List of integrations to enable in addition to [auto-enabling integrations](/platforms/python/integrations). This setting can be used to override the default config options for a specific auto-enabling integration or to add an integration that is not auto-enabled. - + + + 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. + - + -Configures whether [auto-enabling integrations](/platforms/python/integrations/#available-integrations) should be enabled. The default is `True`. +Configures whether [auto-enabling integrations](/platforms/python/integrations/#available-integrations) should be enabled. When set to `False`, no auto-enabling integrations will be enabled by default, even if the corresponding framework/library is detected. - + -Configures whether [default integrations](/platforms/python/integrations/default-integrations/) should be enabled. The default is `True`. + -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. +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. + ## Hooks These options can be used to hook the SDK in various ways to customize the reporting of events. - + This function is called with an SDK-specific message or error event object, and can return a modified event object, or `null` to skip reporting the event. This can be used, for instance, for manual PII stripping before sending. -By the time is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect. +By the time `before_send` is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect. - + - + This function is called with an SDK-specific transaction event object, and can return a modified transaction event object, or `null` to skip reporting the event. One way this might be used is for manual PII stripping before sending. - + - + This function is called with an SDK-specific breadcrumb object before the breadcrumb is added to the scope. When nothing is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object. The callback typically gets a second argument (called a "hint") which contains the original object from which the breadcrumb was created to further customize what the breadcrumb should look like. - + ## Transport Options Transports are used to send events to Sentry. Transports can be customized to some degree to better support highly specific deployments. - + + + 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. + - + - + -When set, a proxy can be configured that should be used for outbound requests. This is also used for HTTPS requests unless a separate `https-proxy` is configured. However, not all SDKs support a separate HTTPS proxy. SDKs will attempt to default to the system-wide configured proxy, if possible. For instance, on Unix systems, the `http_proxy` environment variable will be picked up. + - +When set, a proxy can be configured that should be used for outbound requests. This is also used for HTTPS requests unless a separate `https_proxy` is configured. However, not all SDKs support a separate HTTPS proxy. SDKs will attempt to default to the system-wide configured proxy, if possible. For instance, on Unix systems, the `http_proxy` environment variable will be picked up. - + + + Configures a separate proxy for outgoing HTTPS requests. This value might not be supported by all SDKs. When not supported the `http-proxy` value is also used for HTTPS requests at all times. - + - + A dict containing additional proxy headers (usually for authentication) to be forwarded to `urllib3`'s [`ProxyManager`](https://urllib3.readthedocs.io/en/1.24.3/reference/index.html#urllib3.poolmanager.ProxyManager). - + - + Controls how many seconds to wait before shutting down. Sentry SDKs send events from a background queue. This queue is given a certain amount to drain pending events. The default is SDK specific but typically around two seconds. Setting this value too low may cause problems for sending events from command line applications. Setting the value too high will cause the application to block for a long time for users experiencing network connectivity problems. - + - + Determines whether to keep the connection alive between requests. This can be useful in environments where you encounter frequent network issues such as connection resets. - + - + Path to the client certificate to use. If set, supersedes the `CLIENT_CERT_FILE` environment variable. - + - + Path to the key file to use. If set, supersedes the `CLIENT_KEY_FILE` environment variable. - + - + An optional list of socket options to use. These provide fine-grained, low-level control over the way the SDK connects to Sentry. If provided, the options will override the default `urllib3` [socket options](https://urllib3.readthedocs.io/en/stable/reference/urllib3.connection.html#urllib3.connection.HTTPConnection). @@ -326,35 +317,27 @@ sentry_sdk.init( ) ``` - + ## Tracing Options - - -_Deprecated in version 2.21.0._ + -A boolean value, if true, transactions and trace data will be generated and captured. This will set the `traces-sample-rate` to the recommended default of 1.0 if `traces-sample-rate` is not defined. Note that `traces-sample-rate` and `traces-sampler` take precedence over this option. +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 must be defined to enable tracing. - +If 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 `=None`. In this case, no new traces will be started and no incoming traces will be continued. -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 must be defined to enable tracing. + -If 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 `=None`. In this case, no new traces will be started and no incoming traces will be continued. +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 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 must be defined to enable tracing. - - - - + An optional property that controls which downstream services receive tracing data, in the form of a `sentry-trace` and a `baggage` header attached to any outgoing HTTP requests. @@ -362,11 +345,11 @@ 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 is not provided, trace data is attached to every outgoing request from the instrumented client. +If is not provided, trace data is attached to every outgoing request from the instrumented client. - + - + An optional list of functions that should be set up for tracing. For each function in the list, a span will be created when the function is executed. Functions in the list are represented as strings containing the fully qualified name of the function. @@ -375,33 +358,29 @@ This is a convenient option, making it possible to have one central place for co To learn more, see the [Custom Instrumentation](/platforms/python/tracing/instrumentation/custom-instrumentation/#define-span-creation-in-a-central-place) documentation. - + - + -When enabled, a new monitor thread will be spawned to perform health checks on the SDK. If the system is unhealthy, the SDK will keep halving the `traces_sample_rate` set by you in 10 second intervals until recovery. This downsampling helps ensure that the system stays stable and reduces SDK overhead under high load. +When enabled, a new monitor thread will be spawned to perform health checks on the SDK. If the system is unhealthy, the SDK will keep halving the `traces_sample_rate` set by you in 10 second intervals until recovery. This down sampling helps ensure that the system stays stable and reduces SDK overhead under high load. This option is enabled by default. - + - + When enabled, the source location will be added to database queries. -This option is enabled by default. + - - - + The threshold in milliseconds for adding the source location to database queries. The query location will be added to the query for queries slower than the specified threshold. -Default is `100` ms. - - + - + A custom [repr](https://docs.python.org/3/library/functions.html#repr) function to run while serializing an object. Use this to control how your custom objects and classes are visible in Sentry. @@ -417,6 +396,17 @@ def custom_repr(obj): sentry_sdk.init(custom_repr=custom_repr) ``` -Default is `None`. + + +## Profiling Options + + + + A number between `0` and `1`, controlling the percentage chance a given sampled transaction will be profiled. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. This is relative to the tracing sample rate - e.g. `0.5` means 50% of sampled transactions will be profiled. + + + + + - + diff --git a/docs/platforms/python/index.mdx b/docs/platforms/python/index.mdx index f22ced55fd13f..7890d65959c87 100644 --- a/docs/platforms/python/index.mdx +++ b/docs/platforms/python/index.mdx @@ -5,6 +5,9 @@ caseStyle: snake_case supportLevel: production sdk: sentry.python showIntegrationsInSearch: true +categories: + - server + - serverless --- ## Prerequisites diff --git a/docs/platforms/react-native/configuration/options.mdx b/docs/platforms/react-native/configuration/options.mdx index cb089f56dac05..fa07d8534b82a 100644 --- a/docs/platforms/react-native/configuration/options.mdx +++ b/docs/platforms/react-native/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -243,7 +240,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events -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 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 must be defined to enable tracing. diff --git a/docs/platforms/ruby/common/configuration/options.mdx b/docs/platforms/ruby/common/configuration/options.mdx index 748cb7fa34a06..28a8c67c1af90 100644 --- a/docs/platforms/ruby/common/configuration/options.mdx +++ b/docs/platforms/ruby/common/configuration/options.mdx @@ -1,17 +1,14 @@ --- -title: Basic Options +title: Options +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." sidebar_order: 1 -description: "Learn more about configuration options for the SDK. These options are set when the SDK is first initialized and passed to the init function as an object." --- -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 -initialized. - -## Common Options +## Core Options -The below is a list of common options across SDKs. They work more or less the same in all SDKs with a few subtle differences to better support different platforms. Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) will be read automatically. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) will be read automatically. @@ -229,7 +226,7 @@ config.trusted_proxies = ["2.2.2.2"] -A number between 0 and 1 that determines the percentage of total transaction that will be sent to Sentry (with 0 representing 0% and 1, 100%). This will apply equally to all transactions created in the app. Either this or must be defined to enable tracing. +A number between `0` and `1` that determines the percentage of total transaction that will be sent to Sentry (with 0 representing 0% and 1, 100%). This will apply equally to all transactions created in the app. Either this or must be defined to enable tracing. If is set to 0, no new traces will be created. However, if you have another service (for example a JS frontend) that makes requests to your service and has trace information, those traces will be continued and transactions will be sent to Sentry. diff --git a/docs/platforms/rust/common/configuration/options.mdx b/docs/platforms/rust/common/configuration/options.mdx index ae6f2f4af87e9..23791ffc1b132 100644 --- a/docs/platforms/rust/common/configuration/options.mdx +++ b/docs/platforms/rust/common/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options +title: Options sidebar_order: 1 -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." +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." --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. diff --git a/docs/platforms/unity/configuration/options.mdx b/docs/platforms/unity/configuration/options.mdx index e686f07fc5293..c9fc72f6a68be 100644 --- a/docs/platforms/unity/configuration/options.mdx +++ b/docs/platforms/unity/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options +title: Options sidebar_order: 1 -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." +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." --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -266,7 +263,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events -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 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 must be defined to enable tracing. diff --git a/docs/platforms/unreal/configuration/options.mdx b/docs/platforms/unreal/configuration/options.mdx index b046076136bc8..9a57714c0c9fe 100644 --- a/docs/platforms/unreal/configuration/options.mdx +++ b/docs/platforms/unreal/configuration/options.mdx @@ -1,21 +1,18 @@ --- -title: Basic Options -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." +title: Options +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." sidebar_order: 1 --- -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 -initialized. - -## Common Options +## Core Options -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. +Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. -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. +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. In runtimes without a process environment (such as the browser) that fallback does not apply. @@ -108,7 +105,7 @@ By the time is executed, all scope dat -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 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 must be defined to enable tracing. diff --git a/platform-includes/configuration/config-intro/javascript.ember.mdx b/platform-includes/configuration/config-intro/javascript.ember.mdx deleted file mode 100644 index 948333d7f5069..0000000000000 --- a/platform-includes/configuration/config-intro/javascript.ember.mdx +++ /dev/null @@ -1,14 +0,0 @@ -Options are passed to `sentry` inside your environment: - - -```javascript -import * as Sentry from "@sentry/ember"; - -Sentry.init({ - dsn: "___PUBLIC_DSN___", - - tracesSampleRate: 1.0, // We recommend adjusting this in production - maxBreadcrumbs: 50, - debug: true, -}); -``` diff --git a/platform-includes/configuration/config-intro/javascript.mdx b/platform-includes/configuration/config-intro/javascript.mdx deleted file mode 100644 index 6195cf2204ad5..0000000000000 --- a/platform-includes/configuration/config-intro/javascript.mdx +++ /dev/null @@ -1,8 +0,0 @@ -Options are passed to the `init()` function as an object: - -```javascript -Sentry.init({ - dsn: "___PUBLIC_DSN___", - debug: true, -}); -``` diff --git a/platform-includes/configuration/dsn/javascript.ember.mdx b/platform-includes/configuration/dsn/javascript.ember.mdx new file mode 100644 index 0000000000000..ed6151c78f9a8 --- /dev/null +++ b/platform-includes/configuration/dsn/javascript.ember.mdx @@ -0,0 +1,7 @@ +```javascript +import * as Sentry from "@sentry/ember"; + +Sentry.init({ + dsn: "___PUBLIC_DSN___" +}); +``` diff --git a/platform-includes/configuration/dsn/javascript.mdx b/platform-includes/configuration/dsn/javascript.mdx new file mode 100644 index 0000000000000..78dfe5fe384fe --- /dev/null +++ b/platform-includes/configuration/dsn/javascript.mdx @@ -0,0 +1,5 @@ +```javascript +Sentry.init({ + dsn: "___PUBLIC_DSN___" +}); +``` diff --git a/src/components/sdkOption/index.tsx b/src/components/sdkOption/index.tsx index f0fc2adc96304..47156c760b40e 100644 --- a/src/components/sdkOption/index.tsx +++ b/src/components/sdkOption/index.tsx @@ -29,7 +29,7 @@ export function SdkOption({ return ( -
+ ); diff --git a/src/components/sdkOption/style.module.scss b/src/components/sdkOption/style.module.scss index 263f6f8e40516..33d94f685e53b 100644 --- a/src/components/sdkOption/style.module.scss +++ b/src/components/sdkOption/style.module.scss @@ -1,15 +1,25 @@ +.sdk-config-option { + padding-top: 10px; +} + +.sdk-config-option-details { + padding-left: 20px; +} + .sdk-option-table { --border-radius: 6px; + margin-top: 1rem; width: auto !important; // This is necessary to make rounded borders work :( border-collapse: separate !important; - border-spacing: 0px; + border-spacing: 0; & tr th, & tr td { border-bottom-width: 0; border-right-width: 0; + padding: .5rem .75rem } & tr:last-child > * {