Skip to content

Commit 7292d48

Browse files
kibanamachinekibanamachine
authored
Merge branch 'master' into fleet-add-import-type-lint-rule
2 parents 705eebb + 0c3514c commit 7292d48

52 files changed

Lines changed: 1082 additions & 349 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/user/dashboard/dashboard.asciidoc‎

Lines changed: 183 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,14 @@ Dashboards support many types of panels, and provide several editors that you ca
3434
| <<enhance-dashboards,Tools>>
3535
| Add context to your panels with <<add-text,text>>, or add dynamic filters with <<add-controls,*Controls*>>.
3636

37-
| <<save-your-search,Saved search table>>
38-
| Display a previously saved search table from <<discover, *Discover*>>. The table results are not aggregated.
37+
| <<save-your-search,Saved search from Discover>>
38+
| Display a saved search table from <<discover, *Discover*>>. The table results are not aggregated.
3939

40-
| <<xpack-ml-anomalies,Machine Learning>>
41-
| Display a previously saved visualization of <<xpack-ml, machine learning>> anomaly detection data.
40+
| <<logs-app,Log stream>>
41+
| Display a table of live streaming logs.
42+
43+
| <<xpack-ml-anomalies,ML Anomaly Swim Lane>>
44+
| Display the results from machine learning anomaly detection jobs.
4245

4346
|===
4447

@@ -78,102 +81,194 @@ Begin with an empty dashboard, or open an existing dashboard.
7881

7982
* To open an existing dashboard, click the dashboard *Title* you want to open.
8083

84+
[float]
85+
[[add-panels]]
86+
=== Add panels
87+
88+
To add panels to the dashboard, you can use one of the editors to create a new panel,
89+
add an existing panel from the *Visualize Library*, add a table of live streaming logs, or the add the results from a machine learning anomaly detection job.
90+
8191
[float]
8292
[[create-panels-with-lens]]
83-
=== Create panels
93+
==== Create panels
94+
95+
To create panels, use one of the editors, then add the panel to the dashboard.
96+
97+
. On the dashboard, click *Create panel*.
98+
99+
. On the *New visualization* window, click the editor you want to use. *Lens* is recommended for most users.
100+
101+
. To create the panel, configure the editor options.
102+
103+
. To add the panel to the dashboard, choose one of the following options:
104+
105+
* To add the panel to the dashboard without saving to the *Visualize Library*, click *Save and return*.
106+
+
107+
To add a title to the panel, click *No Title*, enter the *Panel title*, then click *Save*.
108+
109+
* To save the panel to the *Visualize Library*, click *Save to Library*, configure the options, then click *Save and return*.
110+
+
111+
When panels are saved in the *Visualize Library*, image:dashboard/images/visualize-library-icon.png[Visualize Library icon] appears in the header.
112+
113+
[float]
114+
[[add-panels-from-the-library]]
115+
==== Add panels from the library
116+
117+
Add panels that you've already created from the *Visualize Library*.
118+
119+
. On the dashboard, click *Add from library*.
120+
121+
. On the *Add from library* flyout, click the panels you want to add to the dashboard.
122+
123+
. To close the flyout, click *X*.
124+
+
125+
When a panel contains a stored query, both queries are applied.
84126

85-
Choose the type of panel you want to create, then save the panel to the dashboard.
127+
. To make changes to the panel, open the panel menu, then select the following options:
86128

87-
. From the dashboard, choose one of the following options:
129+
* *Edit visualization* &mdash; Opens an editor so that you can reconfigure the panel.
130+
+
131+
To make changes to the panel without affecting the original version, open the panel menu, then click *More > Unlink from library*.
88132

89-
* To create a panel, click *Create panel*, then click the panel type on the *New visualization* window. *Lens* is recommended for most users.
133+
* *Edit panel title* &mdash; Opens the *Customize panel* window to change the *Panel title* and specify whether you want to display the panel title.
90134

91-
* To add a saved panel, click *Add from library*, then select the panel you want to add. When a panel contains a stored query, both queries are applied.
135+
[float]
136+
[[add-a-table-of-live-streaming-logs]]
137+
==== Add a logs panel
92138

