Skip to content

Commit 4eee643

Browse files
MichaelSun48lizokm
andauthored
docs(custom-views): Add custom views documentation (#11390)
* First draft of custom views documentation * Apply Liza's suggestions 🙏 Co-authored-by: Liza Mock <[email protected]> * Add note about temp tabs being... temporary * Custom views -> issue views, indicate that saved searches is deprecated * Add pictures, update some copy, move issue views to above issue details * Update Issue Priority copy * Add early adopter notes * edits Co-authored-by: Liza Mock <[email protected]> * Change example to low prio * better unsaved changes screenshot --------- Co-authored-by: Liza Mock <[email protected]>
1 parent 7a9f88c commit 4eee643

File tree

7 files changed

+61
-3
lines changed

7 files changed

+61
-3
lines changed

docs/concepts/search/saved-searches.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ keywords: ["saved search", "premade searches"]
55
description: "Learn more about default, recommended, and saved searches."
66
---
77

8+
<Alert>
9+
Saved Searches has been deprecated and will be removed at the end of the year. Your saved searches will still be available in the "Add View" menu on the **Issues** page. Any saved search can be converted to an Issue View.
10+
</Alert>
11+
812
Sentry allows you to save searches you've made on the **Issues** page. At the top of the page, next to the search bar, click "Custom Search" to access the "Saved Searches" sidebar.
913

1014
![UI walkthrough of the Saved Searches feature.](./img/saved-searches.gif)

docs/organization/early-adopter-features/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Limitations:
1717

1818
## Current Early Adopter Features
1919

20+
- [Issue Views](/product/issues/issue-views/)
2021
- [Issue Status](/product/issues/states-triage/) tags
2122
- [Span Summary](/product/performance/transaction-summary/#span-summary)
2223
- [Investigation Mode](/product/performance/retention-priorities/#investigation-mode) for retention priorities in Tracing

docs/product/issues/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ For error issues, to see the stack trace of the latest event, you can hover over
3030

3131
![Error level icon](./img/error_level.png)
3232

33-
You can save your issue queries and access them later by clicking the the "Saved Searches" button in the header. Learn more in [Saved Searches](/concepts/search/saved-searches/). You can also add issues data to your [custom dashboards](/product/dashboards/custom-dashboards/) as widgets using the [dataset selector](/product/dashboards/widget-builder/#choose-your-dataset).
33+
{/* TODO(msun): Update this when issue views are GA'd */}
34+
You can save your issue queries and access them later by clicking the "Saved Searches" button in the header. Learn more in [Saved Searches](/concepts/search/saved-searches/). You can also add issues data to your [custom dashboards](/product/dashboards/custom-dashboards/) as widgets using the [dataset selector](/product/dashboards/widget-builder/#choose-your-dataset).
3435

3536
When you click on an issue on the main **Issues** page, the **Issue Details** page for that issue is displayed. Learn more in [Issue Details](/product/issues/issue-details/).
3637

docs/product/issues/issue-priority/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ You can update issue priority manually at any time, either from the issue detail
3636

3737
## Priority in the Issue Stream
3838

39-
By default, the issue stream on the **Issues** page filters out low-priority issues. If you'd like to be able to see low-priority issues, you can [set your default search](/product/reference/search/saved-searches/#set-a-default-search) to include them.
39+
The default view on the **Issues** page is the "Prioritized" view, which shows high and medium priority issues. But all views can be filtered to include, for example, only low priority issues by adding the query `issue.priority:low` to the search bar and saving the view.
4040

41-
When viewing the "Prioritized" tab, you can quickly triage issues by using the priority dropdown. Low-priority issues will disappear from the "Prioritized" tab once their priority is updated.
41+
You can also update the priority level of an issue directly from the issue stream by clicking on the priority dropdown within an issue.
4242

4343
![Issue Priority Dropdown](/product/issues/issue-priority/issue-priority-dropdown.png)
4444

970 KB
Loading
34.1 KB
Loading
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: Issue Views
3+
sidebar_order: 9
4+
description: "Learn how to customize your issue stream in Sentry and quickly see the issues that are most important to you."
5+
---
6+
7+
Issue views let you customize what shows up in your issue stream so you can quickly see what's most important to you. You have full control over which search query your issue stream renders by default, and which other queries are within a click's reach.
8+
9+
<Note>
10+
This feature is only available if your organization has enabled [early adopter features](/organization/early-adopter-features/). Early adopter features are still in-progress and may have bugs. We recognize the irony. If you’re interested in participating, enable early adopter features in [organization settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/organization).
11+
</Note>
12+
13+
## Creating Your First View
14+
15+
To create your first custom issue view, navigate to the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page and click the **Add View** button. You'll see the following page:
16+
17+
![Add View Page](./img/issue_views_add_view.png)
18+
19+
Here, you'll be able to select a view from one of the recommended options or create your own by following the instructions below:
20+
21+
22+
1. **Name your view**: Give your view a name that describes the types of issues it will show.
23+
2. **Set your view's search query**: Choose the search query that will be applied by default when you select this view. Don't forget to hit enter to apply the query!
24+
3. **Set your view's sort**: Select how you want the issues to be sorted in this view (for example, by date, events, and so on).
25+
4. **Save your view**: Click on the ellipsis menu within the tab and select **Save Changes**.
26+
27+
<Note>
28+
If you had a default custom saved search, it'll be converted to an issue view and will appear as your default view automatically, just like before. Any other saved searches you created will be available in the **Add View** menu until the end of the year. Please save them as views if you'd like to keep them.
29+
</Note>
30+
31+
## Customizing Your Views
32+
33+
34+
### Updating View Queries and Sorting
35+
36+
Views are defined by their search query and sort order, but you can safely change the query or sort within your view without changing the persistent query or sort. If you want to input a different query from the one your view was saved with, you'll see an **unsaved changes indicator** (shown below). To update your view with this new query or sort, click the ellipsis menu and select **Save Changes**. To discard them, click **Discard Changes** within the ellipsis menu, or close your Sentry tab without saving.
37+
38+
![Unsaved Changes Indicator](./img/issue_views_unsaved_changes_indicator.png)
39+
40+
### Reordering Views and Setting a Default View
41+
42+
Your can reorder your view tabs by dragging them to where you want them to be. The first tab will always be your default view and will be what you see when you first open the **Issues** page.
43+
44+
45+
### Renaming Views
46+
47+
To rename a view, select it from the tab list. Then, either double click on the view's name or click the ellipsis menu and select **Rename**, type in a new name, and hit enter.
48+
49+
50+
## Sharing Views
51+
52+
We built Issue Views in a way that makes them easy to share with people in your organization. To share, just copy the link to your issue view and send it to a fellow org member. The link will take them to a **temporary tab** that contains the same query and sort as your view. They'll then be able to save the view as their own by clicking **Save View**, or discard it by clicking **Discard**. Note, that temporary tabs will not be persisted across page navigations or reloads.

0 commit comments

Comments
 (0)