[Docs] Remove unused page drilldowns.asciidoc (#106487)

This commit is contained in:
Wylie Conlon 2021-07-22 10:18:42 -04:00 committed by GitHub
parent a9743715d6
commit c54b4e54be
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 0 additions and 252 deletions

View file

@ -1,252 +0,0 @@
[role="xpack"]
[[drilldowns]]
== Create custom dashboard actions
Custom dashboard actions, or _drilldowns_, allow you to create workflows for analyzing and troubleshooting your data.
Drilldowns apply only to the panel that you created the drilldown from, and are not shared across all panels. Each panel can have multiple drilldowns.
Third-party developers can create drilldowns. To learn how to code drilldowns, refer to {kib-repo}blob/{branch}/x-pack/examples/ui_actions_enhanced_examples[this example plugin].
[float]
[[supported-drilldowns]]
=== Supported drilldowns
{kib} supports dashboard and URL drilldowns.
[float]
[[dashboard-drilldowns]]
==== Dashboard drilldowns
Dashboard drilldowns enable you to open a dashboard from another dashboard,
taking the time range, filters, and other parameters with you
so the context remains the same. Dashboard drilldowns help you to continue your analysis from a new perspective.
For example, if you have a dashboard that shows the overall status of multiple data center,
you can create a drilldown that navigates from the overall status dashboard to a dashboard
that shows a single data center or server.
[role="screenshot"]
image:images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard]
[float]
[[url-drilldowns]]
==== URL drilldowns
URL drilldowns enable you to navigate from a dashboard to internal or external URLs.
Destination URLs can be dynamic, depending on the dashboard context or user interaction with a panel.
For example, if you have a dashboard that shows data from a Github repository, you can create a URL drilldown
that opens Github from the dashboard panel.
[role="screenshot"]
image:images/url_drilldown_go_to_github.gif[Drilldown on pie chart that navigates to Github]
Some panels support multiple interactions, also known as triggers.
The <<url-template-variables,variables>> you use to create a <<url_templating-language, URL template>> depends on the trigger you choose. URL drilldowns support these types of triggers:
* *Single click* &mdash; A single data point in the panel.
* *Range selection* &mdash; A range of values in a panel.
For example, *Single click* has `{{event.value}}` and *Range selection* has `{{event.from}}` and `{{event.to}}`.
[float]
[[dashboard-drilldown-supported-panels]]
=== Supported panel types
The following panel types support drilldowns.
[options="header"]
|===
| Panel | Dashboard drilldown | URL drilldown
| Lens
^| X
^| X
| Area
^| X
^| X
| Controls
^|
^|
| Data Table
^| X
^| X
| Gauge
^|
^|
| Goal
^|
^|
| Heat map
^| X
^| X
| Horizontal Bar
^| X
^| X
| Line
^| X
^| X
| Maps
^| X
^| X
| Markdown
^|
^|
| Metric
^|
^|
| Pie
^| X
^| X
| TSVB (only for time series visualizations)
^| X
^| X
| Tag Cloud
^| X
^| X
| Timelion
^| X
^|
| Vega
^| X
^|
| Vertical Bar
^| X
^| X
|===
[float]
[[drilldowns-example]]
=== Create a dashboard drilldown
To create dashboard drilldowns, you create or locate the dashboards you want to connect, then configure the drilldown that allows you to easily open one dashboard from the other dashboard.
[float]
==== Create the dashboard
. Add the *Sample web logs* data.
. Create a new dashboard, then add the following panels from the *Visualize Library*:
* *[Logs] Heatmap*
* *[Logs] Host, Visits, and Bytes Table*
* *[Logs] Total Requests and Bytes*
* *[Logs] Visitors by OS*
+
If you dont see the data on a panel, change the <<set-time-filter,time filter>>.
. Save the dashboard. In the *Title* field, enter `Host Overview`.
. Open the *[Logs] Web traffic* dashboard.
. Set a search and filter.
+
[%hardbreaks]
Search: `extension.keyword: ("gz" or "css" or "deb")`
Filter: `geo.src: CN`
[float]
==== Create the drilldown
. In the toolbar, click *Edit*.
. Open the *[Logs] Visitors by OS* panel menu, then select *Create drilldown*.
. Click *Go to dashboard*.
.. Give the drilldown a name. For example, `My Drilldown`.
.. From the *Choose a destination dashboard* dropdown, select *Host Overview*.
.. To use the geo.src filter, KQL query, and time filter, select *Use filters and query from origin dashboard* and *Use date range from origin dashboard*.
.. Click *Create drilldown*.
. Save the dashboard.
. In the *[Logs] Visitors by OS* panel, click *win 8*, then select `My Drilldown`.
+
[role="screenshot"]
image::images/drilldown_on_panel.png[Drilldown on pie chart that navigates to another dashboard]
. On the *Host Overview* dashboard, verify that the geo.src filter, KQL query, and time filter are applied.
[float]
[[create-a-url-drilldown]]
=== Create a URL drilldown
To create URL drilldowns, you add <<variables,variables>> to a URL template, which configures the behavior of the drilldown.
. Add the *Sample web logs* data.
. Open the *[Logs] Web traffic* dashboard.
. In the toolbar, click *Edit*.
. Open the *[Logs] Visitors by OS* panel menu, then select *Create drilldown*.
. Click *Go to URL*.
.. Give the drilldown a name. For example, `Show on Github`.
.. For the *Trigger*, select *Single click*.
.. To navigate to the {kib} repository Github issues, enter the following in the *Enter URL* field:
+
[source, bash]
----
https://github.com/elastic/kibana/issues?q=is:issue+is:open+{{event.value}}
----
+
`{{event.value}}` is substituted with a value associated with a selected pie slice.
.. Click *Create drilldown*.
. Save the dashboard.
. On the *[Logs] Visitors by OS* panel, click any chart slice, then select *Show on Github*.
+
[role="screenshot"]
image:images/url_drilldown_popup.png[URL drilldown popup]
. In the list of {kib} repository issues, verify that the slice value appears.
+
[role="screenshot"]
image:images/url_drilldown_github.png[Github]
[float]
[[manage-drilldowns]]
=== Manage drilldowns
Make changes to your drilldowns, make a copy of your drilldowns for another panel, and delete drilldowns.
. Open the panel menu that includes the drilldown, then click *Manage drilldowns*.
. On the *Manage* tab, use the following options:
* To change drilldowns, click *Edit* next to the drilldown you want to change, make your changes, then click *Save*.
* To make a copy, click *Copy* next to the drilldown you want to change, enter the drilldown name, then click *Create drilldown*.
* To delete a drilldown, select the drilldown you want to delete, then click *Delete*.
include::url-drilldown.asciidoc[]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 554 KiB