-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[Docs] URL Drilldown #76529
Merged
Merged
[Docs] URL Drilldown #76529
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
f87c711
wip
Dosant 0a93ec7
optim images, update
Dosant 6377f3c
improve
Dosant 50dea48
update
Dosant 87cc4c5
improve
Dosant 238f037
wip
Dosant 731398e
wip
Dosant 67792b1
Merge branch 'master' of github.com:elastic/kibana into docs/url-dril…
Dosant b680348
update
Dosant 24b5ccb
update
Dosant 666342b
update
Dosant 5cced06
Merge branch 'master' of github.com:elastic/kibana into docs/url-dril…
Dosant 0603425
@streamich suggestions
Dosant 55b4b2d
wip
Dosant d4651d7
fix code blocks
Dosant 1235454
review
Dosant adc52a6
fix
Dosant 5523f40
improve helpers table
Dosant 64eba9a
Merge branch 'master' of github.com:elastic/kibana into docs/url-dril…
Dosant cc9f46d
Update docs/user/dashboard/dashboard-drilldown.asciidoc
Dosant 1a384af
Update docs/user/dashboard/url-drilldown.asciidoc
Dosant 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 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,76 @@ | ||
[[dashboard-drilldown]] | ||
=== Dashboard drilldown | ||
|
||
The dashboard drilldown allows you to navigate from one dashboard to another dashboard. | ||
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 single data center or server. | ||
|
||
This example shows a dashboard panel that contains a pie chart with a configured dashboard drilldown: | ||
|
||
[role="screenshot"] | ||
image::images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard] | ||
|
||
[float] | ||
[[drilldowns-example]] | ||
==== Try it: Create a dashboard drilldown | ||
|
||
Create the *Host Overview* drilldown shown above. | ||
|
||
*Set up the dashboards* | ||
|
||
. Add the <<gs-get-data-into-kibana, sample web logs>> data set. | ||
|
||
. Create a new dashboard, called `Host Overview`, and include these visualizations | ||
from the sample data set: | ||
+ | ||
[%hardbreaks] | ||
*[Logs] Heatmap* | ||
*[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 *[Logs] Web traffic* dashboard. | ||
|
||
. Set a search and filter. | ||
+ | ||
[%hardbreaks] | ||
Search: `extension.keyword:( “gz” or “css” or “deb”)` | ||
Filter: `geo.src : CN` | ||
|
||
|
||
*Create the drilldown* | ||
|
||
|
||
. In the dashboard menu bar, click *Edit*. | ||
|
||
. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*. | ||
|
||
. Pick *Go to dashboard* action. | ||
|
||
. 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. | ||
+ | ||
Your input should look similar to this: | ||
+ | ||
[role="screenshot"] | ||
image::images/drilldown_create.png[Create drilldown with entries for drilldown name and destination] | ||
|
||
. Click *Create drilldown.* | ||
|
||
. 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 select the name of your drilldown. | ||
+ | ||
[role="screenshot"] | ||
image::images/drilldown_on_panel.png[Drilldown on pie chart that navigates to another dashboard] | ||
+ | ||
You are navigated to your destination dashboard. Verify that the search query, filters, | ||
and time range are carried over. |
This file contains 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 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 |
---|---|---|
@@ -1,106 +1,51 @@ | ||
[float] | ||
[[drilldowns]] | ||
=== Use drilldowns for dashboard actions | ||
== 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, | ||
For example, using a drilldown, you can navigate from one dashboard to another, | ||
taking the current time range, filters, and other parameters with you, | ||
so the context remains the same. You can continue your analysis from a new perspective. | ||
|
||
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 single data center or server. | ||
|
||
[float] | ||
[[how-drilldowns-work]] | ||
==== How drilldowns work | ||
|
||
Drilldowns are user-configurable {kib} actions that are stored with the | ||
dashboard metadata. Drilldowns are specific to the dashboard panel | ||
for which you create them—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. Refer to the <<drilldowns-example, Try it section>> | ||
for instructions on how to create this drilldown. | ||
|
||
[role="screenshot"] | ||
image::images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard] | ||
|
||
Third-party developers can create drilldowns. | ||
Refer to https://github.com/elastic/kibana/tree/master/x-pack/examples/ui_actions_enhanced_examples[this example plugin] | ||
to learn how to code drilldowns. | ||
|
||
[float] | ||
[[create-manage-drilldowns]] | ||
==== Create and manage drilldowns | ||
|
||
Your dashboard must be in *Edit* mode to create a drilldown. | ||
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] | ||
Drilldowns are specific to the dashboard panel for which you create them—they are not shared across panels. A panel can have multiple drilldowns. | ||
|
||
[float] | ||
[[drilldowns-example]] | ||
==== Try it: Create a drilldown | ||
|
||
This example shows how to create the *Host Overview* drilldown shown earlier in this doc. | ||
[[actions]] | ||
=== Drilldown actions | ||
|
||
*Set up the dashboards* | ||
Drilldowns are user-configurable {kib} actions that are stored with the dashboard metadata. | ||
Kibana provides the following types of actions: | ||
|
||
. Add the <<gs-get-data-into-kibana, sample web logs>> data set. | ||
[cols="2"] | ||
|=== | ||
|
||
. Create a new dashboard, called `Host Overview`, and include these visualizations | ||
from the sample data set: | ||
+ | ||
[%hardbreaks] | ||
*[Logs] Heatmap* | ||
*[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. | ||
a| <<dashboard-drilldown, Dashboard drilldown>> | ||
|
||
. Open the *[Logs] Web traffic* dashboard. | ||
| Navigate to a dashboard. | ||
|
||
. Set a search and filter. | ||
+ | ||
[%hardbreaks] | ||
Search: `extension.keyword:( “gz” or “css” or “deb”)` | ||
Filter: `geo.src : CN` | ||
a| <<url-drilldown, URL drilldown>> | ||
|
||
*Create the drilldown* | ||
| Navigate to external or internal URL. | ||
|
||
. In the dashboard menu bar, click *Edit*. | ||
|=== | ||
|
||
. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*. | ||
[NOTE] | ||
============================================== | ||
Some action types are paid commercial features, while others are free. | ||
For a comparison of the Elastic subscription levels, | ||
see https://www.elastic.co/subscriptions[the subscription page]. | ||
============================================== | ||
|
||
. 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. | ||
+ | ||
Your input should look similar to this: | ||
+ | ||
[role="screenshot"] | ||
image::images/drilldown_create.png[Create drilldown with entries for drilldown name and destination] | ||
|
||
. Click *Create drilldown.* | ||
[float] | ||
[[code-drilldowns]] | ||
=== Code drilldowns | ||
Third-party developers can create drilldowns. | ||
Refer to {kib-repo}blob/{branch}/x-pack/examples/ui_actions_enhanced_examples[this example plugin] | ||
to learn how to code drilldowns. | ||
|
||
. Save the dashboard. | ||
+ | ||
If you don’t save the drilldown, and then navigate away, the drilldown is lost. | ||
include::dashboard-drilldown.asciidoc[] | ||
include::url-drilldown.asciidoc[] | ||
|
||
. In *[Logs] Visitors by OS*, click the `win 8` slice of the pie, and then select the name of your drilldown. | ||
+ | ||
[role="screenshot"] | ||
image::images/drilldown_on_panel.png[Drilldown on pie chart that navigates to another dashboard] | ||
+ | ||
You are navigated to your destination dashboard. Verify that the search query, filters, | ||
and time range are carried over. |
This file contains 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
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page duplicates content from other pages. I'd change it to focus on the actions. How to create the drilldown appears in the individual sections. Here is the structure that I recommend:
Use drilldowns for dashboard actions
Drilldowns, also known as custom actions, allow you to configure a workflow for analyzing and troubleshooting your data. For example, using a drilldown, you can navigate from one dashboard to another, taking the current time range, filters, and other parameters with you, so the context remains the same. You can continue your analysis from a new perspective.
Drilldowns are specific to the dashboard panel for which you create them—they are not shared across panels. A panel can have multiple drilldowns.
Drilldown actions
Drilldowns are user-configurable Kibana actions that are stored with the dashboard metadata.
Kibana provides the following types of actions:
Note: Some action types are paid commercial features, while others are free. For a comparison of the Elastic subscription levels, see the subscription page.
Code drilldowns
Third-party developers can create drilldowns. Refer to this example plugin to learn how to code drilldowns.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated as suggested. The only thing that gets left out in this case is general "ho to manage drilldown", but I guess this is fine.