Skip to content

Commit 9a40a54

Browse files
ale-cotagetsantry[bot]iambriccardovivianyentran
authored
Adding Investigation Bias (#8751)
* Adding images for investigation bias * Added investigation bias description * [getsentry/action-github-commit] Auto commit * Update image links * Update src/docs/product/performance/retention-priorities/index.mdx Co-authored-by: Riccardo Busetti <[email protected]> * Update src/docs/product/performance/retention-priorities/index.mdx Co-authored-by: vivianyentran <[email protected]> * Update src/docs/product/performance/retention-priorities/index.mdx Co-authored-by: vivianyentran <[email protected]> * Update src/docs/product/performance/retention-priorities/index.mdx Co-authored-by: vivianyentran <[email protected]> * Update src/docs/product/performance/retention-priorities/index.mdx Co-authored-by: vivianyentran <[email protected]> * Update src/docs/product/performance/retention-priorities/index.mdx Co-authored-by: vivianyentran <[email protected]> * Update src/docs/product/performance/retention-priorities/index.mdx Co-authored-by: vivianyentran <[email protected]> * [getsentry/action-github-commit] Auto commit * Update src/docs/product/performance/retention-priorities/index.mdx * Update index.mdx * Update src/docs/product/accounts/early-adopter-features/index.mdx --------- Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com> Co-authored-by: Riccardo Busetti <[email protected]> Co-authored-by: vivianyentran <[email protected]>
1 parent c4af786 commit 9a40a54

File tree

5 files changed

+37
-0
lines changed

5 files changed

+37
-0
lines changed

src/docs/product/accounts/early-adopter-features/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ Limitations:
2323
- [Priority Sort](/product/issues#issue-sort) algorithm improvements
2424
- [Issue Reprocessing](/product/issues/reprocessing/)
2525
- [Span Summary](/product/performance/transaction-summary/#span-summary)
26+
- [Investigation Mode](/product/performance/retention-priorities/#investigation-mode) for retention priorities in Performance Monitoring

src/docs/product/performance/retention-priorities/index.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,42 @@ Some projects within your organization are very high volume compared to others.
8383
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.
8484
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.
8585

86+
### Investigation Mode
87+
88+
<Include name="feature-available-for-user-group-early-adopter.mdx" />
89+
90+
Our automated retention priorities work well in a generic manner to collect a baseline of samples because they prioritize retaining data that is valuable for any customer at any given time. However, there are certain scenarios, such as investigating a particular issue, when very specific data becomes temporarily more important. In such cases, sometimes the automated sampling priorities do not provide enough samples, so you may want to create investigation rules.
91+
92+
Investigation rules are sampling rules that can be created through the Sentry UI to temporarily boost the amount of transactions collected for a particular scenario (for example, transactions with specific tag values, etc.). These rules can be created to retain more samples when too few (less than 5) are currently available.
93+
94+
#### Creating a New Investigation Rule
95+
96+
When you perform a query on transactions either in [Discover](/product/discover-queries/) or in [Transaction Summary](/product/performance/transaction-summary/) and receive fewer than 5 samples, you can click "Get Samples" to create a new investigation rule to retain more samples of transactions for the respective query.
97+
98+
![Investigation Mode in Discover](./investigation-bias-discover.png)
99+
100+
<Note>
101+
102+
Please note that this feature only applies to transactions. Therefore, in Discover, you have to specify `event.type:transaction` in the query to access the feature, whereas in Performance the event type is implicit.
103+
104+
</Note>
105+
106+
Clicking this button triggers the creation of an investigation rule for the respective query. After the successful creation of the rule, a notification will appear and the button for creating the investigation rule will be replaced by a message specifying that the investigation is in progress and the amount of time since it has been active.
107+
108+
![Rule successfully created](./investigation-bias-rule-created.png)
109+
110+
If a user performs the same search later and the investigation is still active, the notification will indicate that there is an active rule collecting data for the query.
111+
112+
Creating a rule is also possible from the Transaction Summary page in Performance.
113+
114+
![Investigation Mode in Transaction Summary](./investigation-bias-tx-summary.png)
115+
116+
#### Notes and current limitations
117+
118+
Once created, a rule remains active for up to 48h or until 100 samples are collected. You will be notified via email once the collection is completed.
119+
120+
Investigation sampling rules apply to transactions and do not guarantee sampling of full traces. A maximum of 50 sampling rules can exist simultaneously.
121+
86122
### Deprioritized Transactions
87123

88124
Sentry automatically deprioritizes the following transactions:
Loading
Loading
Loading

0 commit comments

Comments
 (0)