[DOCS|Dashboard] Updated images and text to match UI #19149
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,163 +3,113 @@ | |
|
|
||
| [partintro] | ||
| -- | ||
| A Kibana _dashboard_ displays a collection of visualizations and searches. | ||
| You can arrange, resize, and edit the dashboard content and then save the dashboard | ||
| so you can share it. | ||
|
|
||
| [role="screenshot"] | ||
| image:images/Dashboard_example.png[Example dashboard] | ||
|
|
||
| -- | ||
|
|
||
| [[dashboard-getting-started]] | ||
| == Building a Dashboard | ||
|
|
||
| . In the side navigation, click *Dashboard*. | ||
| . Click *Create new dashboard.* | ||
| . Click *Add*. | ||
|
|
||
| [[adding-visualizations-to-a-dashboard]] | ||
| . To add a visualization, select its name from the list of visualizations | ||
| or click *Add new visualization* to create one. | ||
| If you have a large number of visualizations, you can filter the list. | ||
| + | ||
| [role="screenshot"] | ||
| image:images/Dashboard_add_visualization.png[Example add visualization to dashboard] | ||
|
|
||
| . To add a saved search, click the *Saved Search* tab, and then select a name from the list. | ||
|
|
||
| [[saving-dashboards]] | ||
| . When you're finished adding and arranging the dashboard content, | ||
| go to the menu bar, click *Save*, and enter | ||
| a name. Optionally, you can store the time period specified in the time | ||
| filter by selecting *Store time with dashboard*. | ||
|
|
||
| By default, Kibana dashboards use a light color theme. To use a dark color theme, | ||
| click *Options* and select *Use dark theme*. To set the dark theme as the default, go | ||
| to *Management > Advanced Settings* and set `dashboard:defaultDarkTheme` | ||
| to `On`. | ||
|
|
||
| [[loading-a-saved-dashboard]] | ||
| TIP: You can import, export, and delete dashboards in *Kibana > Management > | ||
| Saved Objects > Dashboards*. | ||
|
|
||
| [[customizing-your-dashboard]] | ||
| == Arranging Dashboard Elements | ||
|
|
||
| The visualizations and searches in a dashboard are stored in panels that you can move, | ||
| resize, and delete. To start editing, open the dashboard and click *Edit* | ||
| in the menu bar. | ||
|
|
||
| [role="screenshot"] | ||
| image:images/Dashboard_Resize_Menu.png[Example dashboard] | ||
|
|
||
| [[moving-containers]] | ||
| To move a panel, click and hold the | ||
| header of a panel and drag to the new location. | ||
|
|
||
| [[resizing-containers]] | ||
| To resize a panel, click the resize control on the lower right and drag | ||
| to the new dimensions. | ||
|
|
||
| [[removing-containers]] | ||
| Additional commands for managing the | ||
| panel and its contents are in the gear menu in the upper right. | ||
|
|
||
| NOTE: Deleting a panel from a | ||
| dashboard does *not* delete the saved visualization or search. | ||
|
|
||
| [[viewing-detailed-information]] | ||
| == Viewing Visualization Data | ||
|
|
||
| You can display the raw data behind a dashboard visualization using the | ||
| Expand/Collapse button. | ||
|
|
||
| . Open the dashboard. | ||
| . Hover over the visualization and click the *Expand* button in the lower | ||
| left. | ||
| + | ||
| The underlying data is displayed in a table. You can also view | ||
| the raw Elasticsearch request, the response in JSON, and the request statistics. | ||
| These statistics show the query duration, request duration, total number | ||
| of matching records, and the index that was searched. | ||
| + | ||
| [role="screenshot"] | ||
| image:images/Dashboard_visualization_data.png[Example of visualization data] | ||
|
|
||
| To export the data as a comma separated values | ||
|
There was a problem hiding this comment. I think this is very misleading - you are not exporting the raw documents as stored in elasticsearch, you are only exporting the raw aggregation results as returned from the API call. Maybe something like There was a problem hiding this comment. Hm. I thought it was pretty clear that by "raw data", she meant the data that was fed into the aggregation, not the original docs themselves, e.g. the aggregation data. Maybe, instead of "raw data", it should say something like: "To export the visualization data" or "To export the aggregated data displayed in a visualization..." Dunnoes. Writing is hard. |
||
| (CSV) file, click *Raw* or *Formatted* at the bottom of the data | ||
| table. *Raw* exports the response data as provided. *Formatted* | ||
| exports the reponse data using applicable Kibana <<managing-fields,field | ||
| formatters>>. | ||
|
|
||
| To return to the visualization, click the *Collapse* button in the lower left | ||
| corner. | ||
|
|
||
| [[sharing-dashboards]] | ||
| == Sharing a Dashboard | ||
|
|
||
| You can either share a direct link to a Kibana dashboard, | ||
| or embed the dashboard in a web page. Users must have Kibana access | ||
| to view an embedded dashboard. | ||
|
|
||
| [[embedding-dashboards]] | ||
|
|
||
| . Open the dashboard you want to share. | ||
| . In the menu bar, 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 | ||
|
There was a problem hiding this comment. A common thing that trips people up is that users must have write access to .kibana to create short urls. May be worth calling out. Another thing that might be worth calling out that isn't exposed in the UI at all but many people find handy is that you can create a link to a dashboard by title, by doing this:
It's not exposed in the UI because we can't figure out how to communicate it properly (maybe you will have some ideas!). Because it's just linked by title and not id, changing titles on dashboards can change the link. So you can't really say "link to this dashboard" because that might not be true later down the road. Here is the PR it was implemented : #14760 |
||
| URLs are long and can be problematic for Internet Explorer and other | ||
| tools. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is going to be changing for 6.4 so that this functionality is exposed in the gear menu. Fine to leave it like this for now, but I want to point out that not all visualizations support it. Right now, in 6.3, no time series visual builder visualizations show it. Maybe not vega/timelion... I'd have to check. Not a huge deal, but might want to add a caveat like "If supported ...."
A lot of stuff will be going that route. When we have "Create Machine Learning Job" it'll only be for certain embeddables. I don't have a good generic term for embeddables. Right now it's only saved searches and visualizations, but it could eventually be more. In addition, even for one embeddable type (like our visualizations), panel options can change based on the visualization sub type.
I'm not opposed to just calling them visualizations because I think that is a nice generic term in itself, but it's overloaded because right now when we say visualizations we mean a specific embeddable type. 🤷♀️