Skip to content

Commit 06c7e38

Browse files
committed
Merge branch 'master' into reporting/searchsource-exporttype
2 parents d786783 + 067543b commit 06c7e38

File tree

346 files changed

+6405
-2585
lines changed

Some content is hidden

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

346 files changed

+6405
-2585
lines changed

docs/canvas/canvas-edit-workpads.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ each element instead of updating them manually.
2222

2323
For example, to change the index pattern for a set of charts:
2424

25-
Specify the variable options.
26-
25+
. Specify the variable options.
26+
+
2727
[role="screenshot"]
2828
image::images/specify_variable_syntax.png[Image describing how to specify the variable syntax]
29-
30-
Copy the variable, then apply it to each element you want to update in the *Expression editor*.
31-
29+
+
30+
. Copy the variable, then apply it to each element you want to update in the *Expression editor*.
31+
+
3232
[role="screenshot"]
3333
image::images/copy_variable_syntax.png[Image demonstrating expression editor]
3434

docs/canvas/canvas-present-workpad.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ image::images/canvas-autoplay-interval.png[Element autoplay interval]
2020
[role="screenshot"]
2121
image::images/canvas-fullscreen.png[Image showing how to enter fullscreen mode from view dropdown]
2222

23-
. When you are ready to exit fullscreen mode, press the Esc (Escape) key.
23+
. When you are ready to exit fullscreen mode, press Esc.
2424

2525
[float]
2626
[[zoom-in-out]]
@@ -48,4 +48,4 @@ Change how often the data refreshes on your workpad.
4848
[role="screenshot"]
4949
image::images/canvas-refresh-interval.png[Element data refresh interval]
5050
+
51-
To manually refresh the data, click image:canvas/images/canvas-refresh-data.png[].
51+
To manually refresh the data, click image:canvas/images/canvas-refresh-data.png[Canvas refresh data button].

docs/canvas/canvas-share-workpad.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Want to export multiple workpads? Go to the *Canvas* home page, select the workp
2323
[[add-workpad-website]]
2424
=== Share the workpad on a website
2525

26-
beta[] Canvas allows you to create _shareables_, which are workpads that you download and securely share on any website.
26+
beta[] *Canvas* allows you to create _shareables_, which are workpads that you download and securely share on any website.
2727
To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar.
2828

2929
. Click *Share > Share on a website*.
@@ -32,7 +32,7 @@ To customize the behavior of the workpad on your website, you can choose to auto
3232

3333
. To customize the workpad behavior to autoplay the pages or hide the toolbar, use the inline parameters.
3434
+
35-
To make sure that your data remains secure, the data in the JSON file is not connected to {kib}. Canvas does not display elements that manipulate the data on the workpad.
35+
To make sure that your data remains secure, the data in the JSON file is not connected to {kib}. *Canvas* does not display elements that manipulate the data on the workpad.
3636
+
3737
[role="screenshot"]
3838
image::canvas/images/canvas-embed_workpad.gif[Image showing how to share the workpad on a website]

docs/canvas/canvas-tutorial.asciidoc

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,16 @@
22
[[canvas-tutorial]]
33
== Tutorial: Create a workpad for monitoring sales
44

5-
To get up and running with Canvas, add the Sample eCommerce orders data, then use the data to create a workpad for monitoring sales at an eCommerce store.
5+
To familiarize yourself with *Canvas*, add the Sample eCommerce orders data, then use the data to create a workpad for monitoring sales at an eCommerce store.
66

77
[float]
8-
=== Before you begin
8+
=== Open and set up Canvas
99

10-
For this tutorial, you'll need to add the <<add-sample-data, Sample eCommerce orders data>>.
10+
To create a workpad of the eCommerce store data, add the data set, then create the workpad.
1111

12-
[float]
13-
=== Create your workpad
12+
. On the {kib} *Home* page, click *Try our sample data*.
1413

15-
Your first step to working with Canvas is to create a workpad.
14+
. From *Sample eCommerce orders data*, click *Add data*.
1615

1716
. Open the main menu, then click *Canvas*.
1817

@@ -59,7 +58,7 @@ The query selects the total price field and sets it to the sum_total_price field
5958

6059
.. Change the *Label* to `Total sales`.
6160

62-
. The error is gone, but the element could use some formatting. To format the number, use the Canvas expression language.
61+
. The error is gone, but the element could use some formatting. To format the number, use the *Canvas* expression language.
6362

6463
.. Click *Expression editor*.
6564
+
@@ -118,12 +117,12 @@ Your workpad is complete!
118117

