diff --git a/docs/platforms/android/configuration/options.mdx b/docs/platforms/android/configuration/options.mdx index ce8d02af71585..8ec0756241014 100644 --- a/docs/platforms/android/configuration/options.mdx +++ b/docs/platforms/android/configuration/options.mdx @@ -268,7 +268,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events -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 boolean value, if true, transactions and trace data will be generated and captured. This will set the to the recommended default of 1.0 if is not defined. Note that and take precedence over this option. @@ -284,12 +284,6 @@ A function responsible for determining the percentage chance a given transaction - - -An optional property that configures which downstream services receive the `sentry-trace` header attached to HTTP requests. It contains a list of URLs or regex against which URLs are matched. If not set, the `sentry-trace` header is attached to every request executed from an instrumented client. - - - 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. @@ -310,12 +304,6 @@ Set this boolean to `false` to disable tracing for `OPTIONS` requests. This opti ## Profiling Options - - -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 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. @@ -330,6 +318,6 @@ A function responsible for determining the percentage chance a given profile wil -A boolean value, if true, the startup process, including ContentProviders, Application and first Activity creation, will be profiled. Note that `profiles-sample-rate` or `profiles-sampler` must be defined. +A boolean value that determines whether the app start process will be profiled. When true, the startup process, including ContentProviders, Application and first Activity creation, will be profiled. Note that or must be defined. diff --git a/docs/platforms/apple/common/configuration/options.mdx b/docs/platforms/apple/common/configuration/options.mdx index b4a614ab376be..f639dacc81c22 100644 --- a/docs/platforms/apple/common/configuration/options.mdx +++ b/docs/platforms/apple/common/configuration/options.mdx @@ -162,7 +162,7 @@ SentrySDK.start { options in [SentrySDK startWithConfigureOptions:^(SentryOptions *options) { options.dsn = @"___PUBLIC_DSN___"; options.initialScope = ^(SentryScope *scope) { - scope setTagValue:@"my value" forKey:@"my-tag"]; + [scope setTagValue:@"my value" forKey:@"my-tag"]; return scope; }; }]; @@ -245,7 +245,7 @@ The callback typically gets a second argument (called a "hint") which contains t -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 boolean value, if true, transactions and trace data will be generated and captured. This will set the to the recommended default of 1.0 if is not defined. Note that and take precedence over this option. diff --git a/docs/platforms/dart/configuration/options.mdx b/docs/platforms/dart/configuration/options.mdx index 00a9db98f2906..97294bff318e3 100644 --- a/docs/platforms/dart/configuration/options.mdx +++ b/docs/platforms/dart/configuration/options.mdx @@ -196,3 +196,35 @@ Transports are used to send events to Sentry. Transports can be customized to so 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. + +## Tracing Options + + + +A boolean value, if true, transactions and trace data will be generated and captured. This will set the to the recommended default of 1.0 if is not defined. Note that and 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. + + + + + +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. + +The option may contain a list of strings or regex against which the URLs of outgoing requests are matched. +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. + + diff --git a/docs/platforms/flutter/configuration/options.mdx b/docs/platforms/flutter/configuration/options.mdx index d1e276a8b634e..6d8247b182b46 100644 --- a/docs/platforms/flutter/configuration/options.mdx +++ b/docs/platforms/flutter/configuration/options.mdx @@ -231,6 +231,38 @@ Switches out the transport used to send events. How this works depends on the SD +## Tracing Options + + + +A boolean value, if true, transactions and trace data will be generated and captured. This will set the to the recommended default of 1.0 if is not defined. Note that and 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. + + + + + +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. + +The option may contain a list of strings or regex against which the URLs of outgoing requests are matched. +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. + + + ## Experimental Features diff --git a/docs/platforms/kotlin-multiplatform/configuration/options.mdx b/docs/platforms/kotlin-multiplatform/configuration/options.mdx index aa3d0fb5e2748..75f72c6305954 100644 --- a/docs/platforms/kotlin-multiplatform/configuration/options.mdx +++ b/docs/platforms/kotlin-multiplatform/configuration/options.mdx @@ -229,7 +229,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events -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 boolean value, if true, transactions and trace data will be generated and captured. This will set the to the recommended default of 1.0 if is not defined. Note that and take precedence over this option. @@ -245,12 +245,6 @@ A function responsible for determining the percentage chance a given transaction - - -An optional property that configures which downstream services receive the `sentry-trace` header attached to HTTP requests. It contains a list of URLs or regex against which URLs are matched. If not set, the `sentry-trace` header is attached to every request executed from an instrumented client. - - - 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. diff --git a/docs/platforms/react-native/configuration/options.mdx b/docs/platforms/react-native/configuration/options.mdx index d608450ff9a37..5a0307d44c8a5 100644 --- a/docs/platforms/react-native/configuration/options.mdx +++ b/docs/platforms/react-native/configuration/options.mdx @@ -243,7 +243,7 @@ Controls how many seconds to wait before shutting down. Sentry SDKs send events -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 boolean value, if true, transactions and trace data will be generated and captured. This will set the to the recommended default of 1.0 if is not defined. Note that and take precedence over this option. @@ -259,6 +259,18 @@ A function responsible for determining the percentage chance a given transaction + + +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. + +The option may contain a list of strings or regex against which the URLs of outgoing requests are matched. +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 only attached to outgoing requests that contain `localhost` in their URL or requests whose URL starts with a `'/'` (for example `GET /api/v1/users`). + + + ## Experimental Features