93-
. To save the panel, click *Save* in the toolbar, then configure the *Save visualization* options.
139+
Add a panel that displays a table of live streaming logs.
94140

95-
.. Enter the *Title* and optional *Description*.
141+
. On the dashboard, click *Add from library*.
96142

97-
.. From the *Tags* drop down, select any applicable tags.
143+
. On the *Add from library* flyout, click *Create new*, then select *Log stream*.
144+
145+
[float]
146+
[[add-machine-learning-results]]
147+
==== Add machine learning results
98148

99-
.. Select *Add to Dashboard after saving*.
149+
Add a panel that displays the results from machine learning anomaly detection jobs.
100150

101-
.. Click *Save and return*.
151+
. On the dashboard, click *Add from library*.
102152

103-
TIP: To access your saved panels, open the main menu, then click *Visualize Library*.
153+
. On the *Add from library* flyout, click *Create new*, then select *ML Anomaly Swim Lane*.
104154

105155
[float]
106156
[[arrange-panels]]
107157
[[moving-containers]]
108158
[[resizing-containers]]
109-
=== Arrange panels
159+
=== Arrange the panels
110160

111-
To compare the data in the panels, arrange the panels on the dashboard, or remove the panel from the dashboard.
161+
To compare the data in the panels, reorganize or remove the panels on the dashboard.
112162

113163
. From the toolbar, click *Edit*, then use the following options:
114164

115165
* To move, click and hold the panel header, then drag to the new location.
116166

117167
* To resize, click the resize control, then drag to the new dimensions.
118168

119-
* To delete, open the panel menu, then select *Delete from dashboard*.
169+
* To maximize the panel to fullscreen, open the panel menu, then click *More > Maximize panel*.
170+
171+
* To delete, open the panel menu, then click *More > Delete from dashboard*.
120172

121173
. To save your changes, click *Save* in the toolbar.
122174

175+
[float]
176+
[[apply-design-options]]
177+
=== Apply design options
178+
179+
Apply a set of design options to the entire dashboard.
180+
181+
. From the toolbar, click *Edit > Options*.
182+
183+
. Select the following options:
184+
185+
* *Use margins between panels* &mdash; Specifies a margin of space between each panel.
186+
187+
* *Show panel titles* &mdash; Specifies the appearance of titles in the header of each panel.
188+
189+
* *Sync color pallettes across panels* &mdash; Specifies whether the color pallette is applied to all panels.
190+
123191
[float]
124192
[[search-or-filter-your-data]]
125193
=== Search or filter your data
126194

127-
{kib} provides you with several ways to search your data and apply {es} filters. You can combine the filters with any panel-specific
128-
filters to display the data want to you see.
195+
{kib} provides you with several ways to search your data and apply {es} filters. You can combine the filters with any panel
196+
filter to display the data want to you see.
129197

130-
[role="screenshot"]
131-
image::dashboard/images/dashboard-filters.png[Labeled interface with semi-structured search, time filter, and additional filters]
198+
[float]
199+
[[semi-structured-search]]
200+
==== Semi-structured search
201+
202+
Combine free text search with field-based search using the <<kuery-query,{kib} Query Language>>.
203+
Type a search term to match across all fields, or begin typing a field name to
204+
get prompted with field names and operators you can use to build a structured query.
205+
206+
For example, in the sample web logs data, the following query displays data only for the US:
207+
208+
. Enter `g`, then select *geo.source*.
132209

133-
Semi-structured search::
134-
Combine free text search with field-based search using the <<kuery-query,{kib} Query Language>>.
135-
Type a search term to match across all fields, or begin typing a field name to
136-
get prompted with field names and operators you can use to build a structured query.
137-
For example, in the sample web logs data, this query displays data only for the US:
210+
. Select *equals some value* and *US*, then click *Update*.
138211

139-
. Enter `g`, then select *geo.source*.
140-
. Select *equals some value* and *US*, then click *Update*.
141-
. For a more complex search, try:
212+
. For a more complex search, try:
142213

143214
[source,text]
144215
-------------------
145216
geo.src : "US" and url.keyword : "https://www.elastic.co/downloads/beats/metricbeat"
146217
-------------------
147218