119118
[float]
120119
=== What's next?
121-
Now that you know the Canvas basics, you're ready to explore on your own.
120+
Now that you know the basics, you're ready to explore on your own.
122121

123122
Here are some things to try:
124123

125124
* Play with the {kibana-ref}/add-sample-data.html[sample Canvas workpads].
126125

127126
* Build presentations of your own data with <<create-workpads,workpads>>.
128127

129-
* Deep dive into the {kibana-ref}/canvas-function-reference.html[expression language and functions] that drive Canvas.
128+
* Deep dive into the {kibana-ref}/canvas-function-reference.html[expression language and functions] that drive *Canvas*.
103 KB
Loading

docs/glossary.asciidoc

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[[glossary]]
33
= Glossary
44

5-
<<a_glos>> | <<b_glos>> | <<c_glos>> | <<d_glos>> | <<e_glos>> | <<f_glos>> | <<g_glos>> | H | I | J | <<k_glos>> | <<l_glos>> | <<m_glos>> | N | O | <<p_glos>> | <<q_glos>> | R | <<s_glos>> | <<t_glos>> | <<u_glos>> | V | <<w_glos>> | X | Y | Z
5+
<<a_glos>> | <<b_glos>> | <<c_glos>> | <<d_glos>> | <<e_glos>> | <<f_glos>> | <<g_glos>> | H | I | J | <<k_glos>> | <<l_glos>> | <<m_glos>> | N | O | <<p_glos>> | <<q_glos>> | <<r_glos>> | <<s_glos>> | <<t_glos>> | <<u_glos>> | V | <<w_glos>> | X | Y | Z
66

77
[float]
88
[[a_glos]]
@@ -13,10 +13,10 @@
1313
+
1414
--
1515
// tag::action-def[]
16-
The alert-specific response that occurs when an alert fires.
17-
An alert can have multiple actions.
16+
The rule-specific response that occurs when an alerting rule fires.
17+
A rule can have multiple actions.
1818
See
19-
{kibana-ref}/action-types.html[Action and connector types].
19+
{kibana-ref}/action-types.html[Connectors and actions].
2020
// end::action-def[]
2121
--
2222

@@ -28,20 +28,6 @@ Part of {kib} Stack Management.
2828
See {kibana-ref}/advanced-options.html[Advanced Settings].
2929
// end::advanced-settings-def[]
3030

31-
[[glossary-alert]] alert ::
32-
// tag::alert-def[]
33-
A set of <<glossary-condition,conditions>>, schedules, and <<glossary-action,actions>>
34-
that enable notifications.
35-
See <<glossary-alerts-and-actions,Alerts and Actions>>.
36-
// end::alert-def[]
37-
38-
[[glossary-alerts-and-actions]] Alerts and Actions ::
39-
// tag::alerts-and-actions-def[]
40-
A comprehensive view of all your alerts. Enables you to access and
41-
manage alerts for all {kib} apps from one place.
42-
See {kibana-ref}/alerting-getting-started.html[Alerts and Actions].
43-
// end::alerts-and-actions-def[]
44-
4531
[[glossary-annotation]] annotation ::
4632
// tag::annotation-def[]
4733
A way to augment a data display with descriptive domain knowledge.
@@ -113,13 +99,13 @@ The cluster location is the weighted centroid for all documents in the grid cell
11399

114100
[[glossary-condition]] condition ::
115101
// tag::condition-def[]
116-
Specifies the circumstances that must be met to trigger an alert.
102+
Specifies the circumstances that must be met to trigger an alerting rule.
117103
// end::condition-def[]
118104

119105
[[glossary-connector]] connector ::
120106
// tag::connector-def[]
121107
A configuration that enables integration with an external system (the destination for an action).
122-
See {kibana-ref}/action-types.html[Action and connector types].
108+
See {kibana-ref}/action-types.html[Connectors and actions].
123109
// end::connector-def[]
124110

125111
[[glossary-console]] Console ::
@@ -335,6 +321,24 @@ A tool that enables you to inspect and analyze search queries to diagnose and de
335321
See {kibana-ref}/xpack-profiler.html[Query Profiler].
336322
// end::query-profiler-def[]
337323

