mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
# Backport This will backport the following commits from `main` to `8.x`: - [[Discover] Rename Saved Search to Discover Session (#202217)](https://github.com/elastic/kibana/pull/202217) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Julia Rechkunova","email":"julia.rechkunova@elastic.co"},"sourceCommit":{"committedDate":"2024-12-18T12:45:32Z","message":"[Discover] Rename Saved Search to Discover Session (#202217)\n\n- Closes https://github.com/elastic/kibana/issues/174144\r\n\r\n## Summary\r\n\r\nThis PR renames Saved Search into Discover Session in UI.\r\n\r\n- [x] Discover\r\n- [x] Saved Objects page and modal\r\n- [x] Docs\r\n- [x] Other occurrences \r\n\r\n<img width=\"810\" alt=\"Screenshot 2024-12-16 at 15 20 10\"\r\nsrc=\"https://github.com/user-attachments/assets/e39083da-f496-4ed5-bbdc-8e184897fc41\"\r\n/>\r\n<img width=\"1220\" alt=\"Screenshot 2024-12-11 at 14 40 15\"\r\nsrc=\"https://github.com/user-attachments/assets/a6dc3e29-e1a5-4304-8148-0108231cc9de\"\r\n/>\r\n<img width=\"1476\" alt=\"Screenshot 2024-12-16 at 14 57 39\"\r\nsrc=\"https://github.com/user-attachments/assets/4b34c70e-e21a-4d82-85f2-f5a3cb7a3826\"\r\n/>\r\n\r\n\r\n### Checklist\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] The PR description includes the appropriate Release Notes section,\r\nand the correct `release_note:*` label is applied per the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by: wajihaparvez <wajiha.parvez@elastic.co>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>\r\nCo-authored-by: Julia Bardi <90178898+juliaElastic@users.noreply.github.com>","sha":"40c90550f12f99f23e6b7d545c7427e30d648dab","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:enhancement","Team:Fleet","v9.0.0","Team:DataDiscovery","backport:prev-minor","ci:project-deploy-observability"],"number":202217,"url":"https://github.com/elastic/kibana/pull/202217","mergeCommit":{"message":"[Discover] Rename Saved Search to Discover Session (#202217)\n\n- Closes https://github.com/elastic/kibana/issues/174144\r\n\r\n## Summary\r\n\r\nThis PR renames Saved Search into Discover Session in UI.\r\n\r\n- [x] Discover\r\n- [x] Saved Objects page and modal\r\n- [x] Docs\r\n- [x] Other occurrences \r\n\r\n<img width=\"810\" alt=\"Screenshot 2024-12-16 at 15 20 10\"\r\nsrc=\"https://github.com/user-attachments/assets/e39083da-f496-4ed5-bbdc-8e184897fc41\"\r\n/>\r\n<img width=\"1220\" alt=\"Screenshot 2024-12-11 at 14 40 15\"\r\nsrc=\"https://github.com/user-attachments/assets/a6dc3e29-e1a5-4304-8148-0108231cc9de\"\r\n/>\r\n<img width=\"1476\" alt=\"Screenshot 2024-12-16 at 14 57 39\"\r\nsrc=\"https://github.com/user-attachments/assets/4b34c70e-e21a-4d82-85f2-f5a3cb7a3826\"\r\n/>\r\n\r\n\r\n### Checklist\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] The PR description includes the appropriate Release Notes section,\r\nand the correct `release_note:*` label is applied per the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by: wajihaparvez <wajiha.parvez@elastic.co>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>\r\nCo-authored-by: Julia Bardi <90178898+juliaElastic@users.noreply.github.com>","sha":"40c90550f12f99f23e6b7d545c7427e30d648dab"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/202217","number":202217,"mergeCommit":{"message":"[Discover] Rename Saved Search to Discover Session (#202217)\n\n- Closes https://github.com/elastic/kibana/issues/174144\r\n\r\n## Summary\r\n\r\nThis PR renames Saved Search into Discover Session in UI.\r\n\r\n- [x] Discover\r\n- [x] Saved Objects page and modal\r\n- [x] Docs\r\n- [x] Other occurrences \r\n\r\n<img width=\"810\" alt=\"Screenshot 2024-12-16 at 15 20 10\"\r\nsrc=\"https://github.com/user-attachments/assets/e39083da-f496-4ed5-bbdc-8e184897fc41\"\r\n/>\r\n<img width=\"1220\" alt=\"Screenshot 2024-12-11 at 14 40 15\"\r\nsrc=\"https://github.com/user-attachments/assets/a6dc3e29-e1a5-4304-8148-0108231cc9de\"\r\n/>\r\n<img width=\"1476\" alt=\"Screenshot 2024-12-16 at 14 57 39\"\r\nsrc=\"https://github.com/user-attachments/assets/4b34c70e-e21a-4d82-85f2-f5a3cb7a3826\"\r\n/>\r\n\r\n\r\n### Checklist\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] The PR description includes the appropriate Release Notes section,\r\nand the correct `release_note:*` label is applied per the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by: wajihaparvez <wajiha.parvez@elastic.co>\r\nCo-authored-by: Davis McPhee <davismcphee@hotmail.com>\r\nCo-authored-by: Julia Bardi <90178898+juliaElastic@users.noreply.github.com>","sha":"40c90550f12f99f23e6b7d545c7427e30d648dab"}}]}] BACKPORT-->
312 lines
12 KiB
Text
312 lines
12 KiB
Text
= Panels and visualizations
|
||
|
||
{kib} provides many options to create panels with visualizations of your data and add content to your dashboards. From advanced charts, maps, and metrics to plain text and images, multiple types of panels with different capabilities are available.
|
||
|
||
Use one of the editors to create visualizations of your data. Each editor offers various capabilities.
|
||
|
||
[[panels-editors]]
|
||
[cols="3", options="header"]
|
||
|===
|
||
|
||
| **Content** | **Panel type** | **Description**
|
||
|
||
.5+| Visualizations
|
||
| <<lens,Lens>>
|
||
| The default editor for creating powerful <<chart-types,charts>> in {kib}
|
||
|
||
| link:{ref}/esql-kibana.html[ES\|QL]
|
||
| Create visualizations from ES\|QL queries
|
||
|
||
| <<maps,Maps>>
|
||
| Create beautiful displays of your geographical data
|
||
|
||
| <<field-statistics-dashboard,Field statistics>>
|
||
| Add a field statistics view of your data to your dashboards
|
||
|
||
| <<vega, Custom visualizations>>
|
||
| Use Vega to create new types of visualizations
|
||
|
||
.3+| Annotations and navigation
|
||
| <<add-text,Text>>
|
||
| Add context to your dashboard with markdown-based *text*
|
||
|
||
| <<add-image,Image>>
|
||
| Personalize your dashboard with custom images
|
||
|
||
| <<dashboard-links,Links>>
|
||
| Add links to other dashboards or to external websites
|
||
|
||
.4+| Machine Learning and Analytics
|
||
| <<xpack-ml-anomalies,Anomaly swim lane>>
|
||
| Display the results from machine learning anomaly detection jobs
|
||
|
||
| <<xpack-ml-anomalies,Anomaly chart>>
|
||
| Display an anomaly chart from the *Anomaly Explorer*
|
||
|
||
| <<xpack-ml-anomalies,Single metric viewer>>
|
||
| Display an anomaly chart from the *Single Metric Viewer*
|
||
|
||
| <<change-point-detection,Change point detection>>
|
||
| Display a chart to visualize change points in your data
|
||
|
||
.3+| Observability
|
||
| link:{observability-guide}/slo.html[SLO overview]
|
||
| Visualize a selected SLO’s health, including name, current SLI value, target, and status
|
||
|
||
| link:{observability-guide}/slo.html[SLO Alerts]
|
||
| Visualize one or more SLO alerts, including status, rule name, duration, and reason. In addition, configure and update alerts, or create cases directly from the panel
|
||
|
||
| link:{observability-guide}/slo.html[SLO Error Budget]
|
||
| Visualize the consumption of your SLO's error budget
|
||
|
||
.3+| Legacy
|
||
| <<logs-app,Log stream>> (deprecated)
|
||
| Display a table of live streaming logs
|
||
|
||
| <<add-aggregation-based-visualization-panels,Aggregation based>>
|
||
.2+| While these panel types are still available, we recommend to use <<lens,Lens>>
|
||
|
||
| <<tsvb-panel,TSVB>>
|
||
|
||
|===
|
||
|
||
include::chart-types.asciidoc[]
|
||
|
||
[[manage-panels]]
|
||
== Manage panels
|
||
When creating a panel, you can choose to add it to a dashboard, or to save it to the Visualize Library so it can be added to multiple dashboards later.
|
||
|
||
There are also some common options that you can configure on the various types of panels to make a dashboard easier to navigate and analyze.
|
||
|
||
[float]
|
||
[[save-the-markdown-panel]]
|
||
[[save-to-visualize-library]]
|
||
=== Save to the Visualize Library
|
||
|
||
To use a panel on multiple dashboards, you can save it to the *Visualize Library*. Any updates made to a shared panel are replicated to all dashboards where the panel is added.
|
||
//When panels are saved in the *Visualize Library*, image:dashboard/images/visualize-library-icon.png[Visualize Library icon] appears in the panel header.
|
||
|
||
If you created the panel from a dashboard:
|
||
|
||
. In the editor, click *Save to library*.
|
||
|
||
. Enter the *Title* and add any applicable <<managing-tags,*Tags*>>.
|
||
|
||
. Select *Add to Dashboards after saving* to add the panel to your dashboard at the same time.
|
||
|
||
. Click *Save and return*.
|
||
|
||
If you created the panel from the *Visualize Library*:
|
||
|
||
. In the editor, click *Save*.
|
||
|
||
. On the *Save* window, enter the *Title*.
|
||
|
||
. Choose one of the following options:
|
||
|
||
* To save the panel to a dashboard and the *Visualize Library*, select *Add to library*, add any applicable <<managing-tags,*Tags*>>, then click *Save and go to Dashboard*.
|
||
|
||
* To save the panel only to the *Visualize Library*, select *None*, add any applicable <<managing-tags,*Tags*>>, then click *Save and add to library*.
|
||
|
||
To add unsaved dashboard panels to the *Visualize Library*:
|
||
|
||
. Open the panel menu, then select *More > Save to library*.
|
||
|
||
. Enter the panel title, then click *Save*.
|
||
|
||
[float]
|
||
[[save-to-the-dashboard]]
|
||
=== Save to the dashboard
|
||
|
||
Return to the dashboard and add the panel without specifying the save options or adding the panel to the *Visualize Library*.
|
||
|
||
If you created the panel from a dashboard:
|
||
|
||
. In the editor, click *Save and return*.
|
||
|
||
. Add an optional title to the panel.
|
||
|
||
.. In the panel header, click *No Title*.
|
||
|
||
.. On the *Panel settings* window, select *Show title*.
|
||
|
||
.. Enter the *Title*, then click *Save*.
|
||
|
||
If you created the panel from the *Visualize Library*:
|
||
|
||
. Click *Save*.
|
||
|
||
. On the *Save* window, add a *Title* to name the visualization.
|
||
|
||
. Choose one of the following options:
|
||
|
||
* If you want to add the panel to an existing dashboard, select *Existing*, select the dashboard from the dropdown, then click *Save and go to Dashboard*.
|
||
|
||
* If you want to add the panel to a new dashboard, select *New*, then click *Save and go to Dashboard*.
|
||
|
||
[[explore-the-underlying-documents]]
|
||
=== Link to Discover
|
||
|
||
You can add interactions to panels that allow you to open and explore the data in *Discover*. To use the interactions, the panel must use only one data view.
|
||
|
||
There are three types of *Discover* interactions you can add to dashboard panels:
|
||
|
||
* *Panel interactions* — Opens panel data in *Discover*, including the dashboard-level filters, but not the panel-level filters.
|
||
+
|
||
To enable panel interactions, configure <<settings-explore-data-in-context,`xpack.discoverEnhanced.actions.exploreDataInContextMenu.enabled`>> in kibana.yml. If you are using 7.13.0 and earlier, panel interactions are enabled by default.
|
||
+
|
||
To use panel interactions, open the panel menu, then click *Explore underlying data*.
|
||
|
||
* *Series data interactions* — Opens the series data in *Discover*.
|
||
+
|
||
To enable series data interactions, configure <<settings-explore-data-in-chart,`xpack.discoverEnhanced.actions.exploreDataInChart.enabled`>> in kibana.yml. If you are using 7.13.0 and earlier, data series interactions are enabled by default.
|
||
+
|
||
To use series data interactions, click a data series in the panel.
|
||
|
||
* *Discover session interactions* — Opens <<save-your-search,saved Discover session>> data in *Discover*.
|
||
+
|
||
To use saved Discover session interactions, open the panel menu, then click *More > View Discover session*.
|
||
|
||
[[edit-panels]]
|
||
=== Edit panels
|
||
|
||
To make changes to the panel, use the panel menu options.
|
||
|
||
. In the toolbar, click *Edit*.
|
||
|
||
. Open the panel menu, then use the following options:
|
||
|
||
* *Edit visualization* — Opens the editor so you can make changes to the panel.
|
||
+
|
||
To make changes without changing the original version, open the panel menu, then click *More > Unlink from library*.
|
||
|
||
* *Convert to Lens* — Opens *TSVB* and aggregation-based visualizations in *Lens*.
|
||
|
||
* *Settings* — Opens the *Settings* window to change the *title*, *description*, and *time range*.
|
||
|
||
* *More > Replace panel* — Opens the *Visualize Library* so you can select a new panel to replace the existing panel.
|
||
|
||
* *More > Delete from dashboard* — Removes the panel from the dashboard.
|
||
+
|
||
If you want to use the panel later, make sure that you save the panel to the *Visualize Library*.
|
||
|
||
|
||
|
||
include::lens.asciidoc[leveloffset=-1]
|
||
|
||
[[esql-visualizations]]
|
||
== ES|QL visualizations
|
||
|
||
You can add ES|QL visualizations to a dashboard directly from queries in Discover, or you can start from a dashboard.
|
||
|
||
[float]
|
||
=== Edit and add from Discover
|
||
|
||
In Discover, {ref}/esql-kibana.html[typing ES|QL queries] automatically shows a visualization. The visualization type depends on the content of the query: histogram, bar charts, etc. You can manually make changes to that visualization and edit its type and display options using the
|
||
pencil button image:images/esql-icon-edit-visualization.svg[pencil button].
|
||
|
||
You can then **Save** and add it to an existing or a new dashboard using the save button of the visualization image:images/esql-icon-save-visualization.svg[save button].
|
||
|
||
[float]
|
||
=== Create from dashboard
|
||
|
||
. From your dashboard, select **Add panel**.
|
||
. Choose **ES|QL** under **Visualizations**. An ES|QL editor appears and lets you configure your query and its associated visualization. The **Suggestions** panel can help you find alternative ways to configure the visualization.
|
||
+
|
||
TIP: Check the link:{ref}/esql-language.html[ES|QL reference] to get familiar with the syntax and optimize your query.
|
||
. When editing your query or its configuration, run the query to update the preview of the visualization.
|
||
+
|
||
image:https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt69dcceb4f1e12bc1/66c752d6aff77d384dc44209/edit-esql-visualization.gif[Previewing an ESQL visualization]
|
||
. Select **Apply and close** to save the visualization to the dashboard.
|
||
|
||
[[maps-visualizations]]
|
||
== Maps
|
||
|
||
The Maps editor has extensive documentation. For your reading comfort, we have moved it to <<maps,this section>>.
|
||
|
||
[[field-statistics-dashboard]]
|
||
== Field statistics
|
||
|
||
**Field statistics** panels allow you to display a table with additional field information in your dashboards, such as document count, values, and distribution.
|
||
|
||
. From your dashboard, select **Add panel**.
|
||
. Choose **Field statistics** under **Visualizations**. An ES|QL editor appears and lets you configure your query with the fields and information that you want to show.
|
||
+
|
||
TIP: Check the link:{ref}/esql-language.html[ES|QL reference] to get familiar with the syntax and optimize your query.
|
||
. When editing your query or its configuration, run the query to update the preview of the visualization.
|
||
+
|
||
image:https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte2b1371159f5b9ff/66fc6ca13804eb2532b20727/field-statistics-preview-8.16.0.gif[Editing a field statistics dashboard panel and running the query to update the preview]
|
||
. Select **Apply and close** to save the visualization to the dashboard.
|
||
|
||
include::vega.asciidoc[leveloffset=-1]
|
||
|
||
[[add-text]]
|
||
== Text panels
|
||
|
||
To provide context to your dashboard panels, add *Text* panels that display important information, instructions, images, and more. You can create *Text* panels using GitHub-flavored Markdown text.
|
||
|
||
. From your dashboard, select *Add panel*.
|
||
|
||
. In the *Add panel* flyout, select *Text*. A Markdown editor appears and lets you configure the information you want to display.
|
||
|
||
. In the *Markdown* field, enter your text, then click *Update*.
|
||
|
||
For example, when you enter:
|
||
|
||
[role="screenshot"]
|
||
image::images/markdown_example_1.png[Markdown text with links]
|
||
|
||
The following instructions are displayed:
|
||
|
||
[role="screenshot"]
|
||
image::images/markdown_example_2.png[Panel with markdown link text]
|
||
|
||
Or when you enter:
|
||
|
||
[role="screenshot"]
|
||
image::images/markdown_example_3.png[Markdown text with image file]
|
||
|
||
The following image is displayed:
|
||
|
||
[role="screenshot"]
|
||
image::images/markdown_example_4.png[Panel with markdown image]
|
||
|
||
For detailed information about writing on GitHub, click *Help* on the top-right of the Markdown editor.
|
||
|
||
|
||
|
||
[[add-image]]
|
||
== Image panels
|
||
|
||
To personalize your dashboards, add your own logos and graphics with the *Image* panel. You can upload images from your computer, select previously uploaded images, or add images from an external link.
|
||
|
||
. From your dashboard, select *Add panel*.
|
||
|
||
. In the *Add panel* flyout, select *Image*. The *Add image* flyout appears and lets you add and configure the image you want to display.
|
||
|
||
. Add your image and configure the settings, and then click *Save*.
|
||
|
||
[role="screenshot"]
|
||
image::images/dashboard_addImageEditor_8.7.0.png[Add image editor]
|
||
|
||
To manage your uploaded image files, go to the *Files* management page using the navigation menu or the
|
||
<<kibana-navigation-search,global search field>>.
|
||
|
||
|
||
[WARNING]
|
||
============================================================================
|
||
When you export a dashboard, the uploaded image files are not exported.
|
||
When importing a dashboard with an image panel, and the image file is unavailable, the image panel displays a `not found` warning. Such panels have to be fixed manually by re-uploading the image using the panel's image editor.
|
||
============================================================================
|
||
|
||
include::links-panel.asciidoc[leveloffset=-1]
|
||
|
||
[[legacy-editors]]
|
||
== Legacy editors
|
||
|
||
include::aggregation-based.asciidoc[]
|
||
|
||
include::tsvb.asciidoc[]
|
||
|
||
include::timelion.asciidoc[]
|
||
|