Skip to content

Commit 9ffb328

Browse files
sfanahataShannon Anahata
andauthored
Global dashboard filters in docs (#15599)
## DESCRIBE YOUR PR Added details about global dashboard filters. Updated some related docs while in transition to new dashboards paradigm. Main preview: https://sentry-docs-git-global-dashboard-filters.sentry.dev/product/dashboards/ https://sentry-docs-git-global-dashboard-filters.sentry.dev/product/dashboards/#global-filters Updated related pages under /product/dashboards to remove old plan requirements. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [x] Other deadline: Feature is in EA, so should get out ASAP - [ ] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Shannon Anahata <[email protected]>
1 parent 708f57e commit 9ffb328

File tree

6 files changed

+27
-35
lines changed

6 files changed

+27
-35
lines changed

docs/product/dashboards/custom-dashboards/index.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,18 @@ description: >-
77
og_image: /og-images/product-dashboards-custom-dashboards.png
88
---
99

10-
<Include name="feature-available-for-plan-trial-business.mdx" />
11-
12-
Custom dashboards are shared across your organization, and users can view each other’s custom dashboards in the management view. Note that any changes you make are global, and will appear for users across the entire organization.
10+
Custom dashboards are shared across your organization, and users can view each other’s custom dashboards on the Dashboards home page. Note that any changes you make and **save** are global, and will appear for users across the entire organization.
1311

1412
## Manage Dashboards
1513

16-
When you have either a Business or Trial Plan, navigating to **Dashboards** takes you to a view where you can manage dashboards instead of the [default dashboard](/product/dashboards/). From here, you can:
14+
On the Dashboards home page, you can:
1715

1816
- [Create a dashboard](#create-dashboards)
1917
- [Create a dashboard from a template](#create-dashboards-from-templates)
2018
- Duplicate a dashboard
2119
- Delete a dashboard
2220

23-
![Manage mode.](./img/dashboard-management.png)
21+
![Manage mode =900x](./img/dashboard-management.png)
2422

2523
### Create Dashboards
2624

@@ -31,15 +29,15 @@ Clicking "Create Dashboard" takes you to a new dashboard where you can immediate
3129
- Rearrange existing widgets
3230
- Resize existing widgets
3331

34-
![Edit mode.](./img/dashboard-template.png)
32+
![Edit mode. =700x](./img/dashboard-template.png)
3533

3634
### Create Dashboards From Templates
3735

3836
When the "Show Templates" toggle is enabled, several default dashboard templates are displayed. You can add each template directly to the list of dashboards by clicking "Add Dashboard", or preview it by clicking "Preview". You have to add a template before you can edit the resulting dashboard. You can also duplicate or delete a dashboard created from a template (this does not delete the template).
3937

4038
### Dashboard Filters
4139

42-
Dashboard filters are applied to all the widgets in your dashboard. They consist of [page filters](/concepts/search/#page-filters) that allow you to narrow down the widget results to certain projects, environments, and date ranges, and a release filter that restricts the data to certain releases. Changing a dashboard filter will prompt you to "Save" or "Cancel". To persist filter changes to your dashboard, click "Save", or click "Cancel" to discard the changes.
40+
Dashboard filters are applied to all the widgets in your dashboard. By default, they consist of [page filters](/concepts/search/#page-filters) that allow you to narrow down the widget results to certain projects, environments, date ranges, and releases. You can also add custom filters to your dashboard by pressing the _plus_ button. Each filter begins with selecting a dataset, and then adding a filter condition. You can add multiple filters to your dashboard, and they will be applied to all widgets in the dashboard. Changing a dashboard filter will prompt you to "Save" or "Cancel". To persist filter changes to your dashboard, click "Save", or click "Cancel" to discard the changes.
4341

4442
### Dashboard Edit Access
4543

221 KB
Loading

docs/product/dashboards/index.mdx

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,26 @@ og_image: /og-images/product-dashboards.png
99

1010
Sentry's <SandboxLink scenario="dashboards" projectSlug="react">Dashboards</SandboxLink> provide you with a broad overview of your application’s health by allowing you to navigate through error and performance data across multiple projects. Dashboards are made up of one or more widgets, and each widget visualizes one or more [dataset](/product/dashboards/widget-builder/#choose-your-dataset).
1111

12-
![Widgets visualizing events, errors by country, affected users, and handled vs unhandled issues.](./img/dashboard-customise.png)
12+
![Widgets visualizing events, errors by country, affected users, and handled vs unhandled issues. =900x](./img/custom-dash.png)
1313

14-
All widgets in the same view reflect the date range indicated in date time range filter and update synchronously if you update that date range. You can also zoom in on any time series visualizations you may want to investigate, and all of the widgets reflect the time period that you’ve zoomed in on.
14+
15+
## Global Filters
16+
17+
All widgets in the same view reflect the results of the global filters set at the top of the dashboard.
18+
19+
By default, projects, environments, date range, and release must be set, and will apply to all widgets in the dashboard. You can also zoom in on any time series visualizations you may want to investigate, and all of the widgets will reflect the time period that you’ve zoomed in on.
20+
21+
### Custom Filters
22+
23+
You can also add custom global filters to your dashboard by pressing the _plus_ button. Each filter begins with selecting a dataset, and then adding a filter condition. You can add multiple filters to your dashboard, and they will be applied to all widgets _relating to that dataset_ in the dashboard.
24+
25+
### Dashboard Edit Access
26+
27+
To restrict who can edit or delete your dashboard, go to the "Edit Access" selector. As the dashboard creator, you can limit access to specific teams by selecting the checkboxes in the Edit Access Selector and clicking Save Changes to apply the updates. Dashboard creators and organization owners always retain edit access.
1528

1629
## Custom Dashboards
1730

18-
If you’d like to edit the default dashboard or build out multiple ones, each with its own set of unique widgets, you may want to consider our [Custom Dashboards](/product/dashboards/custom-dashboards/) feature which enables you to create more robust views such as the one below.
31+
Every organization has a general template dashboard that is shared across all users. If you’d like to edit the default dashboard or build out new ones, each with its own set of unique widgets, you may want to consider the [Custom Dashboards](/product/dashboards/custom-dashboards/) feature which enables you to create more robust or customized views for example, to track performance of a specific feature or to track errors by a specific team's ownership.
1932

2033
## Open Dashboard Widgets in Discover and Issues
2134

docs/product/dashboards/widget-builder/index.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@ description: Learn how to create widgets for your dashboards or edit existing on
55
og_image: /og-images/product-dashboards-widget-builder.png
66
---
77

8-
<Include name="feature-available-for-plan-trial-business.mdx" />
9-
108
When adding a widget or editing an existing one, a side panel opens up where you can see the dashboard widget builder:
119

12-
![Widget Builder overview.](./img/widget-builder-overview.png)
10+
![Widget Builder overview. =900x](./img/widget-builder-overview.png)
1311

1412
The widget builder has several configuration options that you can use to shape data and add information to your dashboard. These options are presented as steps in the widget builder, but you don't have to do them in the order they're presented in.
1513

docs/product/dashboards/widget-library/index.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ description: >-
77
og_image: /og-images/product-dashboards-widget-library.png
88
---
99

10-
<Include name="feature-available-for-plan-trial-business.mdx" />
11-
12-
The widget library contains a collection of prebuilt widgets you can add to your [custom dashboards](/product/dashboards/customize-dashboards/). You can access the widget library by clicking the "Add Widget" button and selecting "From Widget Library" on the dashboard.
10+
The widget library contains a collection of prebuilt widgets you can add to your [custom dashboards](/product/dashboards/custom-dashboards/). You can access the widget library by clicking the "Add Widget" button and selecting "From Widget Library" on the dashboard.
1311

1412
The library includes the following widgets:
1513

@@ -67,7 +65,7 @@ Finally, add a third query for for the frustrating transaction duration:
6765

6866
The chart now shows cumulative counts at different response time thresholds.
6967

70-
![Response Thresholds Widget.](./img/widget-library-response-thresholds-widget.png)
68+
![Response Thresholds Widget. =900x](./img/widget-library-response-thresholds-widget.png)
7169

7270
### My top issues
7371

docs/product/explore/discover-queries/index.mdx

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,6 @@ description: >-
77
og_image: /og-images/product-explore-discover-queries.png
88
---
99

10-
<Alert>
11-
12-
This feature is available only if your organization is on either a Business or Trial Plan, with the exception of the ["All Events" pre-built query](/product/explore/discover-queries/#pre-built-queries), which is available on Team plans or higher.
13-
14-
</Alert>
15-
16-
<SandboxLink scenario="discover" projectSlug="react">Discover</SandboxLink> provides visibility into your data across environments by building
17-
upon and enriching your error data. You can <SandboxLink scenario="oneDiscoverQuery" projectSlug="react">query</SandboxLink> and unlock insights into the health of your entire system and get
18-
answers to critical business questions — all in one place. Use <b>Discover</b> to
19-
view comprehensive information sent to Sentry.
20-
21-
![Full view of the Discover Homepage with query cards and button to build new queries.](./img/discover-homepage.png)
22-
2310
The Discover homepage displays the query builder where you can immediately begin creating a new query. By default, the page shows the pre-built "All Events" query, but you can customize the homepage and [set the custom version as your default](#set-as-default). To navigate back to the query management page, where you can find [pre-built](#pre-built-queries) and [saved](#saved-queries) queries, click the "Saved Queries" button.
2411

2512
The query management page offers views of all your saved and pre-built queries so you can quickly see areas that need immediate attention. For example, if a query on errors shows a spike has occurred in the past 24 hours, you might want to investigate that first. Each query is saved as a card that displays a summarized view of the following data:
@@ -101,20 +88,18 @@ To navigate to the query management page, where you can find pre-built and saved
10188

10289
## Query Results
10390

104-
![Page displaying a graph of error spikes by URL, the event tag summary, and results of the query.](./img/discover-results.png)
91+
![Page displaying a graph of error spikes by URL, the event tag summary, and results of the query. =900x](./img/discover-results.png)
10592

10693
To view query results, click on any query card. You'll find a graph, table, and toggleable tag summary (or facet map). The top search bar lets you to see the search conditions entered. The table reflects the events with sortable columns.
10794

10895
Each table cell has a dynamic context menu that allows you to continue exploring your data by automatically updating the search bar or the table columns, according to your selection. Actions like adding or excluding values from the filter, opening a selected release, or viewing the underlying stack of issues:
10996

110-
![Context menu](./img/013.png)
97+
![Context menu =600x](./img/013.png)
11198

11299
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. Hovering over fields in the "Issue", "Release", and "Event ID" columns displays additional information like issue statuses, release authors, and stack traces for errors.
113100

114101
For more about how to build a query, go to [the Query Builder](/product/explore/discover-queries/query-builder/).
115102

116-
## Trace View
117-
118-
![Trace View](./img/trace-details-view.png)
103+
## Trace Explorer
119104

120105
You can see additional information about your event by clicking into any "Event ID" on the [**Discover**](https://sentry.io/orgredirect/organizations/:orgslug/discover) page. Clicking on any event type other than an error event, will take you to the [**Trace View**](/concepts/key-terms/tracing/trace-view/) page. Clicking on an error event will take you to the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page.

0 commit comments

Comments
 (0)