324+
[float]
325+
[[r_glos]]
326+
== R
327+
328+
[[glossary-rule]] rule ::
329+
// tag::rule-def[]
330+
A set of <<glossary-condition,conditions>>, schedules, and <<glossary-action,actions>>
331+
that enable notifications.
332+
See <<glossary-rules-and-connectors,Rules and Connectors>>.
333+
// end::rule-def[]
334+
335+
[[glossary-rules-and-connectors]] Rules and Connectors ::
336+
// tag::rules-and-connectors-def[]
337+
A comprehensive view of all your alerting rules. Enables you to access and
338+
manage rules for all {kib} apps from one place.
339+
See {kibana-ref}/alerting-getting-started.html[Rules and Connectors].
340+
// end::rules-and-connectors-def[]
341+
338342
[float]
339343
[[s_glos]]
340344
== S

docs/user/canvas.asciidoc

Lines changed: 58 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,52 @@
55
[partintro]
66
--
77

8-
Canvas is a data visualization and presentation tool that sits within {kib}. With Canvas, you can pull live data directly from {es}, and combine the data with colors, images, text, and your imagination to create dynamic, multi-page, pixel-perfect displays. If you are a little bit creative, a little bit technical, and a whole lot curious, then Canvas is for you.
8+
*Canvas* is a data visualization and presentation tool that allows you to pull live data from {es},
9+
then combine the data with colors, images, text, and your imagination to create dynamic, multi-page, pixel-perfect displays.
10+
If you are a little bit creative, a little bit technical, and a whole lot curious, then *Canvas* is for you.
911

10-
With Canvas, you can:
12+
With *Canvas*, you can:
1113

1214
* Create and personalize your work space with backgrounds, borders, colors, fonts, and more.
1315

1416
* Customize your workpad with your own visualizations, such as images and text.
1517

16-
* Pull your data directly from Elasticsearch, then show it off with charts, graphs, progress monitors, and more.
18+
* Pull your data directly from {es}, then show it off with charts, graphs, progress monitors, and more.
1719

1820
* Focus the data you want to display with filters.
1921

20-
To begin, open the main menu, then click *Canvas*.
21-
22-
[role="screenshot"]
23-
image::images/canvas-gs-example.png[Getting started example]
24-
25-
For a quick overview of Canvas, watch link:https://www.youtube.com/watch?v=ZqvF_5-1xjQ[Stand out with Canvas].
22+
++++
23+
<iframe width="560" height="315"
24+
src="https://www.youtube.com/embed/ZqvF_5-1xjQ"
25+
frameborder="0"
26+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
27+
allowfullscreen></iframe>
28+
</br>
29+
++++
2630

2731
[float]
2832
[[create-workpads]]
2933
== Create workpads
3034

31-
A _workpad_ provides you with a space where you can build presentations of your live data. With Canvas,
32-
you can create a workpad from scratch, start with a preconfigured workpad, import an existing workpad, or use a sample data workpad.
35+
A _workpad_ provides you with a space where you can build presentations of your live data. You can create a workpad from scratch, start with a preconfigured workpad,
36+
import an existing workpad, or use a sample data workpad.
37+
38+
[float]
39+
[[canvas-minimum-requirements]]
40+
=== Minimum requirements
41+
42+
To create workpads, you must meet the minimum requirements.
43+
44+
* If you need to set up {kib}, use https://www.elastic.co/cloud/elasticsearch-service/signup?baymax=docs-body&elektra=docs[our free trial].
45+
46+
* Make sure you have {ref}/getting-started-index.html[data indexed into {es}] and an <<index-patterns,index pattern>>.
47+
48+
* Have an understanding of {ref}/documents-indices.html[{es} documents and indices].
49+
50+
* Make sure you have sufficient privileges to create and save workpads. When the read-only indicator appears, you have insufficient privileges,
51+
and the options to create and save workpads are unavailable. For more information, refer to <<xpack-security-authorization,Granting access to {kib}>>.
52+
53+
To open *Canvas*, open the main menu, then click *Canvas*.
3354

3455
[float]
3556
[[start-with-a-blank-workpad]]
@@ -54,7 +75,7 @@ image::images/canvas-background-color-picker.png[Canvas color picker]
5475
[[create-workpads-from-templates]]
5576
=== Create workpads from templates
5677

57-
If you're unsure about where to start, you can use one of the preconfigured templates that come with Canvas.
78+
If you're unsure about where to start, you can use one of the preconfigured templates that come with *Canvas*.
5879

5980
. On the *Canvas workpads* page, select *Templates*.
6081

@@ -90,55 +111,60 @@ Create a story about your data by adding elements to your workpad that include i
90111
[[create-elements]]
91112
=== Create elements
92113

