From def54d3e72f9da127ec873c240ba9ae199781e91 Mon Sep 17 00:00:00 2001 From: Lukas Stracke Date: Thu, 6 Oct 2022 10:02:38 +0200 Subject: [PATCH] ref: Clarify JS `tracingOrigins` Default Values (#5593) Clarify the meaning of the JS SDK's default values for the `tracingOrigins` option of the `BrowserTracing` integration. As pointed out in https://github.com/getsentry/sentry-javascript/issues/5868 ([comment](https://github.com/getsentry/sentry-javascript/issues/5868#issuecomment-1266582799)), it is not obvious on first glance, to which requests tracing headers are attached if the default values are used. This PR therefore adds an explanation and slightly changes the ordering of the `tracingOrigins` description. Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --- .../instrumentation/automatic-instrumentation.mdx | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/src/platforms/javascript/common/performance/instrumentation/automatic-instrumentation.mdx b/src/platforms/javascript/common/performance/instrumentation/automatic-instrumentation.mdx index 359ed26acfa7d..199af3dd8a6fc 100644 --- a/src/platforms/javascript/common/performance/instrumentation/automatic-instrumentation.mdx +++ b/src/platforms/javascript/common/performance/instrumentation/automatic-instrumentation.mdx @@ -52,7 +52,11 @@ Supported options: ### tracingOrigins -The default value of `tracingOrigins` is `['localhost', /^\//]`. The JavaScript SDK will attach the `sentry-trace` and `baggage` headers to all outgoing XHR/fetch requests whose destination contains a string in the list or matches a regex in the list. If your frontend is making requests to a different domain, you will need to add it there to propagate the `sentry-trace` and `baggage` headers to the backend services, which is required to link transactions together as part of a single trace. **The `tracingOrigins` option matches against the whole request URL, not just the domain. Using stricter regex to match certain parts of the URL ensures that requests do not unnecessarily have the additional headers attached.** +A list of strings and regular expressions. The JavaScript SDK will attach the `sentry-trace` and `baggage` headers to all outgoing XHR/fetch requests whose destination contains a string in the list or matches a regex in the list. If your frontend is making requests to a different domain, you'll need to add it there to propagate the `sentry-trace` and `baggage` headers to the backend services, which is required to link transactions together as part of a single trace. + +**The `tracingOrigins` option matches against the whole request URL, not just the domain. Using stricter regex to match certain parts of the URL ensures that requests do not unnecessarily have the additional headers attached.** + +The default value of `tracingOrigins` is `['localhost', /^\//]`. This means that by default, tracing headers are only attached to requests that contain `localhost` in their URL or requests whose URL starts with a `'/'` (for example `GET /api/v1/users`). @@ -100,19 +104,19 @@ This option flags transactions when tabs are moved to the background with "cance The default is `true`. +### \_experiments -### _experiments - -This is an object containing experimental flags for features that may involve breaking changes that haven't yet landed in a new major version. +This is an object containing experimental flags for features that haven't yet landed in a new major version and might include breaking changes. The default is + ``` { enableLongTasks: true } ``` -#### _experiments.enableLongTasks +#### \_experiments.enableLongTasks This experimental option determines whether spans for long tasks automatically get created.