* [DOCS] Canvas docs refresh * Reformatting * Image descriptions * Adds workpad redirect * Link fix pt 2 * Link fix part 3 * Link fix part 4 * Comments from Poff * Corrected file name * Review comment Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> # Conflicts: # docs/glossary.asciidoc
This commit is contained in:
Kaarina Tungseth
GitHub
parent
bd2fa77f8d
commit
8180a383b7
136
docs/canvas/canvas-edit-workpads.asciidoc
Normal file
136
docs/canvas/canvas-edit-workpads.asciidoc
Normal file
|
|
@ -0,0 +1,136 @@
|
|||
[role="xpack"]
|
||||
[[edit-workpads]]
|
||||
== Edit workpads
|
||||
|
||||
To create the look and feel that you want, apply format settings to the entire workpad, or individual elements.
|
||||
|
||||
[float]
|
||||
[[create-variables]]
|
||||
=== Create variables
|
||||
|
||||
When you frequently use copy and paste, create variables to easily reuse strings and patterns. For example, when you clone a large workpad and need to connect your elements to a new index, use variables to update
|
||||
each element instead of updating them manually.
|
||||
|
||||
. Create the variables.
|
||||
.. Click *Add a variable*.
|
||||
.. Specify the variable options, then click *Save changes*.
|
||||
|
||||
. Apply the variable.
|
||||
.. Copy the variable.
|
||||
.. Select the element you want to change, then open the expression editor.
|
||||
.. Paste the variable.
|
||||
|
||||
For example, to change the index pattern for a set of charts:
|
||||
|
||||
Specify the variable options.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/specify_variable_syntax.png[Specify the variable syntax]
|
||||
|
||||
Copy the variable, then apply it to each element you want to update in the *Expression editor*.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/copy_variable_syntax.png[Copy the variable syntax]
|
||||
|
||||
[float]
|
||||
[[apply-changes-to-the-entire-workpad]]
|
||||
=== Apply changes to the entire workpad
|
||||
|
||||
With stylesheets, you can change the look of the entire workpad, including fonts, colors, layout, and more.
|
||||
|
||||
To get started, enter the changes you want to make in the *Global CSS overrides* text editor, then click *Apply stylesheet*.
|
||||
|
||||
For example, to change the background for the entire workpad, enter:
|
||||
|
||||
[source,text]
|
||||
--------------------------------------------------
|
||||
.canvasPage {
|
||||
background-color: #3990e6;
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
[float]
|
||||
[[change-the-element-settings]]
|
||||
=== Change the element settings
|
||||
|
||||
Element settings enable you to change the display options at the element level. For example, use the element settings to change the dimensions, style, or location of an element.
|
||||
|
||||
[float]
|
||||
[[change-the-display-options]]
|
||||
==== Change the display options
|
||||
|
||||
Choose the display options for your elements. The options available depend on the element you select.
|
||||
|
||||
To change the element display options, click *Display*, then make your changes in the editor.
|
||||
|
||||
To use CSS overrides:
|
||||
|
||||
. Click *+* next to *Element style*, then select *CSS*.
|
||||
. In the *CSS* text editor, enter the changes you want to make, then click *Apply stylesheet*.
|
||||
|
||||
For example, to center an element, enter:
|
||||
|
||||
[source,text]
|
||||
--------------------------------------------------
|
||||
.canvasRenderEl h1 {
|
||||
text.align: center;
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
[float]
|
||||
[[clone-elements]]
|
||||
==== Clone elements
|
||||
To use an element with the same functionality and appearance in multiple places, clone the element.
|
||||
|
||||
Select the element, then click *Edit > Clone*.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/clone_element.gif[Clone elements]
|
||||
|
||||
[float]
|
||||
[[move-and-resize-elements]]
|
||||
==== Move and resize elements
|
||||
|
||||
Canvas provides you with many options to move and resize the elements on your workpad.
|
||||
|
||||
* To move elements, click and hold the element, then drag to the new location.
|
||||
|
||||
* To move elements by 1 pixel, select the element, press and hold Shift, then use your arrow keys.
|
||||
|
||||
* To move elements by 10 pixels, select the element, then use your arrow keys.
|
||||
|
||||
* To resize elements, click and drag the resize handles to the new dimensions.
|
||||
|
||||
[float]
|
||||
[[edit-elements]]
|
||||
==== Edit elements
|
||||
|
||||
The element editing options allow you to arrange and organize the elements on your workpad page.
|
||||
|
||||
To align two or more elements:
|
||||
|
||||
. Press and hold Shift, then select the elements you want to align.
|
||||
|
||||
. Click *Edit > Alignment*, then select the alignment option.
|
||||
|
||||
To distribute three or more elements:
|
||||
|
||||
. Press and hold Shift, then select the elements you want to distribute.
|
||||
|
||||
. Click *Edit > Distribution*, then select the distribution option.
|
||||
|
||||
To reorder elements:
|
||||
|
||||
. Select the element you want to reorder.
|
||||
|
||||
. Click *Edit > Order*, then select the order option.
|
||||
|
||||
[float]
|
||||
[[delete-elements]]
|
||||
==== Delete elements
|
||||
|
||||
When you no longer need an element, delete it from your workpad.
|
||||
|
||||
. Select the element you want to delete.
|
||||
|
||||
. Click *Edit > Delete*.
|
||||
|
|
@ -1,167 +0,0 @@
|
|||
[role="xpack"]
|
||||
[[add-canvas-elements]]
|
||||
=== Add elements
|
||||
|
||||
Create a story about your data by adding elements to your workpad that include images, text, charts, and more. You can create your own elements and connect them to your data sources, add saved objects, and add your own images.
|
||||
|
||||
[float]
|
||||
[[create-canvas-element]]
|
||||
==== Create an element
|
||||
|
||||
Choose the type of element you want to use, then connect it to your own data.
|
||||
|
||||
. Click *Add element*, then select the element you want to use.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-element-select.gif[Canvas elements]
|
||||
|
||||
. To familiarize yourself with the element, use the preconfigured data demo data.
|
||||
+
|
||||
By default, most of the elements you create use 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.
|
||||
|
||||
. To connect the element to your data, select *Data*, then select one of the following data sources:
|
||||
|
||||
* *{es} SQL* — Access your data in {es} using SQL syntax. For information about SQL syntax, refer to {ref}/sql-spec.html[SQL language].
|
||||
|
||||
* *{es} documents* — 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.
|
||||
|
||||
* *Timelion* — Access your time series data using <<timelion,Timelion>> queries. To use Timelion queries, you can enter a query using the <<lucene-query,Lucene Query Syntax>>.
|
||||
|
||||
Each element can display a different data source. Pages and workpads often contain multiple data sources.
|
||||
|
||||
[float]
|
||||
[[canvas-add-object]]
|
||||
==== Add a saved object
|
||||
|
||||
Add <<managing-saved-objects,saved objects>> to your workpad, such as maps and visualizations.
|
||||
|
||||
. Click *Add element > Add from Visualize Library*.
|
||||
|
||||
. Select the saved object you want to add.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-map-embed.gif[]
|
||||
|
||||
. To use the customization options, click the panel menu, then select one of the following options:
|
||||
|
||||
* *Edit map* — Opens <<maps,Maps>> or <<visualize,Visualize>> so that you can edit the original saved object.
|
||||
|
||||
* *Edit panel title* — Adds a title to the saved object.
|
||||
|
||||
* *Customize time range* — Exposes a time filter dedicated to the saved object.
|
||||
|
||||
* *Inspect* — Allows you to drill down into the element data.
|
||||
|
||||
[float]
|
||||
[[canvas-add-image]]
|
||||
==== Add your own image
|
||||
|
||||
To personalize your workpad, add your own logos and graphics.
|
||||
|
||||
. Click *Add element > Manage assets*.
|
||||
|
||||
. On the *Manage workpad assets* window, drag and drop your images.
|
||||
|
||||
. To add the image to the workpad, click the *Create image element* icon.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-add-image.gif[]
|
||||
|
||||
[float]
|
||||
[[move-canvas-elements]]
|
||||
==== Organize elements
|
||||
|
||||
Move and resize your elements to meet your design needs.
|
||||
|
||||
* To move, click and hold the element, then drag to the new location.
|
||||
|
||||
* To move by 1 pixel, select the element, press and hold Shift, then use your arrow keys.
|
||||
|
||||
* To move by 10 pixels, select the element, then use your arrow keys.
|
||||
|
||||
* To resize, click and drag the resize handles to the new dimensions.
|
||||
|
||||
[float]
|
||||
[[format-canvas-elements]]
|
||||
==== Format elements
|
||||
|
||||
For consistency and readability across your workpad pages, align, distribute, and reorder elements.
|
||||
|
||||
To align two or more elements:
|
||||
|
||||
. Press and hold Shift, then select the elements you want to align.
|
||||
|
||||
. Click *Edit > Alignment*, then select the alignment option.
|
||||
|
||||
To distribute three or more elements:
|
||||
|
||||
. Press and hold Shift, then select the elements you want to distribute.
|
||||
|
||||
. Click *Edit > Distribution*, then select the distribution option.
|
||||
|
||||
To reorder elements:
|
||||
|
||||
. Select the element you want to reorder.
|
||||
|
||||
. Click *Edit > Order*, then select the order option.
|
||||
|
||||
[float]
|
||||
[[data-display]]
|
||||
==== Change the element display options
|
||||
|
||||
Each element has its own display options to fit your design needs.
|
||||
|
||||
To choose the display options, click *Display*, then make your changes.
|
||||
|
||||
To define the appearance of the container and border:
|
||||
|
||||
. Next to *Element style*, click *+*, then select *Container style*.
|
||||
|
||||
. Expand *Container style*.
|
||||
|
||||
. Change the *Appearance* and *Border* options.
|
||||
|
||||
To apply CSS overrides:
|
||||
|
||||
. Next to *Element style*, click *+*, then select *CSS*.
|
||||
|
||||
. Enter the *CSS*.
|
||||
+
|
||||
For example, to center the Markdown element, enter:
|
||||
+
|
||||
[source,text]
|
||||
--------------------------------------------------
|
||||
.canvasRenderEl h1 {
|
||||
text.align: center;
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
. Click *Apply stylesheet*.
|
||||
|
||||
[float]
|
||||
[[save-elements]]
|
||||
==== Save elements
|
||||
|
||||
To use the elements across all workpads, save the elements.
|
||||
|
||||
When you're ready to save your element, select the element, then click *Edit > Save as new element*.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/canvas_save_element.png[]
|
||||
|
||||
To save a group of elements, press and hold Shift, select the elements you want to save, then click *Edit > Save as new element*.
|
||||
|
||||
To access your saved elements, click *Add element > My elements*.
|
||||
|
||||
[float]
|
||||
[[delete-elements]]
|
||||
==== Delete elements
|
||||
|
||||
When you no longer need an element, delete it from your workpad.
|
||||
|
||||
. Select the element you want to delete.
|
||||
|
||||
. Click *Edit > Delete*.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas_element_options.png[]
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[canvas-present-workpad]]
|
||||
=== Present your workpad
|
||||
== Present your workpad
|
||||
|
||||
When you are ready to present your workpad, use and enable the presentation options.
|
||||
|
||||
|
|
@ -21,3 +21,31 @@ image::images/canvas-autoplay-interval.png[Element autoplay interval]
|
|||
image::images/canvas-fullscreen.png[Fullscreen mode]
|
||||
|
||||
. When you are ready to exit fullscreen mode, press the Esc (Escape) key.
|
||||
|
||||
[float]
|
||||
[[zoom-in-out]]
|
||||
=== Use the zoom options
|
||||
|
||||
To get a closer look at a portion of your workpad, use the zoom options.
|
||||
|
||||
. Click *View > Zoom*.
|
||||
|
||||
. Select the zoom option.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-zoom-controls.png[Zoom controls]
|
||||
|
||||
[float]
|
||||
[[configure-auto-refresh-interval]]
|
||||
=== Change the auto-refresh interval
|
||||
|
||||
Change how often the data refreshes on your workpad.
|
||||
|
||||
. Click *View > Auto refresh settings*.
|
||||
|
||||
. Select the interval you want to use, or *Set a custom interval*.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-refresh-interval.png[Element data refresh interval]
|
||||
+
|
||||
To manually refresh the data, click image:canvas/images/canvas-refresh-data.png[].
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
[role="xpack"]
|
||||
[[workpad-share-options]]
|
||||
=== Share your workpad
|
||||
== Share your workpad
|
||||
|
||||
When you've finished your workpad, you can share it outside of {kib}.
|
||||
|
||||
[float]
|
||||
[[export-single-workpad]]
|
||||
==== Export workpads
|
||||
=== Export workpads
|
||||
|
||||
Create a JSON file of your workpad that you can export outside of {kib}.
|
||||
|
||||
|
|
@ -19,9 +19,9 @@ Want to export multiple workpads? Go to the *Canvas* home page, select the workp
|
|||
|
||||
[float]
|
||||
[[create-workpad-pdf]]
|
||||
==== Create a PDF
|
||||
=== Create a PDF
|
||||
|
||||
If you have a license that supports the {report-features}, you can create a PDF copy of your workpad that you can save and share outside {kib}.
|
||||
If you have a subscription that supports the {report-features}, you can create a PDF copy of your workpad that you can save and share outside {kib}.
|
||||
|
||||
Click *Share > PDF reports > Generate PDF*.
|
||||
|
||||
|
|
@ -32,9 +32,9 @@ For more information, refer to <<reporting-getting-started, Reporting from Kiban
|
|||
|
||||
[float]
|
||||
[[create-workpad-URL]]
|
||||
==== Create a POST URL
|
||||
=== Create a POST URL
|
||||
|
||||
If you have a license that supports the {report-features}, you can create a POST URL that you can use to automatically generate PDF reports using Watcher or a script.
|
||||
If you have a subscription that supports the {report-features}, you can create a POST URL that you can use to automatically generate PDF reports using <<watcher-ui,Watcher>> or a script.
|
||||
|
||||
Click *Share > PDF reports > Copy POST URL*.
|
||||
|
||||
|
|
@ -45,7 +45,7 @@ For more information, refer to <<automating-report-generation, Automating report
|
|||
|
||||
[float]
|
||||
[[add-workpad-website]]
|
||||
==== Share the workpad on a website
|
||||
=== Share the workpad on a website
|
||||
|
||||
beta[] Canvas allows you to create _shareables_, which are workpads that you download and securely share on any website. To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
[role="xpack"]
|
||||
[[canvas-tutorial]]
|
||||
== Canvas tutorial
|
||||
== Tutorial: Create a workpad for monitoring sales
|
||||
|
||||
To get up and running with Canvas, use the following tutorial where you'll create a display for monitoring sales at an eCommerce store.
|
||||
To get up and running with Canvas, use the following tutorial where you'll create a workpad for monitoring sales at an eCommerce store.
|
||||
|
||||
[float]
|
||||
=== Before you begin
|
||||
|
|
@ -124,7 +124,7 @@ Here are some things to try:
|
|||
|
||||
* Play with the {kibana-ref}/add-sample-data.html[sample Canvas workpads].
|
||||
|
||||
* Build presentations of your own live data with <<create-canvas-workpad,workpads>>.
|
||||
* Build presentations of your own live data with <<create-workpads,workpads>>.
|
||||
|
||||
* Learn more about <<add-canvas-elements,elements>> — the building blocks of your workpad.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,140 +0,0 @@
|
|||
[role="xpack"]
|
||||
[[create-canvas-workpad]]
|
||||
== Create a workpad
|
||||
|
||||
A Canvas _workpad_ provides you with a workspace where you can build presentations of your live data.
|
||||
|
||||
To create a workpad, choose one of the following options:
|
||||
|
||||
* <<blank-canvas-workpad,Build fully customizable presentations of your own data>>
|
||||
|
||||
* <<canvas-template-workpad,Choose from a set of preconfigured workpad templates>>
|
||||
|
||||
* <<sample-data-workpad,Gather inspiration from the {kib} sample data workpads>>
|
||||
|
||||
* <<import-canvas-workpad,Import a workpad that someone else has already started>>
|
||||
|
||||
[float]
|
||||
[[blank-canvas-workpad]]
|
||||
=== Start with a blank workpad
|
||||
|
||||
To use the background colors, images, and data of your choice, start with a blank workpad.
|
||||
|
||||
. Open the menu, then go to *Canvas*.
|
||||
|
||||
. On the *Canvas workpads* view, click *Create workpad*.
|
||||
|
||||
. Add a *Name* to your workpad.
|
||||
|
||||
. In the *Width* and *Height* fields, specify the size.
|
||||
|
||||
. Select the layout.
|
||||
+
|
||||
For example, click *720p* for a traditional presentation layout.
|
||||
|
||||
. Click the *Background color* picker, then select the background color for your workpad.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-background-color-picker.png[Canvas color picker]
|
||||
|
||||
[float]
|
||||
[[canvas-template-workpad]]
|
||||
=== Create a workpad from a template
|
||||
|
||||
If you're unsure about where to start, you can use one of the preconfigured templates that come with Canvas.
|
||||
|
||||
. Open the menu, then go to *Canvas*.
|
||||
|
||||
. On the *Canvas workpads* view, select *Templates*.
|
||||
|
||||
. Click the preconfigured template that you want to use.
|
||||
|
||||
. Add your own *Name* to the workpad.
|
||||
|
||||
[float]
|
||||
[[import-canvas-workpad]]
|
||||
=== Import an existing workpad
|
||||
|
||||
When you want to use a workpad that someone else has already started, import the JSON file into Canvas.
|
||||
|
||||
. Open the menu, then go to *Canvas*.
|
||||
|
||||
. On the *Canvas workpads* view, click and drag the file to the *Import workpad JSON file* field.
|
||||
|
||||
[float]
|
||||
[[sample-data-workpad]]
|
||||
=== Use a sample data workpad
|
||||
|
||||
Each of the sample data sets comes with a Canvas workpad that you can use for your own workpad inspiration.
|
||||
|
||||
. Add a {kibana-ref}/add-sample-data.html[sample data set].
|
||||
|
||||
. On the *Add Data* page, click *View data*, then select *Canvas*.
|
||||
|
||||
[float]
|
||||
[[apply-workpad-styles]]
|
||||
=== Apply a set of styles to the entire workpad
|
||||
|
||||
To make your workpad look exactly the way you want, use the editor to apply CSS overrides.
|
||||
|
||||
. Expand *Global CSS overrides*.
|
||||
|
||||
. Enter the CSS.
|
||||
+
|
||||
For example, to change the background on every page, enter:
|
||||
+
|
||||
[source,text]
|
||||
--------------------------------------------------
|
||||
.canvasPage {
|
||||
background-color: #3990e6;
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
. Click *Apply stylesheet*.
|
||||
|
||||
[float]
|
||||
[[configure-auto-refresh-interval]]
|
||||
=== Change the auto-refresh interval
|
||||
|
||||
Change how often the data refreshes on your workpad.
|
||||
|
||||
. Click *View > Auto refresh settings*.
|
||||
|
||||
. Select the interval you want to use, or *Set a custom interval*.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-refresh-interval.png[Element data refresh interval]
|
||||
+
|
||||
To manually refresh the data, click image:canvas/images/canvas-refresh-data.png[].
|
||||
|
||||
[float]
|
||||
[[zoom-in-out]]
|
||||
=== Use the zoom options
|
||||
|
||||
To get a closer look at a portion of your workpad, use the zoom options.
|
||||
|
||||
. Click *View > Zoom*.
|
||||
|
||||
. Select the zoom option.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-zoom-controls.png[Zoom controls]
|
||||
|
||||
[float]
|
||||
[[add-more-pages]]
|
||||
=== Add pages
|
||||
|
||||
Organize your ideas onto separate pages by adding more pages.
|
||||
|
||||
. Click *Page 1*, then click *+*.
|
||||
|
||||
. On the *Page* editor panel, select the page transition from the *Transition* dropdown.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-add-pages.gif[Add pages]
|
||||
|
||||
include::{kib-repo-dir}/canvas/canvas-elements.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/canvas/canvas-present-workpad.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/canvas/canvas-share-workpad.asciidoc[]
|
||||
BIN
docs/canvas/images/clone_element.gif
Normal file
BIN
docs/canvas/images/clone_element.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.1 MiB |
BIN
docs/canvas/images/copy_variable_syntax.png
Normal file
BIN
docs/canvas/images/copy_variable_syntax.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 27 KiB |
BIN
docs/canvas/images/specify_variable_syntax.png
Normal file
BIN
docs/canvas/images/specify_variable_syntax.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
420
docs/glossary.asciidoc
Normal file
420
docs/glossary.asciidoc
Normal file
|
|
@ -0,0 +1,420 @@
|
|||
[glossary]
|
||||
[[glossary]]
|
||||
= Glossary
|
||||
|
||||
<<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
|
||||
|
||||
[float]
|
||||
[[a_glos]]
|
||||
== A
|
||||
|
||||
[glossary]
|
||||
[[glossary-action]] action ::
|
||||
+
|
||||
--
|
||||
// tag::action-def[]
|
||||
The alert-specific response that occurs when an alert fires.
|
||||
An alert can have multiple actions.
|
||||
See
|
||||
{kibana-ref}/action-types.html[Action and connector types].
|
||||
// end::action-def[]
|
||||
--
|
||||
|
||||
[[glossary-advanced-settings]] Advanced Settings ::
|
||||
// tag::advanced-settings-def[]
|
||||
Enables you to control the appearance and behavior of {kib}
|
||||
by setting the date format, default index, and other attributes.
|
||||
Part of {kib} Stack Management.
|
||||
See {kibana-ref}/advanced-options.html[Advanced Settings].
|
||||
// end::advanced-settings-def[]
|
||||
|
||||
[[glossary-alert]] alert ::
|
||||
// tag::alert-def[]
|
||||
A set of <<glossary-condition,conditions>>, schedules, and <<glossary-action,actions>>
|
||||
that enable notifications.
|
||||
See <<glossary-alerts-and-actions,Alerts and Actions>>.
|
||||
// end::alert-def[]
|
||||
|
||||
[[glossary-alerts-and-actions]] Alerts and Actions ::
|
||||
// tag::alerts-and-actions-def[]
|
||||
A comprehensive view of all your alerts. Enables you to access and
|
||||
manage alerts for all {kib} apps from one place.
|
||||
See {kibana-ref}/alerting-getting-started.html[Alerts and Actions].
|
||||
// end::alerts-and-actions-def[]
|
||||
|
||||
[[glossary-annotation]] annotation ::
|
||||
// tag::annotation-def[]
|
||||
A way to augment a data display with descriptive domain knowledge.
|
||||
// end::annotation-def[]
|
||||
|
||||
|
||||
[[glossary-app]] app ::
|
||||
// tag::app-def[]
|
||||
A top-level {kib} component that is accessed through the side navigation.
|
||||
Apps include core {kib} components such as Discover and Dashboard,
|
||||
solutions like Observability and Security, and special-purpose tools
|
||||
like Maps and Stack Management.
|
||||
// end::app-def[]
|
||||
|
||||
|
||||
[float]
|
||||
[[b_glos]]
|
||||
== B
|
||||
|
||||
[[glossary-basemap]] basemap ::
|
||||
// tag::basemap-def[]
|
||||
The background detail necessary to orient the location of a map.
|
||||
// end::basemap-def[]
|
||||
|
||||
[[glossary-bucket]] bucket ::
|
||||
// tag::bucket-def[]
|
||||
A set of documents in {kib} that have certain characteristics in common.
|
||||
For example, matching documents might be bucketed by color, distance, or date range.
|
||||
// end::bucket-def[]
|
||||
|
||||
[[glossary-bucket-aggregation]] bucket aggregation::
|
||||
// tag::bucket-aggregation-def[]
|
||||
An aggregation that creates buckets of documents. Each bucket is associated with a
|
||||
criterion (depending on the aggregation type), which determines whether or not a document
|
||||
in the current context falls into the bucket.
|
||||
// end::bucket-aggregation-def[]
|
||||
|
||||
[float]
|
||||
[[c_glos]]
|
||||
== C
|
||||
|
||||
[[glossary-canvas]] Canvas ::
|
||||
// tag::canvas-def[]
|
||||
Enables you to create presentations and infographics that pull live data directly from {es}.
|
||||
See {kibana-ref}/canvas.html[Canvas].
|
||||
// end::canvas-def[]
|
||||
|
||||
[[glossary-canvas-language]] Canvas expression language::
|
||||
// tag::canvas-language-def[]
|
||||
A pipeline-based expression language for manipulating and visualizing data.
|
||||
Includes dozens of functions and other capabilities, such as table transforms,
|
||||
type casting, and sub-expressions. Supports TinyMath functions for complex math calculations.
|
||||
See {kibana-ref}/canvas-function-reference.html[Canvas function reference].
|
||||
// end::canvas-language-def[]
|
||||
|
||||
|
||||
[[glossary-certainty]] certainty ::
|
||||
// tag::certainty-def[]
|
||||
Specifies how many documents must contain a pair of terms before it is considered
|
||||
a useful connection in a graph.
|
||||
// end::certainty-def[]
|
||||
|
||||
[[glossary-condition]] condition ::
|
||||
// tag::condition-def[]
|
||||
Specifies the circumstances that must be met to trigger an alert.
|
||||
// end::condition-def[]
|
||||
|
||||
[[glossary-connector]] connector ::
|
||||
// tag::connector-def[]
|
||||
A configuration that enables integration with an external system (the destination for an action).
|
||||
See {kibana-ref}/action-types.html[Action and connector types].
|
||||
// end::connector-def[]
|
||||
|
||||
[[glossary-console]] Console ::
|
||||
// tag::console-def[]
|
||||
A tool for interacting with the {es} REST API.
|
||||
You can send requests to {es}, view responses,
|
||||
view API documentation, and get your request history.
|
||||
See {kibana-ref}/console-kibana.html[Console].
|
||||
// end::console-def[]
|
||||
|
||||
[float]
|
||||
[[d_glos]]
|
||||
== D
|
||||
|
||||
[[glossary-dashboard]] dashboard ::
|
||||
// tag::dashboard-def[]
|
||||
A collection of
|
||||
<<glossary-visualization,visualizations>>, <<glossary-saved-search,saved searches>>, and
|
||||
<<glossary-map,maps>> that
|
||||
provide insights into your data from multiple perspectives.
|
||||
// end::dashboard-def[]
|
||||
|
||||
[[glossary-data-source]] data source ::
|
||||
// tag::data-source-def[]
|
||||
A file, database, or service that provides the underlying data for a map, Canvas element, or visualization.
|
||||
// end::data-source-def[]
|
||||
|
||||
[[glossary-discover]] Discover ::
|
||||
// tag::discover-def[]
|
||||
Enables you to search and filter your data to zoom in on the information
|
||||
that you are interested in.
|
||||
// end::discover-def[]
|
||||
|
||||
[[glossary-drilldown]] drilldown ::
|
||||
// tag::drilldown-def[]
|
||||
A navigation path that retains context (time range and filters)
|
||||
from the source to the destination, so you can view the data from a new perspective.
|
||||
A dashboard that shows the overall status of multiple data centers
|
||||
might have a drilldown to a dashboard for a single data center. See {kibana-ref}/drilldowns.html[Drilldowns].
|
||||
// end::drilldown-def[]
|
||||
|
||||
|
||||
|
||||
[float]
|
||||
[[e_glos]]
|
||||
== E
|
||||
|
||||
[[glossary-edge]] edge ::
|
||||
// tag::edge-def[]
|
||||
A connection between nodes in a graph that shows that they are related.
|
||||
The line weight indicates the strength of the relationship. See
|
||||
{kibana-ref}/xpack-graph.html[Graph].
|
||||
// end::edge-def[]
|
||||
|
||||
|
||||
[[glossary-ems]] Elastic Maps Service (EMS) ::
|
||||
// tag::ems-def[]
|
||||
A service that provides basemap tiles, shape files, and other key features
|
||||
that are essential for visualizing geospatial data.
|
||||
// end::ems-def[]
|
||||
|
||||
[[glossary-element]] element ::
|
||||
// tag::element-def[]
|
||||
A <<glossary-canvas,Canvas>> workpad object that displays an image, text, or visualization.
|
||||
// end::element-def[]
|
||||
|
||||
|
||||
[float]
|
||||
[[f_glos]]
|
||||
== F
|
||||
|
||||
[[glossary-feature-controls]] Feature Controls ::
|
||||
// tag::feature-controls-def[]
|
||||
Enables administrators to customize which features are
|
||||
available in each <<glossary-space,space>>. See
|
||||
{kibana-ref}//xpack-spaces.html#spaces-control-feature-visibility[Feature Controls].
|
||||
// end::feature-controls-def[]
|
||||
|
||||
[float]
|
||||
[[g_glos]]
|
||||
== G
|
||||
|
||||
[[glossary-graph]] graph ::
|
||||
// tag::graph-def[]
|
||||
A data structure and visualization that shows interconnections between
|
||||
a set of entities. Each entity is represented by a node. Connections between
|
||||
nodes are represented by <<glossary-edge,edges>>. See {kibana-ref}/xpack-graph.html[Graph].
|
||||
// end::graph-def[]
|
||||
|
||||
[[glossary-grok-debugger]] Grok Debugger ::
|
||||
// tag::grok-debugger-def[]
|
||||
A tool for building and debugging grok patterns. Grok is good for parsing
|
||||
syslog, Apache, and other webserver logs. See
|
||||
{kibana-ref}/xpack-grokdebugger.html[Debugging grok expressions].
|
||||
// end::grok-debugger-def[]
|
||||
|
||||
|
||||
[float]
|
||||
[[k_glos]]
|
||||
== K
|
||||
|
||||
[[glossary-kibana-privileges]] {kib} privileges ::
|
||||
// tag::kibana-privileges-def[]
|
||||
Enable administrators to grant users read-only, read-write, or no access to
|
||||
individual features within <<glossary-space,spaces>> in {kib}. See
|
||||
{kibana-ref}/kibana-privileges.html[{kib} privileges].
|
||||
// end::kibana-privileges-def[]
|
||||
|
||||
[[glossary-kql]] {kib} Query Language (KQL) ::
|
||||
// tag::kql-def[]
|
||||
The default language for querying in {kib}. KQL provides
|
||||
support for scripted fields. See
|
||||
{kibana-ref}/kuery-query.html[Kibana Query Language].
|
||||
// end::kql-def[]
|
||||
|
||||
|
||||
[float]
|
||||
[[l_glos]]
|
||||
== L
|
||||
|
||||
[[glossary-lens]] Lens ::
|
||||
// tag::lens-def[]
|
||||
Enables you to build visualizations by dragging and dropping data fields.
|
||||
Lens makes makes smart visualization suggestions for your data,
|
||||
allowing you to switch between visualization types.
|
||||
See {kibana-ref}/lens.html[Lens].
|
||||
// end::lens-def[]
|
||||
|
||||
|
||||
[[glossary-lucene]] Lucene query syntax ::
|
||||
// tag::lucene-def[]
|
||||
The query syntax for {kib}’s legacy query language. The Lucene query
|
||||
syntax is available under the options menu in the query bar and from
|
||||
<<glossary-advanced-settings,Advanced Settings>>.
|
||||
// end::lucene-def[]
|
||||
|
||||
[float]
|
||||
[[m_glos]]
|
||||
== M
|
||||
|
||||
[[glossary-map]] map ::
|
||||
// tag::map-def[]
|
||||
A representation of geographic data using symbols and labels.
|
||||
See {kibana-ref}/maps.html[Maps].
|
||||
// end::map-def[]
|
||||
|
||||
[[glossary-metric-aggregation]] metric aggregation ::
|
||||
// tag::metric-aggregation-def[]
|
||||
An aggregation that calculates and tracks metrics for a set of documents.
|
||||
// end::metric-aggregation-def[]
|
||||
|
||||
|
||||
[float]
|
||||
[[p_glos]]
|
||||
== P
|
||||
|
||||
[[glossary-painless-lab]] Painless Lab ::
|
||||
// tag::painless-lab-def[]
|
||||
An interactive code editor that lets you test and debug Painless scripts in real-time.
|
||||
See {kibana-ref}/painlesslab.html[Painless Lab].
|
||||
// end::painless-lab-def[]
|
||||
|
||||
|
||||
[[glossary-panel]] panel ::
|
||||
// tag::panel-def[]
|
||||
A <<glossary-dashboard,dashboard>> component that contains a
|
||||
query element or visualization, such as a chart, table, or list.
|
||||
// end::panel-def[]
|
||||
|
||||
|
||||
[float]
|
||||
[[q_glos]]
|
||||
== Q
|
||||
|
||||
[[glossary-query-profiler]] Query Profiler ::
|
||||
// tag::query-profiler-def[]
|
||||
A tool that enables you to inspect and analyze search queries to diagnose and debug poorly performing queries.
|
||||
See {kibana-ref}/xpack-profiler.html[Query Profiler].
|
||||
// end::query-profiler-def[]
|
||||
|
||||
[float]
|
||||
[[s_glos]]
|
||||
== S
|
||||
|
||||
[[glossary-saved-object]] saved object ::
|
||||
// tag::saved-object-def[]
|
||||
A representation of a dashboard, visualization, map, index pattern, or Canvas workpad
|
||||
that can be stored and reloaded.
|
||||
// end::saved-object-def[]
|
||||
|
||||
[[glossary-saved-search]] saved search ::
|
||||
// tag::saved-search-def[]
|
||||
The query text, filters, and time filter that make up a search,
|
||||
saved for later retrieval and reuse.
|
||||
// end::saved-search-def[]
|
||||
|
||||
[[glossary-scripted-field]] scripted field ::
|
||||
// tag::scripted-field-def[]
|
||||
A field that computes data on the fly from the data in {es} indices.
|
||||
Scripted field data is shown in Discover and used in visualizations.
|
||||
// end::scripted-field-def[]
|
||||
|
||||
[[glossary-shareable]] shareable ::
|
||||
// tag::shareable-def[]
|
||||
A Canvas workpad that can be embedded on any webpage.
|
||||
Shareables enable you to display Canvas visualizations on internal wiki pages or public websites.
|
||||
// end::shareable-def[]
|
||||
|
||||
[[glossary-space]] space ::
|
||||
// tag::space-def[]
|
||||
A place for organizing <<glossary-dashboard,dashboards>>,
|
||||
<<glossary-visualization,visualizations>>, and other <<glossary-saved-object,saved objects>> by category.
|
||||
For example, you might have different spaces for each team, use case, or individual.
|
||||
See
|
||||
{kibana-ref}/xpack-spaces.html[Spaces].
|
||||
// end::space-def[]
|
||||
|
||||
|
||||
[float]
|
||||
[[t_glos]]
|
||||
== T
|
||||
|
||||
[[glossary-term-join]] term join ::
|
||||
// tag::term-join-def[]
|
||||
A shared key that combines vector features with the results of an
|
||||
{es} terms aggregation. Term joins augment vector features with
|
||||
properties for data-driven styling and rich tooltip content in maps.
|
||||
// end::term-join-def[]
|
||||
|
||||
[[glossary-time-filter]] time filter ::
|
||||
// tag::time-filter-def[]
|
||||
A {kib} control that constrains the search results to a particular time period.
|
||||
// end::time-filter-def[]
|
||||
|
||||
[[glossary-timelion]] Timelion ::
|
||||
// tag::timelion-def[]
|
||||
A tool for building a time series visualization that analyzes data in time order.
|
||||
See {kibana-ref}/timelion.html[Timelion].
|
||||
// end::timelion-def[]
|
||||
|
||||
|
||||
[[glossary-time-series-data]] time series data ::
|
||||
// tag::time-series-data-def[]
|
||||
Timestamped data such as logs, metrics, and events that is indexed on an ongoing basis.
|
||||
// end::time-series-data-def[]
|
||||
|
||||
|
||||
[[glossary-TSVB-data]] TSVB ::
|
||||
// tag::tsvb-def[]
|
||||
A time series data visualizer that allows you to combine an
|
||||
infinite number of aggregations to display complex data.
|
||||
See {kibana-ref}/TSVB.html[TSVB].
|
||||
// end::tsvb-def[]
|
||||
|
||||
|
||||
[float]
|
||||
[[u_glos]]
|
||||
== U
|
||||
|
||||
[[glossary-upgrade-assistant]] Upgrade Assistant ::
|
||||
// tag::upgrade-assistant-def[]
|
||||
A tool that helps you prepare for an upgrade to the next major version of
|
||||
{es}. The assistant identifies the deprecated settings in your cluster and
|
||||
indices and guides you through resolving issues, including reindexing. See
|
||||
{kibana-ref}/upgrade-assistant.html[Upgrade Assistant].
|
||||
// end::upgrade-assistant-def[]
|
||||
|
||||
|
||||
[float]
|
||||
[[v_glos]]
|
||||
== V
|
||||
|
||||
[[glossary-vega]] Vega ::
|
||||
// tag::vega-def[]
|
||||
A declarative language used to create interactive visualizations.
|
||||
See {kibana-ref}/vega-graph.html[Vega].
|
||||
// end::vega-def[]
|
||||
|
||||
[[glossary-vector]] vector data::
|
||||
// tag::vector-def[]
|
||||
Points, lines, and polygons used to represent a map.
|
||||
// end::vector-def[]
|
||||
|
||||
[[glossary-visualization]] visualization ::
|
||||
// tag::visualization-def[]
|
||||
A graphical representation of query results in {kib} (e.g., a histogram, line graph, pie chart, or heat map).
|
||||
// end::visualization-def[]
|
||||
|
||||
[float]
|
||||
[[w_glos]]
|
||||
== W
|
||||
|
||||
[[glossary-watcher]] Watcher ::
|
||||
// tag::watcher-def[]
|
||||
The original suite of alerting features.
|
||||
See
|
||||
{kibana-ref}/watcher-ui.html[Watcher].
|
||||
// end::watcher-def[]
|
||||
|
||||
[[glossary-workpad]] workpad ::
|
||||
// tag::workpad-def[]
|
||||
A workspace where you build presentations of your live data in <<glossary-canvas,Canvas>>.
|
||||
See
|
||||
{kibana-ref}/canvas.html[Create a workpad].
|
||||
// end::workpad-def[]
|
||||
|
|
@ -18,16 +18,170 @@ With Canvas, you can:
|
|||
* Focus the data you want to display with filters.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/canvas-gs-example.png[]
|
||||
image::images/canvas-gs-example.png[Getting started example]
|
||||
|
||||
For a quick overview of Canvas, watch link:https://www.youtube.com/watch?v=ZqvF_5-1xjQ[Stand out with Canvas].
|
||||
//When https://github.com/elastic/Video/issues/358 is resolved, update this link.
|
||||
|
||||
[float]
|
||||
[[create-workpads]]
|
||||
== Create workpads
|
||||
|
||||
A _workpad_ provides you with a space where you can build presentations of your live data.
|
||||
|
||||
[float]
|
||||
[[start-with-a-blank-workpad]]
|
||||
=== Start with a blank workpad
|
||||
|
||||
To use the background colors, images, and data of your choice, start with a blank workpad.
|
||||
|
||||
. Open the menu, then go to *Canvas*.
|
||||
|
||||
. On the *Canvas workpads* view, click *Create workpad*.
|
||||
|
||||
. Add a *Name* to your workpad.
|
||||
|
||||
. In the *Width* and *Height* fields, specify the size.
|
||||
|
||||
. Select the layout.
|
||||
+
|
||||
For example, click *720p* for a traditional presentation layout.
|
||||
|
||||
. Click the *Background color* picker, then select the background color for your workpad.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-background-color-picker.png[Canvas color picker]
|
||||
|
||||
[float]
|
||||
[[create-workpads-from-templates]]
|
||||
=== Create workpads from templates
|
||||
|
||||
If you're unsure about where to start, you can use one of the preconfigured templates that come with Canvas.
|
||||
|
||||
. Open the menu, then go to *Canvas*.
|
||||
|
||||
. On the *Canvas workpads* view, select *Templates*.
|
||||
|
||||
. Click the preconfigured template that you want to use.
|
||||
|
||||
. Add your own *Name* to the workpad.
|
||||
|
||||
[float]
|
||||
[[import-existing-workpads]]
|
||||
=== Import existing workpads
|
||||
|
||||
When you want to use a workpad that someone else has already started, import the JSON file into Canvas.
|
||||
|
||||
. Open the menu, then go to *Canvas*.
|
||||
|
||||
. On the *Canvas workpads* view, click and drag the file to the *Import workpad JSON file* field.
|
||||
|
||||
[float]
|
||||
[[use-sample-data-workpads]]
|
||||
=== Use sample data workpads
|
||||
|
||||
Each of the sample data sets comes with a Canvas workpad that you can use for your own workpad inspiration.
|
||||
|
||||
. Add a {kibana-ref}/add-sample-data.html[sample data set].
|
||||
|
||||
. On the *Add Data* page, click *View data*, then select *Canvas*.
|
||||
|
||||
[float]
|
||||
[[add-canvas-elements]]
|
||||
== Add elements
|
||||
|
||||
Create a story about your data by adding elements to your workpad that include images, text, charts, and more.
|
||||
|
||||
[float]
|
||||
[[create-elements]]
|
||||
=== Create elements
|
||||
|
||||
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
|
||||
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.
|
||||
|
||||
To begin, click *Add element*, then select the element you want to use.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/canvas-element-select.gif[Canvas elements]
|
||||
|
||||
When you're ready to connect the element to your data, select *Data*, then select one of the following data sources:
|
||||
|
||||
* *{es} SQL* — Access your data in {es} using {ref}/sql-spec.html[SQL syntax].
|
||||
|
||||
* *{es} documents* — 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.
|
||||
|
||||
* *Timelion* — Access your time series data using <<timelion,Timelion>> queries. To use Timelion queries, you can enter a query using the <<lucene-query,Lucene Query Syntax>>.
|
||||
|
||||
Each element can display a different data source, and pages and workpads often contain multiple data sources.
|
||||
|
||||
When you're ready to save your element, select the element, then click *Edit > Save as new element*.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/canvas_save_element.png[]
|
||||
|
||||
To save a group of elements, press and hold Shift, select the elements you want to save, then click *Edit > Save as new element*.
|
||||
|
||||
Elements are saved in *Add element > My elements*.
|
||||
|
||||
[float]
|
||||
[[add-existing-visuualizations]]
|
||||
=== Add existing visualizations
|
||||
|
||||
Add <<managing-saved-objects,saved objects>> to your workpad, such as maps and visualizations.
|
||||
|
||||
. Click *Add element > Add from Visualize Library*.
|
||||
|
||||
. Select the saved object you want to add.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-map-embed.gif[]
|
||||
|
||||
. To use the customization options, click the panel menu, then select one of the following options:
|
||||
|
||||
* *Edit map* — Opens <<maps,Maps>> or <<visualize,Visualize>> so that you can edit the original saved object.
|
||||
|
||||
* *Edit panel title* — Adds a title to the saved object.
|
||||
|
||||
* *Customize time range* — Exposes a time filter dedicated to the saved object.
|
||||
|
||||
* *Inspect* — Allows you to drill down into the element data.
|
||||
|
||||
[float]
|
||||
[[add-your-own-images]]
|
||||
=== Add your own images
|
||||
|
||||
To personalize your workpad, add your own logos and graphics.
|
||||
|
||||
. Click *Add element > Manage assets*.
|
||||
|
||||
. On the *Manage workpad assets* window, drag and drop your images.
|
||||
|
||||
. To add the image to the workpad, click the *Create image element* icon.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-add-image.gif[Add image to Canvas]
|
||||
|
||||
[float]
|
||||
[[add-more-pages]]
|
||||
== Add pages
|
||||
|
||||
Organize and separate your ideas by adding more pages.
|
||||
|
||||
. Click *Page 1*, then click *+*.
|
||||
|
||||
. On the *Page* editor panel, select the page transition from the *Transition* dropdown.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/canvas-add-pages.gif[Add pages]
|
||||
|
||||
--
|
||||
|
||||
include::{kib-repo-dir}/canvas/canvas-tutorial.asciidoc[]
|
||||
include::{kib-repo-dir}/canvas/canvas-edit-workpads.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/canvas/canvas-workpad.asciidoc[]
|
||||
include::{kib-repo-dir}/canvas/canvas-present-workpad.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/canvas/canvas-share-workpad.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/canvas/canvas-tutorial.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/canvas/canvas-expression-lifecycle.asciidoc[]
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue