-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(widget-builder): Add GA documentation - [DD-539] #5065
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
43 commits
Select commit
Hold shift + click to select a range
e745be7
feat(widget-builder): Add GA documentation
priscilawebdev ca57442
add more text and links
priscilawebdev e3d3078
add screenshots
priscilawebdev 97a786d
add better anchors
priscilawebdev 56d1981
fix broken link and data set word
priscilawebdev 02a9a12
update widget loibrary doc
priscilawebdev d4a8403
remove page word
priscilawebdev 451b874
update widget library doc
priscilawebdev 7a94c52
update issue desc
priscilawebdev aecc8fe
remove unused screenshot
priscilawebdev 4067046
Update src/docs/product/dashboards/custom-dashboards/index.mdx
priscilawebdev 1095e03
Update src/docs/product/dashboards/custom-dashboards/index.mdx
priscilawebdev 8fcb047
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev e74a5d8
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 35dd9b1
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev ff4fb7e
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev e55563b
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev e942f8f
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev ff71d0e
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 8483c0a
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 6b01870
Update src/docs/product/dashboards/widget-library/index.mdx
priscilawebdev 40f41fd
Update src/docs/product/dashboards/widget-library/index.mdx
priscilawebdev 302e601
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 9f82fcc
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev ed43ebb
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 1858779
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 347b3fe
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 97271f0
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 9931be4
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev be58c17
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 125344b
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 85d4c16
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev ce79c39
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 9835061
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev bf2ccab
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 956cda4
more adjusts
priscilawebdev 79a0560
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 5a72fb0
Update src/docs/product/dashboards/custom-dashboards/index.mdx
priscilawebdev b8bd5ca
Update src/docs/product/dashboards/widget-builder/index.mdx
priscilawebdev 167a5a1
cr feedback
priscilawebdev 73461c7
add extra screenshot
priscilawebdev b0d75f6
changed "and" to "or"
imatwawana 1a32ca9
screenshot feedback
priscilawebdev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file removed
BIN
-161 KB
src/docs/product/dashboards/custom-dashboards/dashboard-widget-builder.png
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
--- | ||
title: Widget Builder | ||
sidebar_order: 15 | ||
description: "Learn how to create widgets for your dashboards or edit existing ones." | ||
--- | ||
|
||
<Note> | ||
|
||
This feature is available only if your organization is on either a Business or Trial plan. | ||
|
||
</Note> | ||
|
||
priscilawebdev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
When adding a widget or editing an existing one, you will be taken to a new page where you can see the dashboard widget builder: | ||
|
||
 | ||
