-
Notifications
You must be signed in to change notification settings - Fork 8.6k
[DOCS] Adds documentation for drilldowns #68122
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 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
cbdc57c
[DOCS] Adds documentation for drilldowns
gchaps b79d844
[DOCS] Incorporates review comments
gchaps 2b97630
[DOCS] Fixes to text
gchaps 80ce6b9
Updated gif sans nav bars
KOTungseth cd5265e
[DOCS] Adds image of drilldowns and other tweaks to text
gchaps 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
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,103 @@ | ||
| [[drilldowns]] | ||
| == Use drilldowns for dashboard actions | ||
|
|
||
| Drilldowns, also known as custom actions, allow you to configure a | ||
| workflow for analyzing and troubleshooting your data. | ||
| Using a drilldown, you can navigate from one dashboard to another, | ||
| taking the current time range, filters, and other parameters with you. | ||
| Although the destination dashboard shows the data in a different structure, | ||
| the context is the same. You can continue your investigation from a new perspective. | ||
|
gchaps marked this conversation as resolved.
Outdated
|
||
|
|
||
| For example, you might have a dashboard that shows the overall status of multiple data centers. | ||
| You can create a drilldown that navigates from this dashboard to a dashboard | ||
| that shows a specific data center or server. | ||
|
gchaps marked this conversation as resolved.
Outdated
|
||
|
|
||
| [float] | ||
| [[how-drilldowns-work]] | ||
| === How drilldowns work | ||
|
|
||
| Drilldowns are Kibana actions configured by the user and stored | ||
|
gchaps marked this conversation as resolved.
Outdated
|
||
| in the dashboard saved object. Drilldowns are specific to the dashboard panel | ||
|
gchaps marked this conversation as resolved.
|
||
| for which they are created—they are not shared across panels. | ||
| A panel can have multiple drilldowns. | ||
|
|
||
| This example shows a dashboard panel that contains a pie chart. | ||
| Typically, clicking a pie slice applies the current filter. | ||
| When a panel has a drilldown, clicking a pie slice opens a menu with | ||
| the default action and your drilldowns. See the <<drilldowns-example, Try it section>> of this doc | ||
|
gchaps marked this conversation as resolved.
Outdated
|
||
| for instructions on how to create this drilldown. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/drilldown_on_piechart.png[Drilldown on pie chart that navigates to another dashboard] | ||
|
gchaps marked this conversation as resolved.
Outdated
|
||
|
|
||
| Third-party developers can create drilldowns. | ||
| See https://github.com/elastic/kibana/tree/master/x-pack/examples/ui_actions_enhanced_examples[this example plugin] | ||
|
gchaps marked this conversation as resolved.
Outdated
|
||
| to learn how to code drilldowns. | ||
|
gchaps marked this conversation as resolved.
|
||
|
|
||
| [float] | ||
| [[create-manage-drilldowns]] | ||
| === Create and manage drilldowns | ||
|
|
||
| To create and manage drilldowns, your dashboard must be in *Edit* mode. | ||
|
gchaps marked this conversation as resolved.
Outdated
gchaps marked this conversation as resolved.
Outdated
|
||
| The panel menu will then include a *Create drilldown* action. | ||
|
gchaps marked this conversation as resolved.
Outdated
|
||
| Once a panel has at least one drilldown, the menu also includes a *Manage drilldowns* action | ||
| for editing and deleting drilldowns. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/drilldown_menu.png[Panel menu with Create drilldown and Manage drilldown actions] | ||
|
gchaps marked this conversation as resolved.
|
||
|
|
||
| [float] | ||
| [[drilldowns-example]] | ||
| === Try it: Create a drilldown | ||
|
gchaps marked this conversation as resolved.
|
||
|
|
||
| This example shows how to create the drilldown shown previously in this doc. | ||
|
gchaps marked this conversation as resolved.
Outdated
|
||
|
|
||
| [float] | ||
| ==== Set up the dashboards | ||
|
|
||
| . Add the <<get-data-in, sample web logs>> data set. | ||
|
|
||
| . Create a new dashboard, called *Host Overview*, and include these visualizations | ||
|
gchaps marked this conversation as resolved.
Outdated
|
||
| from the sample data set: | ||
| + | ||
| [%hardbreaks] | ||
| *[Logs] Heatmap* | ||
|
gchaps marked this conversation as resolved.
|
||
| *[Logs] Visitors by OS* | ||
| *[Logs] Host, Visits, and Bytes Table* | ||
| *[Logs] Total Requests and Bytes* | ||
| + | ||
| TIP: If you don’t see data for a panel, try changing the time range. | ||
|
|
||
| . Open the prebuilt *[Logs] Web traffic* dashboard. | ||
|
gchaps marked this conversation as resolved.
Outdated
|
||
|
|
||
| . Set a search and filter. | ||
| + | ||
| [%hardbreaks] | ||
| Search: `extension.keyword:( “gz” or “css” or “deb”)` | ||
| Filter: `geo.src : CN` | ||
|
|
||
| [float] | ||
| ==== Create the drilldown | ||
|
|
||
|
|
||
| . In the dashboard menu bar, click *Edit*. | ||
|
|
||
| . In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*. | ||
|
|
||
| . Give the drilldown a name. | ||
|
|
||
| . Select *Host Overview* as the destination dashboard. | ||
|
|
||
| . Keep both filters enabled so that the drilldown carries over the global filters and date range. | ||
| + | ||
| [role="screenshot"] | ||
| image::images/drilldown_create.png[Create drilldown with entries for drilldown name and destination] | ||
|
|
||
| . Save the dashboard. | ||
| + | ||
| If you don’t save the drilldown, and then navigate away, the drilldown is lost. | ||
|
|
||
| . In *[Logs] Visitors by OS*, click the “win 8” slice of the pie, and then click the name of your drilldown. | ||
|
gchaps marked this conversation as resolved.
Outdated
gchaps marked this conversation as resolved.
Outdated
|
||
| + | ||
| You are navigated to your destination dashboard. Verify that the search query, filters, | ||
|
gchaps marked this conversation as resolved.
|
||
| and time range are carried over. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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.