Skip to content

Commit 7d2c2c4

Browse files
doralchanDora Chanmarkstory
authored
fix(discv2 docs): updating screenshots and navigation (#1762)
* updated screenshots * updating screenshots * added perf spanshots * updated discovery and query builder * added query builder instructions * wrote query builder details on tags summary and cell * relinked to tag info * added space between stack trace * explains what a saved query looks like Co-authored-by: Mark Story <[email protected]> * better meaning of what confirm means Co-authored-by: Mark Story <[email protected]> * generalize query blder ref * syntax Co-authored-by: Dora Chan <[email protected]> Co-authored-by: Mark Story <[email protected]>
1 parent 8dc8d63 commit 7d2c2c4

File tree

10 files changed

+136
-174
lines changed

10 files changed

+136
-174
lines changed
Loading
-267 Bytes
Loading
26.6 KB
Loading
3.41 KB
Loading
22.1 KB
Loading
126 KB
Loading
118 KB
Loading
124 KB
Loading

src/collections/_documentation/performance/discover/index.md

Lines changed: 52 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -7,85 +7,89 @@ Our Discover tool provides visibility into your data across environments by buil
77

88
[{% asset discover/discover-homepage.png alt="Full view of the Discover Homepage with query cards and button to build new queries." %}]({% asset discover/discover-homepage.png @path %})
99

10-
## Discover Homepage
10+
The Discover Homepage offers views of all your saved and pre-built queries so you can quickly dive into areas that need immediate attention. For example, if a spike occurred in the past 24 hours for a query on errors, a user may investigate that first. Each query is saved as a card that displays a summarized view of the data.
1111

12-
The Discover Homepage offers views of all your saved queries and Sentry's pre-built queries so you can quickly dive into areas that need immediate attention. Circular Sentry avatars indicate pre-built queries. User avatars indicate saved queries. The user who creates a saved query will automatically have their avatar attached to the saved query.
12+
- Display Name
13+
- Search Conditions
14+
- Creator
15+
- Graph Snapshot
16+
- Date Range
17+
- Last Edited
1318

14-
### Query Cards
19+
## Pre-built Queries
1520

16-
Query cards are the individual cards on the Homepage that display a summarized view of the data in a specific query. Users can get a high-level view of the information in each query card to see what they want to investigate first. For example, if a spike occurred in the past 24 hours, a user may view that query first.
17-
18-
### Pre-built Queries
19-
20-
Circular Sentry avatars indicate pre-built queries.
21+
Query cards with Sentry avatars are pre-built and cannot be removed.
2122

2223
- All Events: Users can see the raw error stream for any group of projects. This replaces the Events feature and gives users the ability to add additional columns and change groupings to achieve their desired breakdown.
2324
- Errors by Title: Users can see their most frequently occurring errors by the total number of raw errors, as well as the total number of users affected.
2425
- Errors by URL: Users can see the pages that generated the most errors and different types of issues. As a reminder, issues are a group of fingerprinted Events. For more details, see the [full documentation on fingerprinting]({%- link _documentation/data-management/event-grouping/index.md -%}).
2526

26-
### Saved Queries
27-
28-
User avatars indicate saved queries. The user who creates a saved query will automatically have their avatar attached to the saved query.
29-
30-
**Deleting or Duplicating Saved Queries**
27+
## Saved Queries
3128

32-
Delete or duplicate a saved query in the Context Menu --- looks like ellipses --- located in the lower right corner of each query card.
29+
Query cards with a user avatar indicate saved queries. The user who created a saved query will have their avatar display on the query card. Saved Queries are viewable by anyone in your organization, and **are not** scoped to the user's account.
3330

34-
**Searching Saved Queries**
31+
**Build a New Query**
3532

36-
Saved queries will be viewable by anyone in your Sentry organization. You can use our search bar on the homepage to find a specific query.
37-
38-
39-
## Query Builder
40-
41-
[{% asset discover/discover-results.png alt="Page displaying a graph of error spikes by URL, the event tag summary, and results of the query." %}]({% asset discover/discover-results.png @path %})
42-
43-
Navigate to any query page from the Discover Homepage in these ways:
33+
From the Discover Homepage, you can build a query in three ways.
4434

4535
- Click on "Build a new query"
46-
- Click on any pre-built or saved queries
47-
48-
On the query's results page, you'll find the graph, table, and facet maps. The Query Builder enables the user to create custom views of the events sent to Sentry.io. You can add any tags/fields as columns, aggregate with columns, and sort with columns.
36+
- Click on the ellipsis of an existing saved query card to "Duplicate"
37+
- Go into any existing query
38+
1. Click on "Save as..." in the top right
39+
2. Enter a display name
40+
3. Click "Save"
4941

50-
If you don't apply aggregate functions to any of the applicable columns, or if they're not present, Sentry doesn't group the rows. If aggregate functions are present, Discover results group by unaggregated columns (tags, events). The unaggregated columns act as grouping keys and combine rows that have the same values as summary rows. Each summary row has the corresponding values in the specified columns. Aggregate functions (`avg`, `count`, `count_unique`) are optional.
42+
Apply new search conditions or table columns to modify the results of the query. Save the query and assign a custom display name. For the full details, see [documentation on the Query Builder]({%- link _documentation/performance/discover/query-builder.md -%}).
5143

52-
### Sharing Query Views
44+
**Search for a Query**
5345

54-
Share your queries as often as you want. You can share URLs with other users who also have access to the same organization. As each part of the query is built, the results update, and the URL is updated so that in-progress searches can be shared in email/chat.
46+
Looking for a specific query? Use the search bar on the homepage to find the query name.
5547

56-
### Saved Query
48+
**Sort Queries**
5749

58-
Although search queries are shareable, you can save them as saved queries. Saved queries are visible to the entire organization. In other words, saved queries **are not** scoped to the user's account. You can find saved queries on the Discover Homepage with the avatar of whoever built it. Circular Sentry logos indicate pre-built queries. You can use either a pre-built query or an existing saved query to create a new saved query.
50+
The dropdown in the top right will allow you to sort by attributes.
5951

60-
For more details, see [full documentation on the Query Builder]({%- link _documentation/performance/discover/query-builder.md -%}).
52+
- Recently Edited (Default)
53+
- My Queries
54+
- Query Name (A-Z)
55+
- Date Created (Newest)
56+
- Date Created (Oldest)
57+
- Most Outdated
6158

62-
### Performance Homepage
63-
Custom queries also provide more curated views in the [Performance Homepage]({%- link _documentation/performance/performance-homepage.md -%}). In the Performance Homepage, you can investigate transaction spikes, possible performance regressions, average transaction duration, etc. Together, Discover and Performance offer multiple views of errors and data.
59+
**Edit Queries**
6460

65-
## Event Details
61+
If you need to edit any of these queries, go into the query, make the desired changes and a button will appear in the top right asking you to save/update the query. Keep in mind, edits to the query conditions **will not** be automatically saved.
6662

67-
[{% asset discover/discover-event-details.png alt="Event detail page displaying a graph with spikes, the event details, and different metrics for tags." %}]({% asset discover/discover-event-details.png @path %})
63+
To rename a saved query, click on the pencil icon by the header and enter the desired display name. Click "enter" or outside of the area to save the updated name.
6864

69-
Navigate to the Event Details page from **Discover > Query > Event Detail**. On the Event Details view, you can find all of the details about a single event.
65+
**Share Queries**
7066

71-
On the left, you will see a series of tabs. These tabs contain details about the various contexts, and event dimensions Sentry has captured.
67+
Share your queries as often as you want. You can share URLs with other users who also have access to the same organization. As each part of the query is built, the results update, and the URL is updated so that in-progress searches can be shared in email, chat, etc.
7268

73-
On the right, you will see the current event's identifier, timestamp, and link to view the normalized JSON payload that Sentry received. You can also see the event's linked issue and tag details.
69+
**Delete Queries**
7470

75-
The right sidebar can be hidden with the "Hide Details" button found in the Event Details header.
71+
{% capture __alert_content -%}
72+
Deleting a saved query is irreversible.
73+
{%- endcapture -%}
74+
{%- include components/alert.html
75+
title="Warning"
76+
content=__alert_content
77+
level="warning"
78+
%}
7679

77-
### Tags
80+
On the Discover Homepage, each saved query card has an ellipsis that will open a context menu. Delete the query from here. You can also delete the query within Query Results view by clicking the trash can in the upper right.
7881

79-
The tag value links displayed on the Event Details can be used to refine your search results further. Clicking on any tag link will take you to a new Discover query with the clicked tag value added as a condition. If you were looking at an aggregated result, the new query will have all aggregations removed. This allows you to drill into aggregated results and explore your data more quickly.
82+
## Query Results
83+
[{% asset discover/discover-results.png alt="Page displaying a graph of error spikes by URL, the event tag summary, and results of the query." %}]({% asset discover/discover-results.png @path %})
8084

81-
### Details Graph
85+
To view query results, click into any query card. You'll find a graph, table, and toggleable tag summary (or facet map). The search bar at the top enables you to see the search conditions entered. The table reflects the events with sortable columns.
8286

83-
If your query included aggregations, the Event Details view will contain a graph at the top of the page. This graph visualizes the volume of events within the aggregation over time. The pin marker and vertical bar indicate the position of the currently displayed event within the aggregation. Hovering over the graph line will display a tooltip with more precise time and event volume details.
87+
If the first column shows an icon (as seen above), it means the events have been stacked. Click on the icon to view the full list of events. Each event will have an event ID you can click on for more details. For more about how to build a query, go to [the Query Builder]({%- link _documentation/performance/discover/query-builder.md -%}).
8488

85-
### Traversing Aggregated Events
89+
## Event Details
8690

87-
When viewing results that include aggregations, you can use the "Older" and "Newer" navigation buttons on the top right to view other events from the current aggregation. You can also click on the line displayed in the Details Graph to navigate to an event within that time slice.
91+
[{% asset discover/discover-event-details.png alt="Event detail page displaying a graph with spikes, the event details, and different metrics for tags." %}]({% asset discover/discover-event-details.png @path %})
8892

89-
### Related Issues
93+
Navigate to the Event Details page from **Discover > [Saved Query] > Event Detail**. You'll find all the relevant details about a single event. For every event, you will see the ID, timestamp, and link to view the normalized JSON payload that Sentry received.
9094

91-
On events that have an issue, a related issue panel will be shown in the sidebar. This panel gives you a quick glance at the event volume for that issue and lets you quickly navigate to the related issue.
95+
The Event Detail view varies depending on event type (i.e. error, transaction, csp). For example, errors may have a related issue shown in the sidebar. This panel gives you a quick glance at the event volume for that issue and lets you quickly navigate to the related issue. You may also find stack traces, breadcrumbs and more in these views.

0 commit comments

Comments
 (0)