148-
Time filter::
149-
Dashboards have a global time filter that restricts the data that displays, but individual panels can
150-
override the global time filter.
219+
[float]
220+
[[time-filter]]
221+
==== Time filter
222+
223+
The <<set-time-filter,time filter>> restrict the data that appears on the dashboard, but you can override the time filter with panel filters.
151224

152-
. To update the time filter, add a panel that displays time on the x-axis.
225+
. To update the time filter, add a panel that displays time-based data along the x-axis.
153226

154-
. Open the panel menu, then select *More > Customize time range*.
227+
. Open the panel menu, then select *More > Customize time range*.
155228

156-
. On the *Customize panel time range* window, specify the new time range, then click *Add to panel*.
157-
229+
. On the *Customize panel time range* window, specify the time range, then click *Add to panel*.
230+
+
158231
[role="screenshot"]
159232
image:images/time_range_per_panel.gif[Time range per dashboard panel]
160233

161-
Additional filters with AND::
162-
Add filters to a dashboard, or pin filters to multiple places in {kib}. To add filters, using a basic editor or an advanced JSON editor for the {es} {ref}/query-dsl.html[query DSL].
163-
When you use more than one index pattern on a dashboard, the filter editor allows you to filter only one dashboard.
164-
To dynamically add filters, click a series on a dashboard. For example, to filter the dashboard to display only ios data:
165-
. Click *Add filter*.
166-
. Set *Field* to *machine.os*, *Operator* to *is*, and *Value* to *ios*.
167-
. *Save* the filter.
168-
. To remove the filter, click *x*.
234+
[float]
235+
[[additional-filters-with-and]]
236+
==== Additional filters with AND
237+
238+
Add filters to a dashboard, or pin filters to multiple places in {kib}. To add filters, you can use the *Edit Filter* options, or the advanced JSON editor for the {es} {ref}/query-dsl.html[Query DSL].
239+
When there is one or more index patterns on the dashboard, you can select the index pattern that contains the fields you want to create the filter.
240+
241+
For example, to filter the dashboard to display only ios data from *kibana_sample_data_logs*:
242+
243+
. Click *Add filter*.
244+
245+
. From the *Index Pattern* dropdown, select *kibana_sample_data_logs*.
246+
247+
. Set *Field* to *machine.os*, *Operator* to *is*, and *Value* to *ios*.
248+
249+
. *Save* the filter.
250+
+
251+
To remove the filter, click *x*.
252+
253+
[float]
254+
[[add-dynamic-filters]]
255+
==== Add dynamic filters
256+
257+
When you see data in a panel that you want to use as a filter, you can dynamically create the filter. To dynamically add filters, click the data in a panel.
258+
259+
. Click the data in the panel.
260+
261+
. Select filters you want to apply to all of the dashboard panels, then click *Apply*.
262+
+
263+
To remove the filters, click *x*.
169264

170265
[float]
171266
[[clone-panels]]
172267
=== Clone panels
173268

174269
To duplicate a panel and the configured functionality, clone the panel. Cloned panels continue to replicate all of the functionality from the original panel,
175270
including renaming, editing, and cloning. When you clone a panel, the clone appears beside the original panel, and moves other panels to provide a space on the
176-
dashboard.
271+
dashboard.
177272

178273
. From the toolbar, click *Edit*.
179274

@@ -182,52 +277,75 @@ dashboard.
182277
[role="screenshot"]
183278
image:images/clone_panel.gif[clone panel]
184279
+
185-
To access the cloned panel, open the main menu, then click *Visualize Library*.
280+
When cloned panels are saved in the *Visualize Library*, image:dashboard/images/visualize-library-icon.png[Visualize Library icon] appears in the header.
281+
282+
[float]
283+
[[copy-to-dashboard]]
284+
=== Copy panels
285+
286+
To add a panel to another dashboard, copy the panel.
287+
288+
. Open the panel menu, then select *More > Copy to dashboard*.
289+
290+
. On the *Copy to dashboard* window, select the dashboard, then click *Copy and go to dashboard*.
186291

