diff --git a/docs/dashboard.asciidoc b/docs/dashboard.asciidoc index 1035e6193a76..7aab0329f644 100644 --- a/docs/dashboard.asciidoc +++ b/docs/dashboard.asciidoc @@ -1,9 +1,11 @@ -[float] [[dashboard]] == Dashboard -A Kibana _dashboard_ displays saved visualizations in groups that you can arrange. You can save a dashboard to share or -reload at a later time. +A Kibana _dashboard_ displays a set of saved visualizations in groups that you can arrange freely. You can save a +dashboard to share or reload at a later time. + +.Sample dashboard +image:images/tfl-dashboard.png[Example dashboard] [float] [[getting-started]] @@ -13,13 +15,13 @@ You need at least one saved <> to use a dashboard. [float] [[creating-a-new-dashboard]] -==== Creating a New Dashboard +==== Building a New Dashboard The first time you click the *Dashboard* tab, Kibana displays an empty dashboard. image:images/NewDashboard.png[New Dashboard screen] -Add visualizations to start creating your dashboard. +Build your dashboard by adding visualizations. [float] [[adding-visualizations-to-a-dashboard]] @@ -31,27 +33,36 @@ string into the *Visualization Filter* field. The visualization you select appears in a _container_ on your dashboard. -*NOTE:* If you see a message about the container's height or width being too small, <>. [float] [[saving-dashboards]] ==== Saving Dashboards -To save the dashboard, click the *Save Dashboard* button in the toolbar panel, enter a name for the dashboard in the *Save As* field, and click the *Save* button. +To save the dashboard, click the *Save Dashboard* button in the toolbar panel, enter a name for the dashboard in the +*Save As* field, and click the *Save* button. [float] [[loading-a-saved-dashboard]] ==== Loading a Saved Dashboard -Click the *Load Saved Dashboard* button to display a list of existing dashboards. The saved dashboard selector includes a text field to filter by dashboard name and a link to the Object Editor, accessible through *Settings > Edit Saved -Objects*, to manage your saved dashboards. +Click the *Load Saved Dashboard* button to display a list of existing dashboards. The saved dashboard selector includes +a text field to filter by dashboard name and a link to the Object Editor for managing your saved dashboards. You can +also access the Object Editor by clicking *Settings > Edit Saved Objects*. [float] [[sharing-dashboards]] ==== Sharing Dashboards -Click the *Share* button to display HTML code to embed the dashboard in another Web page, along with a direct link to the dashboard. Click the copy button image:images/Clipboard.png[Copy to Clipboard button] next to either option to copy the code or the link to your clipboard. +You can share dashboards with other users. You can share a direct link to the Kibana dashboard or embed the dashboard +in your Web page. + +NOTE: A user must have Kibana access in order to view embedded dashboards. + +Click the *Share* button to display HTML code to embed the dashboard in another Web page, along with a direct link to +the dashboard. Click the copy button image:images/Clipboard.png[Copy to Clipboard button] next to either option to copy +the code or the link to your clipboard. [float] [[embedding-dashboards]] @@ -59,13 +70,12 @@ Click the *Share* button to display HTML code to embed the dashboard in another To embed a dashboard, copy the embed code from the _Share_ display into your external web application. -NOTE: A user must have Kibana access in order to view embedded dashboards. - [float] [[customizing-your-dashboard]] === Customizing Dashboard Elements -The visualizations in your dashboard are stored in _containers_. This section discusses customizing these containers. +The visualizations in your dashboard are stored in resizable _containers_ that you can arrange on the dashboard. This +section discusses customizing these containers. [float] [[moving-containers]] @@ -88,14 +98,15 @@ confirm the new container size. [[removing-containers]] ==== Removing Containers -Click the *x* icon at the top right corner of a container to remove that container from the dashboard. Removing a container from a dashboard does not affect the saved visualization in that container. +Click the *x* icon at the top right corner of a container to remove that container from the dashboard. Removing a +container from a dashboard does not delete the saved visualization in that container. [float] [[viewing-detailed-information]] ==== Viewing Detailed Information -To display the data that creates the visualization, click the bar at the bottom of the container. The raw data -replaces the visualization with four tabs with detailed information about the data, as in this example: +To display the raw data behind the visualization, click the bar at the bottom of the container. Tabs with detailed +information about the raw data replace the visualization, as in this example: [horizontal] *Table*:: A representation of the underlying data, presented as a paginated data grid. You can sort the items @@ -114,4 +125,5 @@ image:images/NYCTA-Statistics.png[] [[changing-the-visualization]] === Changing the Visualization -Click the _Edit_ button image:images/EditVis.png[Pencil button] at the top right of a container to open the visualization in the <> app. \ No newline at end of file +Click the _Edit_ button image:images/EditVis.png[Pencil button] at the top right of a container to open the +visualization in the <> page. \ No newline at end of file diff --git a/docs/images/tfl-dashboard.png b/docs/images/tfl-dashboard.png new file mode 100644 index 000000000000..6b90be538fb0 Binary files /dev/null and b/docs/images/tfl-dashboard.png differ diff --git a/docs/visualize.asciidoc b/docs/visualize.asciidoc index 8b2f4600281b..71f531005f3c 100644 --- a/docs/visualize.asciidoc +++ b/docs/visualize.asciidoc @@ -1,7 +1,7 @@ [[visualize]] == Visualize -You can use Kibana's _Visualize_ app to design and create data visualizations. You can save these visualizations, use +You can use the _Visualize_ page to design data visualizations. You can save these visualizations, use them individually, or combine visualizations into a _dashboard_. A visualization can be based on one of the following data source types: @@ -9,28 +9,25 @@ data source types: * A saved search * An existing saved visualization -Visualizations are based on the {ref}/search-aggregations.html[aggregation] feature introduced in Elasticsearch 1. +Visualizations rely on the {ref}/search-aggregations.html[aggregation] feature introduced in Elasticsearch 1. [float] [[getting-started]] === Creating a New Visualization -To start the New Visualization wizard, click on the *Visualize* tab at the top left of the screen. Alternately, you can -click the *New Visualization* button image:images/K4NewDocument.png[New Document button] in the toolbar panel to the -right of the search bar. The wizard guides you through the following steps: +To start the New Visualization wizard, click on the *Visualize* tab at the top left of the page. If you are already +creating a visualization, you can click the *New Visualization* button image:images/K4NewDocument.png[New Document +button] in the toolbar to the right of the search bar. The wizard guides you through the following steps: [float] [[newvis01]] ==== Step 1: Choose the Visualization Type -The New Visualization wizard starts with the following screen: +The New Visualization wizard starts with the following page: image:images/NewViz01.png[] -The data table, Markdown, and metric elements aren't visualizations, but all the elements on the list can be included -in a <>. - -You can also open a saved visualization that you created earlier. The saved visualization selector includes a text +You can also load a saved visualization that you created earlier. The saved visualization selector includes a text field to filter by visualization name and a link to the Object Editor, accessible through *Settings > Edit Saved Objects*, to manage your saved visualizations. @@ -42,9 +39,9 @@ selection. [[newvis02]] ==== Step 2: Choose a Data Source -You can choose a new or saved search to serve as the data source for your visualization. Searches are based on an -_index pattern_, which is a regular expression that matches the indices you want to visualize. After selecting _new -search_, select an index pattern from the drop-down to bring up the visualization editor. +You can choose a new or saved search to serve as the data source for your visualization. Searches are associated with +an index or a set of indexes. When you select _new search_ on a system with multiple indices configured, select an +index pattern from the drop-down to bring up the visualization editor. // How is this drop-down populated? Is it just a list of all indices in the cluster? Can I configure the contents? @@ -58,19 +55,19 @@ When you make changes to the search that is linked to the visualization, the vis The visualization editor enables you to configure and edit visualizations. The visualization editor has the following main elements: -image:images/VizEditor.png[] - -1. <> +1. <> 2. <> 3. <> +image:images/VizEditor.png[] + [float] [[toolbar-panel]] -===== Toolbar Panel +===== Toolbar -The toolbar panel has a search field for interactive data searches, as well as toolbars to manage saving and loading -visualizations. For visualizations based on saved searches, the search bar is initially disabled. Double-click the -grayed-out search field to enable interactive searching. +The toolbar has a search field for interactive data searches, as well as controls to manage saving and loading +visualizations. For visualizations based on saved searches, the search bar is grayed out. To edit the search, replacing +the saved search with the edited version, double-click the search field. // Why does it behave this way? I'd like to be able to say 'for saved searches interactive searches are disabled // because $REASONS'. @@ -83,20 +80,26 @@ the current visualization. [[aggregation-builder]] ===== Aggregation Builder -Use the aggregation builder on the left of the screen to configure the +Use the aggregation builder on the left of the page to configure the {ref}/search-aggregations.html#\_metrics_aggregations[metric] and {ref}/search-aggregations.html#\_bucket_aggregations[bucket] aggregations used in your visualization. Buckets are analogous to SQL `GROUP BY` statements. For more information on aggregations, see the main -{ref}/search-aggregations.html[Elasticsearch documentation]. +{ref}/search-aggregations.html[Elasticsearch aggregations reference]. -In bar or line chart visualizations, use _metric_ for the y-axis and _buckets_ are used for the x-axis, segment bar +In bar or line chart visualizations, use _metrics_ for the y-axis and _buckets_ are used for the x-axis, segment bar colors, and row/column splits. For pie charts, use the metric for the slice size and the bucket for the number of slices. // "Other visualizations may use these in new and different ways." < Such as? Would it be useful to add an appendix // on advanced visualizations or a cookbook of neat nonintuitive vis tricks? -Choose the metric aggregation for your visualization's Y axis, such as count, average, sum, min, max, or cardinality +Choose the metric aggregation for your visualization's Y axis, such as +{ref}/search-aggregations-metrics-valuecount-aggregation.html[count], +{ref}/search-aggregations-metrics-avg-aggregation.html[average], +{ref}/search-aggregations-metrics-sum-aggregation.html[sum], +{ref}/search-aggregations-metrics-min-aggregation.html[min], +{ref}/search-aggregations-metrics-max-aggregation.html[max], or +{ref}/search-aggregations-metrics-cardinality-aggregation.html[cardinality] (unique count). Use bucket aggregations for the visualization's X axis, color slices, and row/column splits. Common bucket aggregations include date histogram, range, terms, filters, and significant terms.