diff --git a/docs/dashboard.asciidoc b/docs/dashboard.asciidoc index d633a9e5d6139..b4311a84af9a7 100644 --- a/docs/dashboard.asciidoc +++ b/docs/dashboard.asciidoc @@ -3,150 +3,151 @@ [partintro] -- -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. +A Kibana _dashboard_ displays a collection of saved visualizations. You can +arrange and resize the visualizations as needed and save dashboards so +they be reloaded and shared. .Sample dashboard image:images/tutorial-dashboard.png[Example dashboard] -- [[dashboard-getting-started]] -== Getting Started +== Building a Dashboard -You need at least one saved <> to use a dashboard. +To build a dashboard: -[float] -[[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] +. Click *Dashboard* in the side navigation. If you haven't previously viewed a +dashboard, Kibana displays an empty dashboard. Otherwise, click *New* to start +building your dashboard. ++ +image:images/NewDashboard.png[New Dashboard] -Build your dashboard by adding visualizations. By default, Kibana dashboards use a light color theme. To use a dark color -theme instead, click the *Options* button and check the *Use dark theme* box. +[[adding-visualizations-to-a-dashboard]] +. To add a visualization to the dashboard, click *Add* and select the +visualization. If you have a large number of visualizations, you can enter a +*Filter* string to filter the list. ++ +Kibana displays the selected visualization in a container on the dashboard. +If you see a message that the container is too small, you can +<>. ++ +NOTE: By default, Kibana dashboards use a light color theme. To use a dark color theme, +click *Options* and select *Use dark theme*. To change the default theme, go +to *Management/Kibana/Advanced Settings* and set `dashboard:defaultDarkTheme` +to `true`. -NOTE: You can change the default theme in the *Advanced* section of the *Settings* tab. +[[saving-dashboards]] +. When you're done adding and arranging visualizations, click *Save* to save the +dashboard: +.. Enter a name for the dashboard. +.. To store the time period specified in the time filter with the dashboard, select +*Store time with dashboard*. +.. Click the *Save* button to store it as a Kibana saved object. [float] -[[dash-autorefresh]] -include::discover/autorefresh.asciidoc[] +[[customizing-your-dashboard]] +=== Arranging Dashboard Elements -[float] -[[adding-visualizations-to-a-dashboard]] -=== Adding Visualizations to a Dashboard +The visualizations in your dashboard are stored in resizable, moveable containers. -To add a visualization to the dashboard, click the *Add* button in the toolbar panel. Select a saved visualization -from the list. You can filter the list of visualizations by typing a filter string into the *Visualization Filter* -field. +[float] +[[moving-containers]] +==== Moving Visualizations -The visualization you select appears in a _container_ on your dashboard. +To reposition a visualization: -NOTE: If you see a message about the container's height or width being too small, <>. +. Hover over it to display the container controls. +. Click and hold the *Move* button in the upper right corner of the container. +. Drag the container to its new position. +. Release the *Move* button. [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. By default, dashboards store the time period specified in the time filter -when you save a dashboard. To disable this behavior, clear the *Store time with dashboard* box before clicking the -*Save* button. +[[resizing-containers]] +==== Resizing Visualizations -[float] -[[loading-a-saved-dashboard]] -=== Loading a Saved Dashboard +To resize a visualization: -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 > Objects*. +. Hover over it to display the container controls. +. Click and hold the *Resize* button in the bottom right corner of the container. +. Drag to change the dimensions of the container. +. Release the *Resize* button. [float] -[[sharing-dashboards]] -=== Sharing Dashboards - -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. +[[removing-containers]] +==== Removing Visualizations -To share a dashboard, click the *Share* button image:images/share-dashboard.png[] to display the _Sharing_ panel. +To remove a visualization from the dashboard: -Click the *Copy to Clipboard* button image:images/share-link.png[] to copy the native URL or embed HTML to the clipboard. -Click the *Generate short URL* button image:images/share-short-link.png[] to create a shortened URL for sharing or -embedding. +. Hover over it to display the container controls. +. Click the *Delete* button in the upper right corner of the container. ++ +NOTE: Removing a visualization from a dashboard does _not_ delete the +saved visualization. [float] -[[embedding-dashboards]] -=== Embedding Dashboards - -To embed a dashboard, copy the embed code from the _Share_ display into your external web application. +[[viewing-detailed-information]] +=== Viewing Visualization Data -[[customizing-your-dashboard]] -== Customizing Dashboard Elements +To display the raw data behind a visualization: -The visualizations in your dashboard are stored in resizable _containers_ that you can arrange on the dashboard. This -section discusses customizing these containers. +. Hover over it to display the container controls. +. Click the *Expand* button in the lower left corner of the container. +This displays a table that contains the underlying data. You can also view +the raw Elasticsearch request and response in JSON and the request statistics. +The request statistics show the query duration, request duration, total number +of matching records, and the index (or index pattern) that was searched. ++ +image:images/NYCTA-Table.jpg[] -[float] -[[moving-containers]] -=== Moving Containers +To export the data behind the visualization as a comma-separated-values +(CSV) file, click the *Raw* or *Formatted* link at the bottom of the data +Table. *Raw* exports the data as it is stored in Elasticsearch. *Formatted* +exports the results of any applicable Kibana <>. -Click and hold a container's header to move the container around the dashboard. Other containers will shift as needed -to make room for the moving container. Release the mouse button to confirm the container's new location. +To return to the visualization, click the *Collapse* button in the lower left +corner of the container. [float] -[[resizing-containers]] -=== Resizing Containers +[[changing-the-visualization]] +=== Modifying a Visualization -Move the cursor to the bottom right corner of the container until the cursor changes to point at the corner. After the -cursor changes, click and drag the corner of the container to change the container's size. Release the mouse button to -confirm the new container size. +To open a visualization in the Visualization Editor: -[float] -[[removing-containers]] -=== Removing Containers +. Hover over it to display the container controls. +. Click the *Edit* button in the upper right corner of the 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 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: +[[loading-a-saved-dashboard]] +== Loading a Dashboard -.Table -A representation of the underlying data, presented as a paginated data grid. You can sort the items -in the table by clicking on the table headers at the top of each column. -image:images/NYCTA-Table.jpg[] +To open a saved dashboard: -.Request -The raw request used to query the server, presented in JSON format. -image:images/NYCTA-Request.jpg[] +. Click *Dashboard* in the side navigation. +. Click *Open* and select a dashboard. If you have a large number of +dashboards, you can enter a *Filter* string to filter the list. ++ +TIP: To import, export, and delete dashboards, click the *Manage Dashboards* link +to open *Management/Kibana/Saved Objects/Dashboards*. -.Response -The raw response from the server, presented in JSON format. -image:images/NYCTA-Response.jpg[] +[[sharing-dashboards]] +== Sharing a Dashboard -.Statistics -A summary of the statistics related to the request and the response, presented as a data grid. The data -grid includes the query duration, the request duration, the total number of records found on the server, and the -index pattern used to make the query. -image:images/NYCTA-Statistics.jpg[] +You can can share a direct link to a Kibana dashboard with another user, +or embed the dashboard in a web page. Users must have Kibana access +to view embedded dashboards. -To export the raw data behind the visualization as a comma-separated-values (CSV) file, click on either the -*Raw* or *Formatted* links at the bottom of any of the detailed information tabs. A raw export contains the data as it -is stored in Elasticsearch. A formatted export contains the results of any applicable Kibana [field formatters]. +[[embedding-dashboards]] +To share a dashboard: -[[changing-the-visualization]] -== Changing the Visualization +. Click *Dashboard* in the side navigation. +. Open the dashboard you want to share. +. Click *Share*. +. Copy the link you want to share or the iframe you want to embed. You can +share the live dashboard or a static snapshot of the current point in time. ++ +TIP: When sharing a link to a dashboard snapshot, use the *Short URL*. Snapshot +URLs are long and can be problematic for Internet Explorer users and other +tools. -Click the _Edit_ button image:images/EditVis.png[Pencil button] at the top right of a container to open the -visualization in the <> page. -[float] -[[dashboard-filters]] -include::discover/filter-pinning.asciidoc[] diff --git a/docs/images/NYCTA-Request.jpg b/docs/images/NYCTA-Request.jpg deleted file mode 100644 index f3467872ba48e..0000000000000 Binary files a/docs/images/NYCTA-Request.jpg and /dev/null differ diff --git a/docs/images/NYCTA-Response.jpg b/docs/images/NYCTA-Response.jpg deleted file mode 100644 index 88a02704de766..0000000000000 Binary files a/docs/images/NYCTA-Response.jpg and /dev/null differ diff --git a/docs/images/NYCTA-Statistics.jpg b/docs/images/NYCTA-Statistics.jpg deleted file mode 100644 index 58f3a3af8885b..0000000000000 Binary files a/docs/images/NYCTA-Statistics.jpg and /dev/null differ diff --git a/docs/images/NewDashboard.png b/docs/images/NewDashboard.png index 89e816c0458ae..08e5159250134 100644 Binary files a/docs/images/NewDashboard.png and b/docs/images/NewDashboard.png differ diff --git a/docs/images/share-dashboard.png b/docs/images/share-dashboard.png deleted file mode 100644 index 3977a31e6d854..0000000000000 Binary files a/docs/images/share-dashboard.png and /dev/null differ diff --git a/docs/images/share-link.png b/docs/images/share-link.png deleted file mode 100644 index 8e91504584160..0000000000000 Binary files a/docs/images/share-link.png and /dev/null differ