187292
[float]
188293
[[explore-the-underlying-data]]
189294
=== Explore the underlying documents
190295

191-
Dashboard panels have a shortcut to view the underlying documents in *Discover*. Open the panel menu,
192-
then click *Explore underlying data*. *Discover* will be opened with the same time range and filters as the panel.
296+
View the underlying documents in a panel, or in a data series.
297+
298+
TIP: *Explore underlying data* is supported only for visualization panels with a single index pattern.
193299

300+
To view the underlying documents in the panel:
301+
302+
. Open the panel menu.
303+
304+
. Click *Explore underlying data*.
305+
+
306+
*Discover* opens with the same time range and filters as the panel.
307+
+
194308
[role="screenshot"]
195309
image::images/explore_data_context_menu.png[Explore underlying data from panel context menu]
196310

197-
A second shortcut is disabled by default, and creates a new interaction when clicking on a chart.
198-
This shortcut is similar to a <<drilldowns, drilldown>>, but can show you data for only one series.
199-
To enable the chart interactivity shortcut, add the following to kibana.yml:
311+
To view the underlying documents in a data series:
200312

313+
. In kibana.yml, add the following:
314+
+
201315
["source","yml"]
202316
-----------
203317
xpack.discoverEnhanced.actions.exploreDataInChart.enabled: true
204318
-----------
205319

320+
. Open the dashboard, then click on the data series you want to view.
321+
+
206322
[role="screenshot"]
207323
image::images/explore_data_in_chart.png[Explore underlying data from chart]
208324

209-
TIP: *Explore underlying data* is available only for visualization panels with a single index pattern.
210-
211325
[float]
212326
[[download-csv]]
213-
=== Download panel data as CSV
327+
=== Download the panel data
214328

215329
Download panel data in a CSV file. You can download most panels in a CSV file, but there is a shortcut available
216330
for *Lens* panels.
217331

218332
[role="xpack"]
219-
Lens::
333+
To download *Lens* panel data in a CSV file:
334+
220335
Open the *Lens* panel menu, then select *More > Download as CSV*.
221-
+
336+
222337
[role="screenshot"]
223338
image::images/download_csv_context_menu.png[Download as CSV from panel context menu]
224339

225-
All panels::
226-
. Open the panel menu, then select *Inspect*.
340+
To download all other panel data in a CSV file:
341+
342+
. Open the panel menu, then select *Inspect*.
227343

228-
. Click *Download CSV*, then select the CSV type from the dropdown. The *Formatted CSV* contains
229-
human-readable dates and numbers, while the *Unformatted* option is for computer use.
344+
. Click *Download CSV*, then select the CSV type from the dropdown:
345+
* *Formatted CSV* &mdash; Contains human-readable dates and numbers.
230346

347+
* *Unformatted* &mdash; Best used for computer use.
348+
+
231349
[role="screenshot"]
232350
image:images/Dashboard_inspect.png[Inspect in dashboard]
233351

@@ -237,15 +355,13 @@ image:images/Dashboard_inspect.png[Inspect in dashboard]
237355

238356
When you're finished making changes, save the dashboard.
239357

240-
. From the toolbar, click *Save*.
241-
242-
. Enter the dashboard *Title* and an optional *Description*.
358+
From the toolbar, choose one of the following options:
243359

244-
. From the *Tags* dropdown, select the tags you want to apply.
360+
* *Save as* &mdash; Opens the *Save dashboard* window, which allows you to specify the title and dashboard options.
245361

246-
. To save the time range, select *Store time with dashboard*.
362+
* *Save* &mdash; Allows you to save the changes you've made to an existing dashboard.
247363

248-
. Click *Save*.
364+
* *Switch to view mode* &mdash; Allows you to exit *Edit* mode without saving your changes, or you can discard the changes you've made. All dashboards with unsaved changes display *Unsaved changes* in the toolbar.
249365

250366
[float]
251367
[[share-the-dashboard]]

‎docs/user/dashboard/images/clone_panel.gif‎

-518 KB
Loading

‎docs/user/dashboard/images/visualize-library-icon.png‎

1.75 KB
Loading

0 commit comments

Comments
 (0)