93-
Choose the type of element you want to use, then use the preconfigured demo data to familiarize yourself with the element. When you're ready, connect the element to your own data. By default, most of the elements you create use
94-
demo data until you change the data source. The demo data includes a small data set that you can use to experiment with your element.
95-
96-
To begin, click *Add element*, then select the element you want to use.
114+
Choose the type of element you want to use, then use the preconfigured demo data to familiarize yourself with the element. When you're ready, connect the element to your own data.
115+
By default, most of the elements you create use the demo data until you change the data source. The demo data includes a small data set that you can use to experiment with your element.
97116

117+
. Click *Add element*, then select the element you want to use.
118+
+
98119
[role="screenshot"]
99120
image::images/canvas-element-select.gif[Canvas elements]
100121

101-
When you're ready to connect the element to your data, select *Data*, then select one of the following data sources:
122+
. To connect the element to your data, select *Data*, then select one of the following data sources:
102123

103124
* *{es} SQL* &mdash; Access your data in {es} using {ref}/sql-spec.html[SQL syntax].
104125

105-
* *{es} documents* &mdash; Access your data in {es} without using aggregations. To use, select an index and fields, and optionally enter a query using the <<lucene-query,Lucene Query Syntax>>. Use the *{es} documents* data source when you have low volume datasets, to view raw documents, or to plot exact, non-aggregated values on a chart.
106-
107-
* *Timelion* &mdash; Access your time series data using <<create-panels-with-timelion,Timelion>> queries. To use Timelion queries, you can enter a query using the <<lucene-query,Lucene Query Syntax>>.
126+
* *{es} documents* &mdash; Access your data in {es} without using aggregations. To use, select an index and fields, and optionally enter a query using the <<lucene-query,Lucene Query Syntax>>.
127+
Use the *{es} documents* data source when you have low volume datasets, to view raw documents, or to plot exact, non-aggregated values on a chart.
108128

129+
* *Timelion* &mdash; Access your time series data using <<create-panels-with-timelion,*Timelion*>> queries. To use *Timelion* queries, you can enter a query using the <<lucene-query,Lucene Query Syntax>>.
130+
+
109131
Each element can display a different data source, and pages and workpads often contain multiple data sources.
110132

111-
When you're ready to save your element, select the element, then click *Edit > Save as new element*.
133+
. To save, use the following options:
112134

135+
* To save a single element, select the element, then click *Edit > Save as new element*.
136+
+
113137
[role="screenshot"]
114138
image::images/canvas_save_element.png[]
115139

116-
To save a group of elements, press and hold Shift, select the elements you want to save, then click *Edit > Save as new element*.
140+
* To save a group of elements, press and hold Shift, select the elements you want to save, then click *Edit > Save as new element*.
117141

118-
Elements are saved in *Add element > My elements*.
142+
To access your saved elements, click *Add element > My elements*.
119143

120144
[float]
121-
[[add-saved-objects]]
122-
=== Add saved objects
145+
[[add-kibana-visualizations]]
146+
=== Add panels from the Visualize Library
123147

124-
Add <<managing-saved-objects,saved objects>> to your workpad, such as maps and visualizations.
148+
Add a panel that you saved in *Visualize Library* to your workpad.
125149

126150
. Click *Add element > Add from {kib}*.
127151

128-
. Select the saved object you want to add.
152+
. Select the panel you want to add.
129153
+
130154
[role="screenshot"]
131155
image::images/canvas-map-embed.gif[]
132156

133-
. To use the customization options, click the panel menu, then select one of the following options:
157+
. To use the customization options, open the panel menu, then select one of the following options:
158+
159+
* *Edit map* &mdash; Opens <<maps,Maps>> so that you can edit the panel.
134160

135-
* *Edit map* &mdash; Opens <<maps,Maps>> or a visualization builder so that you can edit the original saved object.
161+
* *Edit visualization* &mdash; Opens the visualization editor so that you can edit the panel.
136162

137-
* *Edit panel title* &mdash; Adds a title to the saved object.
163+
* *Edit panel title* &mdash; Allows you to change the panel title.
138164

139-
* *Customize time range* &mdash; Exposes a time filter dedicated to the saved object.
165+
* *Customize time range* &mdash; Allows you to change the time filter dedicated to the panel.
140166

141-
* *Inspect* &mdash; Allows you to drill down into the element data.
167+
* *Inspect* &mdash; Allows you to drill down into the panel data.
142168

143169
[float]
144170
[[add-your-own-images]]

0 commit comments

Comments
 (0)