Skip to content

Commit fde589e

Browse files
authored
docs(metrics): Add search bar documentation (#5394)
Fixes PERF-1619
1 parent 8337373 commit fde589e

File tree

4 files changed

+34
-3
lines changed

4 files changed

+34
-3
lines changed

src/docs/product/performance/filters-display/index.mdx

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,26 @@ When you select "All Transactions", the table includes all transactions across a
3838

3939
"Mobile" puts an emphasis on [Mobile Vitals](/product/performance/mobile-vitals/). Note that if you've selected a non-mobile project, this mode also displays all of those transactions.
4040

41-
## Search Condition Filters
41+
## Filtering Transactions
42+
43+
### Transaction Name Search
44+
45+
<Note>
46+
47+
This feature is in beta and is only available if your organization is participating in the limited release of [metrics](https://docs.sentry.io/product/sentry-basics/metrics/). Features in beta are still in-progress and may have bugs. We recognize the irony. If you’re interested in participating, [join the waitlist](https://sentry.io/for/performance/#updates-signup). If you are not participating in the limited release, search condition filters are used instead of transaction search.
48+
49+
</Note>
50+
51+
When viewing the [metrics](https://docs.sentry.io/product/sentry-basics/metrics/) (processed) dataset, the search bar is used to filter by transaction name only, rather than to search for transactions matching the condition filters.
52+
53+
![Updated transaction search](transaction-name-search.png)
54+
55+
When you begin typing, a list of transaction names that match your search appear. There are two ways to interact with the search results:
56+
57+
1. Clicking on a transaction name will apply a filter on the Performance page to only display transaction data for the selected transaction.
58+
2. Clicking the upwards arrow icon on a search result will take you to that transaction's summary page.
59+
60+
### Search Condition Filters
4261

4362
The search bar operates similarly to the one in the Discover [Query Builder](/product/discover-queries/query-builder/#filter-by-search-conditions). For example, you can refine your transaction search to a specific release by using `release:` as a key field and assigning the version as a value.
4463

Loading

src/docs/product/performance/index.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ Using the information on this page, you can trace issues back through services (
2626

2727
## Filter Performance Data
2828

29+
<Note>
30+
31+
For organizations participating in the limited release of [metrics](https://docs.sentry.io/product/sentry-basics/metrics/), the transaction filter on the Performance page has been simplified. The search bar can only be used to filter by transaction name, rather than to search for transactions matching the query. See [transaction search](/product/performance/filters-display/#filtering-transactions).
32+
33+
</Note>
34+
2935
The <SandboxLink scenario="performance" projectSlug="react">Performance</SandboxLink> page provides you with several filter and display options so that you can focus on the performance data you want. Search conditions help you find the <SandboxLink scenario="oneTransaction" projectSlug="react">transactions</SandboxLink> you want to investigate. You can also control what kind of information is visualized in the [widgets](/product/performance/filters-display/#widgets) or which transactions appear first in the [transactions table](/product/performance/filters-display/#transaction-table).
3036

3137
## Analyze Performance Trends

src/docs/product/sentry-basics/search/index.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ Search is available on several features throughout [sentry.io](https://sentry.io
1212

1313
## Query Syntax {#syntax}
1414

15+
<Note>
16+
17+
For organizations participating in the limited release of [metrics](https://docs.sentry.io/product/sentry-basics/metrics/), the transaction filter on the Performance page has been simplified. The search bar can only be used to filter by transaction name, rather than to search for transactions matching the condition filters. See [transaction search](/product/performance/filters-display/#filtering-transactions).
18+
19+
</Note>
20+
1521
Search queries are constructed using a `key:value` pattern, with an optional raw search at the end. Each `key:value` pair is a `token` and the optional raw search is itself a single `token`. The `key:value` pair `tokens` are treated as issue or event properties. The optional raw search is treated as a single `token` and searches event titles/messages.
1622

1723
For example:
@@ -128,11 +134,11 @@ In the above example, the search query returns results which do not have message
128134

129135
Page filters allow you to narrow down the results shown on a page by restricting data to a certain project, environment, or date range.
130136

131-
![Page Filters](search-page-filters.png)
137+
![Page Filters](search-page-filters.png)
132138

133139
Typically, these filters only persist within the current page, but you can choose to "lock" the current filter selection. When you do this, the locked filter and any changes to it are persisted throughout the application and remembered between sessions.
134140

135-
![Page Filters Locking](search-page-filters-lock.png)
141+
![Page Filters Locking](search-page-filters-lock.png)
136142

137143
## Learn more
138144

0 commit comments

Comments
 (0)