diff --git a/docs/organization/dynamic-sampling/index.mdx b/docs/organization/dynamic-sampling/index.mdx index 886125b53b8548..37ffbe2bc3152a 100644 --- a/docs/organization/dynamic-sampling/index.mdx +++ b/docs/organization/dynamic-sampling/index.mdx @@ -1,6 +1,19 @@ --- title: Dynamic Sampling sidebar_order: 30 +redirect_from: + - /product/sentry-basics/metrics/ + - /product/sentry-basics/sampling/ + - /product/data-management-settings/server-side-sampling/ + - /product/data-management-settings/server-side-sampling/getting-started/ + - /product/data-management-settings/server-side-sampling/current-limitations/ + - /product/data-management-settings/server-side-sampling/sampling-configurations/ + - /product/data-management-settings/dynamic-sampling/current-limitations/ + - /product/data-management-settings/dynamic-sampling/sampling-configurations/ + - /product/data-management-settings/dynamic-sampling/ + - /product/performance/performance-at-scale/ + - /product/performance/performance-at-scale/getting-started/ + - /product/performance/performance-at-scale/benefits-performance-at-scale/ description: "Learn how to prioritize important events and increase visibility in lower-volume projects with Dynamic Sampling." --- @@ -10,15 +23,12 @@ Projects that generate large event volume can quickly consume your billing quota Dynamic Sampling employs advanced sampling techniques to retain a representative sample of the data you send to Sentry. Its algorithms are designed to prioritize keeping samples that are valuable for debugging and analysis, while reducing the retention of common or redundant data. -This process is applied directly on Sentry's servers, which allows you to configure and adjust sampling rates for stored spans right from the UI without needing to modify your SDK. This makes it possible for you to make instant updates without waiting for code freezes, app store approvals, or redeployments. +There are two available flavors of dynamic sampling, depending on the plan type of your organization: +- **Dynamic Sampling with Sampling Priorities** - available on selected Team, Business & Enterprise plans\ + By analyzing incoming traffic patterns, Dynamic Sampling is able to automatically tailor its sample rate to both the actual traffic volume and the content of accepted transactions. For more details, check out the [Dynamic Sampling Priorities](#dynamic-sampling-priorities) section. +- **Dynamic Sampling with Sampling Priorities & Custom Sample Rates** - available on selected Enterprise plans\ + Configure and adjust sample rates for stored spans right from the UI without needing to modify your SDK. This makes it possible for you to make instant updates without waiting for code freezes, app store approvals, or redeployments. In addition, by analyzing incoming traffic patterns, Dynamic Sampling is able to prioritize data based on the content of accepted spans. For more details, check out the [Configuration of Custom Sample Rates](#configuration-of-custom-sample-rates) section. -By analyzing incoming traffic patterns, Dynamic Sampling is able to tailor its decisions to both the actual traffic volume as well as the content of accepted spans. For more details, check out the [Dynamic Sampling Priorities](#dynamic-sampling-priorities) section. - - - Dynamic Sampling including Sampling Priorities has been available on paid - plans since November 2022. Configuration of custom sample rates has been - available on our latest Enterprise plans since June 2024. - ## Prerequisites @@ -38,8 +48,10 @@ By analyzing incoming traffic patterns, Dynamic Sampling is able to tailor its d - .NET: 3.22.0 or later - Go: 0.16.0 or later -## Configuration - +## Configuration of Custom Sample Rates + +Configuration of custom sample rates has been available on selected Enterprise plans since June 2024. + In this section, you'll learn how to use Dynamic Sampling in your organization. Dynamic Sampling offers two modes based on the desired sampling control: - **Default mode** allows you to set an organization level target sample rate and automatically adjusts project level sampling to match the organization level sample rate. @@ -126,7 +138,9 @@ To give Sentry the fullest, most accurate picture of your application’s health You can use both Dynamic and SDK Sampling together to further optimize your event volume for your specific use case. For example, you can set a low SDK sample rate to ensure that only a certain percentage of events are sent to Sentry, and then use Dynamic Sampling to adjust the sample rate based on the event volume received by Sentry. ## Dynamic Sampling Priorities - + + Dynamic Sampling including Sampling Priorities has been available on selected paid plans since November 2022. + Below is a list of the strategies Dynamic Sampling employs to prioritize and deprioritize data. They are enabled by default, but can be updated on a per-project basis to better fit your organization's needs. To customize this behavior, go to Project Settings > Performance. ### How to Change Dynamic Sampling Priorities diff --git a/docs/product/insights/overview/index.mdx b/docs/product/insights/overview/index.mdx index 646f5f37aae178..16fdda316932fe 100644 --- a/docs/product/insights/overview/index.mdx +++ b/docs/product/insights/overview/index.mdx @@ -48,6 +48,9 @@ Your quota is consumed by events or traces, not issues. Performance issues are g If your application is configured for Insights and Tracing, Sentry will detect common performance problems, and group them into issues just like it does with errors. Performance issues help to surface performance problems in your application and provide a workflow for resolving them. Learn more about [performance issues](/product/issues/issue-details/performance-issues/). +## Dynamic Sampling +Depending on your plan, the data ingested into Sentry may be affect by [Dynamic Sampling](/organization/dynamic-sampling/). + ## Learn More diff --git a/docs/product/insights/retention-priorities.mdx b/docs/product/insights/retention-priorities.mdx deleted file mode 100644 index ce7f320d67b89b..00000000000000 --- a/docs/product/insights/retention-priorities.mdx +++ /dev/null @@ -1,136 +0,0 @@ ---- -title: Retention Priorities -sidebar_order: 100 -redirect_from: - - /product/sentry-basics/metrics/ - - /product/sentry-basics/sampling/ - - /product/data-management-settings/server-side-sampling/ - - /product/data-management-settings/server-side-sampling/getting-started/ - - /product/data-management-settings/server-side-sampling/current-limitations/ - - /product/data-management-settings/server-side-sampling/sampling-configurations/ - - /product/data-management-settings/dynamic-sampling/current-limitations/ - - /product/data-management-settings/dynamic-sampling/sampling-configurations/ - - /product/data-management-settings/dynamic-sampling/ - - /product/performance/performance-at-scale/ - - /product/performance/performance-at-scale/getting-started/ - - /product/performance/performance-at-scale/benefits-performance-at-scale/ -description: "Learn how Sentry determines retention priorities and how to update them." ---- - - - -Retention priorities are only available on the latest version of our plans, starting from 1M reserved transactions. Anyone in your org with owner or billing-level permissions can update your plan by going to Settings > Subscription, and clicking the "Manage Subscription" button. - - - -While storing all your data makes sense at relatively low volumes, as your application scales, storing a raw copy of all your data has diminishing returns. When data reaches high volumes, Sentry begins to automatically prioritize retaining certain transactions over others with server-side data retention strategies called retention priorities. - -It's important to note that even when we begin to only store the most valuable data based on retention priorities, the [performance metrics](/product/performance/metrics/) you see are still based on **all** the events you send to Sentry. This ensures that you get a full and complete view of your application's health. - -## Prerequisites - -- Admin-level permissions. -- Latest version of one of the below SDKs: - - Python: 1.7.2 or later - - JavaScript: 7.6.0 or later - - Apple: 7.23.0 or later - - Android: 6.5.0 or later - - React Native: 4.3.0 or later - - Dart and Flutter: 6.11.0 or later - - PHP: 3.9.0 or later - - Laravel: 3.0.0 or later - - Symfony: 4.4.0 or later - - Ruby: 5.5.0 or later - - Java: 6.5.0 or later - - .NET: 3.22.0 or later - - Go: 0.16.0 or later - -## Retention Priorities - -Below is a list of the transactions we prioritize and deprioritize. They are enabled by default, but can be updated on a per-project basis to better fit your organization's needs. - -### Prioritized Transactions - -Sentry automatically prioritizes and retains the following types of transactions: - -#### Latest Release - -Latest releases are a retention priority because when you create a new release, we assume you'll want to have more visibility during the early adoption phase, which improves your ability to catch new issues as your release is gaining traction. -Because you may want to deploy the same release in different environments, we'll also take your environment into account and prioritize those transactions. - -#### Dev Environments - -Since dev environments usually generate a small number of transactions as compared to prod environments, we prioritize them during your testing phase so you can get meaningful insights. - -#### Low Volume Projects - - - -You won't be able to disable the Low Volume Projects retention priority because it's set on an organization-wide level, not on a per-project basis. - - - -Some projects within your organization are very high volume compared to others. This means that low-volume projects might get drowned out if we treat all projects equally. To ensure that you have enough samples regardless of project scale, we prioritize low-volume projects. - -#### Low Volume Transactions - -Transactions can be logically grouped by their name within a project. This means that transactions with the same name most likely indicate the same operation or code path, while transactions with different names usually indicate different operations. -We prioritize low-volume transactions for the same reason we prioritize low-volume projects – so they don't get drowned out by high-volume transactions. We want to make sure that transactions representing low-volume code paths are sampled in enough quantities to generate a complete view of your application. - -### Deprioritized Transactions - -Sentry automatically deprioritizes the following transactions: - -#### Health Checks - -We deprioritize health check type transactions because while they're important for checking the stability of your application, they don't have any value beyond the task associated with them. We consider a transaction to be a health check if its name matches one of the following glob patterns: - -- `*healthcheck*` -- `*healthy*` -- `*live*` -- `*ready*` -- `*heartbeat*` -- `*/health` -- `*/healthz` -- `*/ping` - -### How to Change Retention Priorities - -To make changes to a project's retention priorities in Sentry, go to **Settings > Projects**, select the project you're interested in, then scroll down to "Performance" in the "PROCESSING" section and make any updates under "RETENTION PRIORITIES" using the toggles. Each of your projects can have an individual set of retention priorities. - -
- -
- -## Deciding on Your SDK Sample Rate - -To give Sentry the fullest, most accurate picture of your application’s health, we recommend that you send us 100% of your transactions. You can do this by setting your [tracesSampleRate](/platform-redirect/?next=/performance/) to 1.0. If this isn't feasible for your organization, set a lower value, or switch to sampling selectively by using the [tracesSampler](/platform-redirect/?next=/performance/) to filter your transactions based on contextual data. Note that when calculating throughput, transaction metering is based on received transactions not stored transactions. - - - Please note that changes to your SDK sampling configuration may affect your - quota. If you increase your SDK sampling rate, you'll also be increasing the - volume of transactions you send to Sentry. This may require that you adjust - your transaction quota. - diff --git a/redirects.js b/redirects.js index 3313748c723984..1ea7ae3c2c8120 100644 --- a/redirects.js +++ b/redirects.js @@ -974,6 +974,10 @@ const userDocsRedirects = [ source: '/product/insights/llm-monitoring/getting-started/the-dashboard/', destination: '/product/insights/ai/llm-monitoring/getting-started/the-dashboard/', }, + { + source: '/product/insights/retention-priorities/', + destination: '/organization/dynamic-sampling/', + }, // End of Insights reduirects. { source: '/platforms/javascript/guides/astro/manual-setup/',