|
||
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. | ||
|
||
Some of these options are standard and displayed for all widgets, but others are only displayed if you make specific selections. Below is a list of all the options that can be displayed when configuring your widget. | ||
|
||
## Widget Title | ||
|
||
By default, all new widgets are titled “Custom Widget”, but you can edit the title by clicking on the text. We recommend you update the title. | ||
|
||
## Choose Your Visualization | ||
|
||
In this step, you can choose from four different visualization types: | ||
|
||
- [Area Chart / Bar Chart / Line Chart](#area-chart--bar-chart--line-chart) | ||
- [Table](#table) | ||
- [World Map](#world-map) | ||
- [Big Number](#big-number) | ||
|
||
|
||
### Area Chart / Bar Chart / Line Chart | ||
|
||
Area, bar, and line chart visualizations allow you to plot one or more aggregate functions as a time series. | ||
|
||
 | ||
|
||
Each chart type allows you to solve different problems: | ||
|
||
- Area charts are ideal for showing results that are cumulative or where you want to show a breakdown. An example would be “count of errors for each major browser”. | ||
- Bar charts will group results by day, making them good for daily roll-ups or as “big picture” summaries. An example would be “count of errors per day”. | ||
- Line charts are a general-purpose visualization. Make sure the Y-Axis units match if you add multiple overlays. Mixing count with duration will not yield useful results. | ||
|
||
### Table | ||
|
||
Table charts display the results of a [Discover Query](/product/discover-queries/). This visualization is well suited to showing key fields and related aggregates. For example “duration percentiles for the most frequently visited transaction names”. You can also choose to display [issues](/product/issues/) data in a table visualization using the [dataset selector](/product/dashboards/widget-builder/#choose-your-dataset). | ||
|
||
### World Map | ||
|
||
Events are queried using the given function and `geo.country_code`. The results are plotted as a density value on a world map. An example scenario would be “in which countries are users experiencing the most errors”. You can zoom the map using the mouse wheel, or pan the map by clicking and dragging the map around. | ||
|
||
### Big Number | ||
|
||
A big number visualization displays the current value of a single function. This visualization is well suited for high-level aggregates. An example scenario would be “p95 of all transactions”. | ||
|
||
## Choose Your Dataset | ||
|
||
In the dataset selection step, choose which type of data you would like to use in your widget. This data is classified into two different datasets: [errors and transactions](#errors--transactions) and [issues](#issues). | ||
|
||
### Errors & Transactions | ||
|
||
Choosing "Errors and Transactions" allows you to query and aggregate error and transaction events in the same way you would for a [Discover Query](/product/discover-queries/). Some widget examples include: | ||
|
||
- Tracking performance of an endpoint | ||
- Throughput by country | ||
- Users most affected by errors | ||
|
||
### Issues | ||
Choosing "Issues (States, Assignment, Time, etc.)" allows you to query issue properties, such as `is:unresolved` or event properties such as `error.handled:0`, and to sort by issue fields such as `First Seen`. When searching on event properties, the search will return any issue that has one or more events matching the supplied event filters. | ||
Choose this dataset if you want to customize a list of issues on your dashboard. Some widget examples include: | ||
|
||
- Issues assigned to your team | ||
- Most frequently occurring issues | ||
- The "Issues" dataset is only available in table visualization widgets and its disabled if you have other visualizations selected. | ||
|
||
## Choose Your Columns | ||
|
||
The option to set columns is only available for [table visualizations](/product/dashboards/widget-builder/#table). | ||
|
||
By default, the first column is already configured for you, but you can update it. To add more columns, which stacks events, add [functions](/product/discover-queries/query-builder/#stacking-functions) (`f(x)`) that can take in parameters. [Field and tag columns](/product/sentry-basics/search/searchable-properties/#event-properties) will help you view more details about the events (for example, `title` to see the description of an issue or `users` to see how many users it's affecting). | ||
|
||
You can also add equations to your query using the table columns as equation variables, and the results will be displayed in the query results table. Learn more in [Adding Query Equations](/product/discover-queries/query-builder/query-equations/). | ||
|
||
Next to each column and equation, you have the option to set an alias that will replace the column name in the table header. | ||
|
||
If two or more columns are added, you can change the order in which they're displayed in the table by clicking and dragging them: | ||
|
||
 | ||
|
||
## Choose What to Plot in the Y-axis | ||
|
||
The option to set a y-axis is available on all visualizations except [table](/product/dashboards/widget-builder/#table). In the case of [time-series visualizations](/product/dashboards/widget-builder/#area-chart--bar-chart--line-chart), you'll be able to plot up to three values that can be functions or equations. If the units of your selections conflict, then the y-axis of the chart will be labeled using the units of the first selection. | ||
|
||
You can also choose to construct an equation by clicking “Add an Equation”. Doing this displays a text box where you can enter your equation. Functions that you've added previously in this step will appear for autocompletion, but you can add other functions as well. | ||
|
||
## Filter Your Results | ||
|
||
Use this field to filter your results by the searchable properties of your [dataset selection](/product/dashboards/widget-builder/#choose-your-dataset). For more information on which properties apply to each dataset, check out our [full Searchable Properties documentation](/product/sentry-basics/search/searchable-properties/#properties-table). | ||
|
||
On [time-series visualizations](/product/dashboards/widget-builder/#area-chart--bar-chart--line-chart) you can add up to three queries to filter your results, each with their own search conditions, to compare results. Each query will generate a new series in your chart for each y-axis. To make it easier to differentiate between them in the legend and tooltip, you can add a legend alias that will be added as a prefix to the labels, as in the example below: | ||
|
||
 | ||
|
||
## Group Your Results | ||
|
||
The option to group results is only available for [time-series visualizations](/product/dashboards/widget-builder/#area-chart--bar-chart--line-chart). You can group your time series results by different fields or tags such as project, environment, or transaction. You can select up to 20 fields to group your data. | ||
|
||
If two or more groups are added, a draggable element will be displayed that you can use to sort the fields, but the sort does not impact how your data is displayed in the visualization: | ||
|
||
 | ||
|
||
## Sort By a Column | ||
|
||
The option to sort by a column is only available for [table visualizations](/product/dashboards/widget-builder/#table). Choose one of the columns of your table to sort by, and set whether you want to sort high-to-low or low-to-high. | ||
|
||
## Limit | ||
|
||
The option to limit your results is only available for [time-series visualizations](/product/dashboards/widget-builder/#area-chart--bar-chart--line-chart) where you've applied a grouping. Depending on your configuration (for example, multiple y-axes, multiple queries), your chart results could become unmanageable, so a limit is imposed. You can change this limit by selecting it in the dropdown. We intend to show at most 10 series (that is, lines in a line chart or bars in a bar chart) when multiple y-axes or queries are selected. | ||
|
||
## Sort By a Y-axis | ||
|
||
The option to sort by a y-axis is only available if you've applied a grouping to your data (in [“Group your results”](/product/dashboards/widget-builder/#group-your-results)). The sorting applies to the underlying groups in your results and thus affects the series that appear in your chart. You can select fields that you used for grouping, select equations defined in the y-axes, construct any function similar to how you would select a function for plotting, or construct a custom equation. | ||
|
||
If you select “Custom Equation”, an extra field appears where you can enter an equation of your choice that will be applied to the query: | ||
|
||
 | ||
|
||
|
||
|
Binary file added
BIN
+69.7 KB
...docs/product/dashboards/widget-builder/widget-builder-custom-equation-field.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+107 KB
src/docs/product/dashboards/widget-builder/widget-builder-drag-and-drop-column.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+72.2 KB
...ocs/product/dashboards/widget-builder/widget-builder-drag-and-drop-group-by.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+467 KB
...roduct/dashboards/widget-builder/widget-builder-filter-your-results-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+322 KB
src/docs/product/dashboards/widget-builder/widget-builder-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file removed
BIN
-147 KB
src/docs/product/dashboards/widget-library/dashboard-response-threshold-widget.png
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+310 KB
...product/dashboards/widget-library/widget-library-response-thresholds-widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.