From 2353e8cc40c46a50dbc210998b23aaded8d16abe Mon Sep 17 00:00:00 2001 From: Joris Bayer Date: Fri, 27 Sep 2024 15:29:08 +0200 Subject: [PATCH 1/5] feat(develop): Document indexed outcome categories --- develop-docs/application/dynamic-sampling/outcomes.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 develop-docs/application/dynamic-sampling/outcomes.mdx diff --git a/develop-docs/application/dynamic-sampling/outcomes.mdx b/develop-docs/application/dynamic-sampling/outcomes.mdx new file mode 100644 index 0000000000000..d29fbdff3c4ea --- /dev/null +++ b/develop-docs/application/dynamic-sampling/outcomes.mdx @@ -0,0 +1,8 @@ +--- +title: The `*_indexed` outcome category +sidebar_order: 4 +--- + +Data types which are subject to dynamic sampling are represented in two different outcome data categories: "total" and "indexed". You can think of the "total" category as counting items that are stored in _aggregated_ form, i.e. as metrics. The "indexed" category counts items that are stored individually. + +If an item is dropped _before_ metrics extraction & dynamic sampling, it will show up in both categories (for example, `"transaction"` and `"transaction_indexed"`). If an item is dropped _by_ dynamic sampling, it will cease to exist in the "indexed" category, but will live on in the form of metrics. From 5e6673e1e6fcd1cf3fc9f749c1b37db4f7e403fc Mon Sep 17 00:00:00 2001 From: Joris Bayer Date: Mon, 30 Sep 2024 14:57:53 +0200 Subject: [PATCH 2/5] charts --- .../application/dynamic-sampling/outcomes.mdx | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/develop-docs/application/dynamic-sampling/outcomes.mdx b/develop-docs/application/dynamic-sampling/outcomes.mdx index d29fbdff3c4ea..38df98ccdf5db 100644 --- a/develop-docs/application/dynamic-sampling/outcomes.mdx +++ b/develop-docs/application/dynamic-sampling/outcomes.mdx @@ -6,3 +6,23 @@ sidebar_order: 4 Data types which are subject to dynamic sampling are represented in two different outcome data categories: "total" and "indexed". You can think of the "total" category as counting items that are stored in _aggregated_ form, i.e. as metrics. The "indexed" category counts items that are stored individually. If an item is dropped _before_ metrics extraction & dynamic sampling, it will show up in both categories (for example, `"transaction"` and `"transaction_indexed"`). If an item is dropped _by_ dynamic sampling, it will cease to exist in the "indexed" category, but will live on in the form of metrics. + +## Illustration + +These charts illustrate the flow of data categories for transactions: + +For a sampled transaction: + +![](https://mermaid.ink/img/pako:eNp1UT1vgzAQ_SvWzYAgJoA9ZGJru4StdVWdwCGWwI4c04Yi_nsNDI2U1l589z58TzdBbRoJHE6d-arPaB15PgpN_KnKJxKGzqK-Yu2U0WF4IEfZ4bjh6_ORUVZv5aixVzWpsL90Srfv_wo-lG7kTTabcKOV1YNp5YyVf6N3DncsoZcLAfTS9qgaH3BaEPGbUwAnk2_Ug_2USyHAzyrRCiCz0LMX4-BMNeoauLODDGC4NOhkqbC12AM_YXf13Qtq4BPcgCcJi2gRs13BaLYvkl0RwAg8zVjEWBonOaVZwWI6B_BtjHeIo32esyyOk5SmdJcleQCyUT7Hy7aVdTkBWDO05_sPX1f5MtX8Azhkjhw) + +For a transaction filtered by dynamic sampling: + +https://mermaid.ink/img/pako:eNp1UcFSgzAQ_ZXMeoVOaCiQHDxxUy_lpnGcDGzbKCSdNGiR4d8N5WBnqskl-_a9t9ndEWrbIAjYtfarPijnyeNWGhJOVT6QOPZOmZOqvbYmju_JFls1LPnL85ZRVi_lYFSna1Kp7thqs3_9V_CmTYNnbBbhQiurG9PKW4d_Z68ctviOtV9oJz-0SBYkBM5-oLjbUSrNfCGCDl2ndBM6H2eF_B2ABEHGANS9-8Q5kBCaQOUkkEmaKYhV7201mBqEdz1G0B8b5bHUau9UB2Kn2lNAj8qAGOEMIkn4ihWUrwvOsk2RrIsIBhBpxlecpzTJGcsKTtkUwbe1wYGuNnnOM0qTlKVsnSV5BNjoMIanZV2XrUXgbL8_XBd8vsjnX00_t7aW9Q + +## Data types + +The following data categories have a corresponding `*_indexed` category: + +* transactions +* spans +* profiles From 914642b9840f24833d0fd1886c53643e08e6f8af Mon Sep 17 00:00:00 2001 From: Joris Bayer Date: Mon, 30 Sep 2024 15:55:35 +0200 Subject: [PATCH 3/5] ref --- develop-docs/application/dynamic-sampling/outcomes.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/develop-docs/application/dynamic-sampling/outcomes.mdx b/develop-docs/application/dynamic-sampling/outcomes.mdx index 38df98ccdf5db..5ce6c90a41b3e 100644 --- a/develop-docs/application/dynamic-sampling/outcomes.mdx +++ b/develop-docs/application/dynamic-sampling/outcomes.mdx @@ -1,5 +1,5 @@ --- -title: The `*_indexed` outcome category +title: The "indexed" outcome category sidebar_order: 4 --- @@ -17,11 +17,11 @@ For a sampled transaction: For a transaction filtered by dynamic sampling: -https://mermaid.ink/img/pako:eNp1UcFSgzAQ_ZXMeoVOaCiQHDxxUy_lpnGcDGzbKCSdNGiR4d8N5WBnqskl-_a9t9ndEWrbIAjYtfarPijnyeNWGhJOVT6QOPZOmZOqvbYmju_JFls1LPnL85ZRVi_lYFSna1Kp7thqs3_9V_CmTYNnbBbhQiurG9PKW4d_Z68ctviOtV9oJz-0SBYkBM5-oLjbUSrNfCGCDl2ndBM6H2eF_B2ABEHGANS9-8Q5kBCaQOUkkEmaKYhV7201mBqEdz1G0B8b5bHUau9UB2Kn2lNAj8qAGOEMIkn4ihWUrwvOsk2RrIsIBhBpxlecpzTJGcsKTtkUwbe1wYGuNnnOM0qTlKVsnSV5BNjoMIanZV2XrUXgbL8_XBd8vsjnX00_t7aW9Q +![](https://mermaid.ink/img/pako:eNp1UcFSgzAQ_ZXMeoVOaCiQHDxxUy_lpnGcDGzbKCSdNGiR4d8N5WBnqskl-_a9t9ndEWrbIAjYtfarPijnyeNWGhJOVT6QOPZOmZOqvbYmju_JFls1LPnL85ZRVi_lYFSna1Kp7thqs3_9V_CmTYNnbBbhQiurG9PKW4d_Z68ctviOtV9oJz-0SBYkBM5-oLjbUSrNfCGCDl2ndBM6H2eF_B2ABEHGANS9-8Q5kBCaQOUkkEmaKYhV7201mBqEdz1G0B8b5bHUau9UB2Kn2lNAj8qAGOEMIkn4ihWUrwvOsk2RrIsIBhBpxlecpzTJGcsKTtkUwbe1wYGuNnnOM0qTlKVsnSV5BNjoMIanZV2XrUXgbL8_XBd8vsjnX00_t7aW9Q) ## Data types -The following data categories have a corresponding `*_indexed` category: +The following data categories have a corresponding `"*_indexed"` category: * transactions * spans From 7ae0454bf6c5fc030e375480b590ef4c87079a48 Mon Sep 17 00:00:00 2001 From: Joris Bayer Date: Tue, 1 Oct 2024 09:46:12 +0200 Subject: [PATCH 4/5] rephrase --- develop-docs/application/dynamic-sampling/outcomes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/application/dynamic-sampling/outcomes.mdx b/develop-docs/application/dynamic-sampling/outcomes.mdx index 5ce6c90a41b3e..1d09607de5b2c 100644 --- a/develop-docs/application/dynamic-sampling/outcomes.mdx +++ b/develop-docs/application/dynamic-sampling/outcomes.mdx @@ -5,7 +5,7 @@ sidebar_order: 4 Data types which are subject to dynamic sampling are represented in two different outcome data categories: "total" and "indexed". You can think of the "total" category as counting items that are stored in _aggregated_ form, i.e. as metrics. The "indexed" category counts items that are stored individually. -If an item is dropped _before_ metrics extraction & dynamic sampling, it will show up in both categories (for example, `"transaction"` and `"transaction_indexed"`). If an item is dropped _by_ dynamic sampling, it will cease to exist in the "indexed" category, but will live on in the form of metrics. +If an item is dropped _before_ metrics extraction & dynamic sampling, it will show up as an outcome in both categories (for example, `"transaction"` and `"transaction_indexed"`). If an item is dropped _by_ dynamic sampling, it will show up as a "filtered" outcome in the "indexed" category, but it lives on in the form of metrics, for which we emit an "accepted" outcome in the "total" category. ## Illustration From defd54c44f69d4c77d8b9fdfbd8c531826593fb6 Mon Sep 17 00:00:00 2001 From: Joris Bayer Date: Thu, 3 Oct 2024 09:47:25 +0200 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: Alex Krawiec --- develop-docs/application/dynamic-sampling/outcomes.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/develop-docs/application/dynamic-sampling/outcomes.mdx b/develop-docs/application/dynamic-sampling/outcomes.mdx index 1d09607de5b2c..db81010e41401 100644 --- a/develop-docs/application/dynamic-sampling/outcomes.mdx +++ b/develop-docs/application/dynamic-sampling/outcomes.mdx @@ -1,9 +1,9 @@ --- -title: The "indexed" outcome category +title: The “Indexed” Outcome Category sidebar_order: 4 --- -Data types which are subject to dynamic sampling are represented in two different outcome data categories: "total" and "indexed". You can think of the "total" category as counting items that are stored in _aggregated_ form, i.e. as metrics. The "indexed" category counts items that are stored individually. +Data types which are subject to dynamic sampling are represented in two different outcome data categories: "total" and "indexed". You can think of the "total" category as counting items that are stored in _aggregated_ form, in other words, as metrics. The "indexed" category counts items that are stored individually. If an item is dropped _before_ metrics extraction & dynamic sampling, it will show up as an outcome in both categories (for example, `"transaction"` and `"transaction_indexed"`). If an item is dropped _by_ dynamic sampling, it will show up as a "filtered" outcome in the "indexed" category, but it lives on in the form of metrics, for which we emit an "accepted" outcome in the "total" category. @@ -19,7 +19,7 @@ For a transaction filtered by dynamic sampling: ![](https://mermaid.ink/img/pako:eNp1UcFSgzAQ_ZXMeoVOaCiQHDxxUy_lpnGcDGzbKCSdNGiR4d8N5WBnqskl-_a9t9ndEWrbIAjYtfarPijnyeNWGhJOVT6QOPZOmZOqvbYmju_JFls1LPnL85ZRVi_lYFSna1Kp7thqs3_9V_CmTYNnbBbhQiurG9PKW4d_Z68ctviOtV9oJz-0SBYkBM5-oLjbUSrNfCGCDl2ndBM6H2eF_B2ABEHGANS9-8Q5kBCaQOUkkEmaKYhV7201mBqEdz1G0B8b5bHUau9UB2Kn2lNAj8qAGOEMIkn4ihWUrwvOsk2RrIsIBhBpxlecpzTJGcsKTtkUwbe1wYGuNnnOM0qTlKVsnSV5BNjoMIanZV2XrUXgbL8_XBd8vsjnX00_t7aW9Q) -## Data types +## Data Types The following data categories have a corresponding `"*_indexed"` category: