From 35eb5112377266bacfbbca9acaa2a78ba1d90344 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Thu, 6 Jun 2024 14:50:53 +0200 Subject: [PATCH 1/8] fixes casing, removes trace origins --- docs/platforms/android/configuration/options.mdx | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/docs/platforms/android/configuration/options.mdx b/docs/platforms/android/configuration/options.mdx index ce8d02af71585..ea1d7b7d89ff2 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, if true, the startup process, including ContentProviders, Application and first Activity creation, will be profiled. Note that or must be defined. From 7331a3b87038567d802c967f68b9640aefecc8d2 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Thu, 6 Jun 2024 14:51:12 +0200 Subject: [PATCH 2/8] fixes typo in snippet and option names casing --- docs/platforms/apple/common/configuration/options.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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. From a6da971c81139c407fe1fb8d13bd4c9a7bd050ce Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Thu, 6 Jun 2024 14:51:54 +0200 Subject: [PATCH 3/8] fixes casing --- docs/platforms/kotlin-multiplatform/configuration/options.mdx | 2 +- docs/platforms/react-native/configuration/options.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platforms/kotlin-multiplatform/configuration/options.mdx b/docs/platforms/kotlin-multiplatform/configuration/options.mdx index aa3d0fb5e2748..7a209e0fca3e2 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. diff --git a/docs/platforms/react-native/configuration/options.mdx b/docs/platforms/react-native/configuration/options.mdx index d608450ff9a37..c809d3c29c875 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. From 09f53fb86be1e53d30042a88bc46841cd30fffbc Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Thu, 6 Jun 2024 14:52:08 +0200 Subject: [PATCH 4/8] adds tracing options --- docs/platforms/dart/configuration/options.mdx | 32 +++++++++++++++++++ .../flutter/configuration/options.mdx | 32 +++++++++++++++++++ 2 files changed, 64 insertions(+) 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 From 19f2a6fde2fe6bedbf8d195302564ad004fc2547 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Thu, 6 Jun 2024 14:52:20 +0200 Subject: [PATCH 5/8] removes tracing-origins --- .../kotlin-multiplatform/configuration/options.mdx | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/platforms/kotlin-multiplatform/configuration/options.mdx b/docs/platforms/kotlin-multiplatform/configuration/options.mdx index 7a209e0fca3e2..75f72c6305954 100644 --- a/docs/platforms/kotlin-multiplatform/configuration/options.mdx +++ b/docs/platforms/kotlin-multiplatform/configuration/options.mdx @@ -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. From be51edeb9766d9b0f17bf6175dd79058360e7d45 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Thu, 6 Jun 2024 14:52:31 +0200 Subject: [PATCH 6/8] adds trace-propagation-targets --- .../platforms/react-native/configuration/options.mdx | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/platforms/react-native/configuration/options.mdx b/docs/platforms/react-native/configuration/options.mdx index c809d3c29c875..90d598034c628 100644 --- a/docs/platforms/react-native/configuration/options.mdx +++ b/docs/platforms/react-native/configuration/options.mdx @@ -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 attached to every outgoing request from the instrumented client. + + + ## Experimental Features From 078d460a7971aab677364c42fa2061fab86003e4 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Thu, 6 Jun 2024 16:07:08 +0200 Subject: [PATCH 7/8] updates RN tracePropagationTargets --- docs/platforms/react-native/configuration/options.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/react-native/configuration/options.mdx b/docs/platforms/react-native/configuration/options.mdx index 90d598034c628..5a0307d44c8a5 100644 --- a/docs/platforms/react-native/configuration/options.mdx +++ b/docs/platforms/react-native/configuration/options.mdx @@ -267,7 +267,7 @@ The option may contain a list of strings or regex against which the URLs of outg If one of the entries in the list matches the URL of an outgoing request, trace data will be attached to that request. String entries do not have to be full matches, meaning the URL of a request is matched when it _contains_ a string provided through the option. -If is not provided, trace data is attached to every outgoing request from the instrumented client. +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`). From 8e49366f7a924660d40748c1828c8b747954c6d5 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Mon, 10 Jun 2024 00:51:36 -0700 Subject: [PATCH 8/8] Apply suggestions from code review Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- docs/platforms/android/configuration/options.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/android/configuration/options.mdx b/docs/platforms/android/configuration/options.mdx index ea1d7b7d89ff2..8ec0756241014 100644 --- a/docs/platforms/android/configuration/options.mdx +++ b/docs/platforms/android/configuration/options.mdx @@ -318,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 or 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.