Skip to content

Commit 6a67222

Browse files
Discover first 20 lines optimization (#4082)
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> This PR updates the page opening of all Discover docs pages. In particular: - Check that the frontmatter is correct and contains the right metadata - More generally, frontmatter is often missing an intentional description in many docs files - Optimized H1 - Optimized page intro based on basic content types (tutorial/explanation/guide/reference) that provides better context and sets better expectations These changes follow instructions provided to AI following an onweek project: https://github.com/florent-leborgne/mi-instructions ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). --> Tool(s) and model(s) used: Cursor with Claude Sonnet 4.5
1 parent 077b78f commit 6a67222

File tree

10 files changed

+75
-51
lines changed

10 files changed

+75
-51
lines changed

explore-analyze/discover.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,52 @@ applies_to:
66
serverless: ga
77
products:
88
- id: kibana
9+
description: Use Discover to search and filter documents, analyze field structures, visualize patterns, and save findings to reuse later or share with dashboards.
910
---
1011

1112
# Discover [discover]
1213

13-
You have questions about your data. What pages on your website contain a specific word or phrase? What events were logged most recently? What processes take longer than 500 milliseconds to respond?
14-
15-
$$$save-your-search$$$
16-
With **Discover**, you can quickly search and filter your data, get information about the structure of the fields, and display your findings in a visualization. You can also customize and save your Discover sessions and place them on a dashboard.
14+
**Discover** is the primary tool for exploring your {{product.elasticsearch}} data in {{product.kibana}}. Search and filter documents, analyze field structures, visualize patterns, and save findings to reuse later or share with dashboards. Whether investigating issues, analyzing trends, or validating data quality, **Discover** offers a flexible interface for understanding your data.
1715

1816
:::{image} /explore-analyze/images/kibana-hello-field.png
1917
:alt: A view of the Discover app
2018
:screenshot:
2119
:::
2220

21+
## What you can do with Discover
22+
23+
**Search and explore**
24+
: Search through your data using KQL, Lucene, or {{esql}}. Filter results to focus on what matters. Discover adapts its interface based on the type of data you're exploring, providing specialized experiences for logs, metrics, and other data types.
25+
26+
**Analyze fields and documents**
27+
: View field statistics, examine individual documents, compare multiple documents side by side, and find patterns in your log data.
28+
29+
**Visualize on the fly**
30+
: Create quick visualizations from aggregatable fields, or use {{esql}} to build charts directly from your queries.
31+
32+
**Save and share**
33+
: Save your Discover sessions to reuse later, add them to dashboards, or share them with your team. You can also generate reports and create alerts based on your searches.
34+
35+
## Get started
36+
37+
New to Discover? Start with these resources:
38+
39+
* **[Get started with Discover](discover/discover-get-started.md)** - A hands-on tutorial that walks you through exploring data, from loading data to filtering and visualizing your findings.
40+
* **[Using {{esql}}](discover/try-esql.md)** - Learn how to use the {{es}} Query Language for powerful data exploration.
41+
42+
## Common tasks
43+
44+
Once you're familiar with the basics, explore these guides for specific tasks:
45+
46+
* **[Search and filter data](discover/discover-get-started.md)** - Build queries and apply filters to narrow down your results.
47+
* **[Customize the Discover view](discover/document-explorer.md)** - Adjust the layout, columns, and display options to suit your needs.
48+
* **[Save a search for reuse](discover/save-open-search.md)** - Save your Discover sessions and add them to dashboards.
49+
50+
## Advanced features
51+
52+
The following guides cover additional features you can use in Discover:
53+
54+
* [Add runtime fields to your {{data-source}}](discover/discover-get-started.md#add-field-in-discover)
55+
* [Run queries in the background](discover/background-search.md)
56+
* [Analyze field statistics and patterns](discover/run-pattern-analysis-discover.md)
57+
* [Search for relevance](discover/discover-search-for-relevance.md)

explore-analyze/discover/background-search.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,19 @@ applies_to:
77
serverless: unavailable
88
products:
99
- id: kibana
10-
description: Send your long-running queries to run in the background with background searches and search sessions, and focus on your other tasks while they complete.
10+
description: Send long-running queries to run in the background with background searches from Discover and Dashboards. Continue working while queries complete and access results later.
1111
---
1212

13-
# Run Discover and Dashboards queries in the background
13+
# Run Discover and Dashboards queries in the background [background-search]
14+
15+
Send long-running searches to run asynchronously while you continue working in {{product.kibana}}. Access your completed searches later from **Discover** or **Dashboards**, and manage all background searches from the toolbar.
1416

1517
::::{important} - Background search replaces Search sessions
1618

1719
Background search is a feature introduced in version 9.2. It replaces the deprecated **Search sessions** feature.
1820
If you have been using search sessions and upgrade to 9.2, your search sessions aren't lost and become background searches.
1921
::::
2022

21-
Sometimes you might need to search through large amounts of data, no matter how long the search takes. Consider a threat hunting scenario, where you need to search through years of data.
22-
23-
You can send your long-running searches to the background from **Discover** or **Dashboards** and let them run while you continue your work.
24-
25-
You can access your list of background searches at any time to check their status and manage them from the {icon}`background_task` **Background searches** button in the toolbar.
26-
2723
![Send search to background](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/bltee31dcf0d3917c75/68ecf412e5bae49d65a286ff/background-search.gif " =75%")
2824

2925

@@ -51,7 +47,7 @@ To send searches to the background, and to view and interact with the list of ba
5147
:sync: 91
5248
In versions 9.1 and earlier, this feature is named **Search sessions**.
5349
* To save a session, you must have permissions for **Discover** and **Dashboard**, and the [Search sessions subfeature](../../deploy-manage/users-roles/cluster-or-deployment-auth/kibana-privileges.md#kibana-feature-privileges).
54-
* To view and restore a saved session, you must have access to **Stack Management**.
50+
* To view and restore a saved session, you must have access to {{stack-manage-app}}.
5551
::::
5652

5753
:::::

explore-analyze/discover/discover-get-started.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,12 @@ applies_to:
66
serverless: ga
77
products:
88
- id: kibana
9+
description: Step-by-step tutorial for exploring data with Discover by selecting data views, filtering documents, analyzing fields, and creating visualizations using sample or your own data.
910
---
1011

1112
# Explore fields and data with Discover [discover-get-started]
1213

13-
Learn how to use **Discover** to:
14-
15-
* **Select** and **filter** your {{es}} data.
16-
* **Explore** the fields and content of your data in depth.
17-
* **Present** your findings in a visualization.
18-
19-
**Prerequisites:**
20-
21-
* If you don’t already have {{kib}}, [start a free trial](https://www.elastic.co/cloud/elasticsearch-service/signup?baymax=docs-body&elektra=docs) on Elastic Cloud.
22-
* You must have data in {{es}}. Examples on this page use the [ecommerce sample data set](../index.md#gs-get-data-into-kibana), but you can use your own data.
23-
* You should have an understanding of [{{es}} documents and indices](../../manage-data/data-store/index-basics.md).
14+
Learn how to explore your {{product.elasticsearch}} data using **Discover**. This tutorial walks you through selecting {{data-sources}}, filtering documents, analyzing field structures, and creating visualizations from your data.
2415

2516
## Context-aware data exploration [context-aware-discover]
2617

explore-analyze/discover/discover-search-for-relevance.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ applies_to:
66
serverless: ga
77
products:
88
- id: kibana
9+
description: Sort search results by relevance score in Discover to identify the documents that best match your query. Use the score field to prioritize the most relevant data.
910
---
1011

1112
# Search for relevance [discover-search-for-relevance]
1213

13-
{{es}} assigns a relevancy, or score to each document, so you can can narrow your search to the documents with the most relevant results. The higher the score, the better it matches your query.
14+
{{product.elasticsearch}} assigns a relevancy score to each document based on how well it matches your query. Sorting by this score helps you identify the most relevant results quickly. This guide shows how to use **Discover** to sort documents by relevance score, putting the best matches at the top of your results.
1415

15-
This example shows how to use **Discover** to list your documents from most relevant to least relevant. This example uses the [sample flights data set](../index.md#gs-get-data-into-kibana), or you can use your own data.
16+
This example uses the [sample flights data set](../index.md#gs-get-data-into-kibana), or you can use your own data.
1617

1718
1. In **Discover**, open the {{data-source}} dropdown, and select the data that you want to work with.
1819

explore-analyze/discover/document-explorer.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ applies_to:
66
serverless: ga
77
products:
88
- id: kibana
9+
description: Customize the Discover view with flexible display options for the document table, chart, and sidebar. Adjust columns, density, row height, and field visibility for optimal exploration.
910
---
1011

1112
# Customize the Discover view [document-explorer]
1213

13-
Fine tune your explorations by customizing **Discover** to bring out the the best view of your documents.
14+
**Discover** offers flexible customization options to optimize your data exploration experience. Adjust the document table layout, modify column arrangements, control chart and sidebar visibility, and configure display density to focus on the data that matters most. These customizations persist across sessions and help you work more efficiently with your {{product.elasticsearch}} data.
1415

1516
:::{tip}
1617
Discover provides default [context-aware experiences](/explore-analyze/discover/discover-get-started.md#context-aware-discover) tailored to the type of data that you're exploring, and you can further customize your Discover view on top of them.

explore-analyze/discover/run-pattern-analysis-discover.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,14 @@ applies_to:
66
serverless: ga
77
products:
88
- id: kibana
9+
description: Detect patterns in unstructured data with pattern analysis in Discover. Categorize log messages, identify common structures, and filter noise during troubleshooting.
910
---
1011

1112
# Run a pattern analysis on your log data [run-pattern-analysis-discover]
1213

13-
Log pattern analysis helps you to find patterns in unstructured log messages and makes it easier to examine your data. It performs categorization analysis on a selected field of a {{data-source}}, creates categories based on the data and displays them together with a chart that shows the distribution of each category and an example document that matches the category.
14+
Pattern analysis in **Discover** helps you find patterns in unstructured log messages by performing categorization analysis on text fields. It creates categories based on message structures, displays their distribution in a chart, and provides example documents for each pattern. This makes it easier to identify common log patterns, filter out noise, and focus on anomalous messages during troubleshooting.
1415

15-
Log pattern analysis works on every text field.
16-
17-
This example uses the [sample web logs data](../index.md#gs-get-data-into-kibana), or you can use your own data.
16+
Pattern analysis works on any text field. This example uses the [sample web logs data](../index.md#gs-get-data-into-kibana), or you can use your own log data.
1817

1918
1. Go to **Discover**.
2019
2. Expand the {{data-source}} dropdown, and select **Kibana Sample Data Logs**.

explore-analyze/discover/save-open-search.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,24 @@ applies_to:
77
serverless: ga
88
products:
99
- id: kibana
10+
description: Save Discover sessions to reuse searches, queries, and configured views. Add saved searches to dashboards or use them as a foundation for building visualizations.
1011
---
1112

12-
# Discover sessions: Save a search for reuse [save-open-search]
13+
# Save a search for reuse [save-open-search]
1314

14-
A saved Discover session is a convenient way to reuse a search that you’ve created in **Discover**. Discover sessions are good for saving a configured view of Discover to use later or adding search results to a dashboard, and can also serve as a foundation for building visualizations.
15+
Saved **Discover** sessions preserve your queries, filters, column selections, and view configurations for reuse. Save sessions to return to specific data explorations, share search results with team members, add searches to dashboards, or use them as a foundation for building visualizations. This guide shows how to save, reopen, duplicate, and manage Discover sessions.
1516

17+
## Requirements [save-search-requirements]
1618

17-
## Read-only access [discover-read-only-access]
19+
To save searches, you need **Create** and **Edit** permissions for the {{saved-objects-app}} feature in {{product.kibana}}. If you don't have these permissions, the **Save** button won't be visible. For more information, refer to [Read-only access](#discover-read-only-access).
20+
21+
22+
### Read-only access [discover-read-only-access]
1823

1924
If you don’t have sufficient privileges to save Discover sessions, the following indicator is displayed and the **Save** button is not visible. For more information, refer to [Granting access to {{kib}}](elasticsearch://reference/elasticsearch/roles.md).
2025

2126
:::{image} /explore-analyze/images/kibana-read-only-badge.png
22-
:alt: Example of Discover's read only access indicator in Kibana's header
27+
:alt: Example of Discover's read only access indicator in the {{product.kibana}} header
2328
:screenshot:
2429
:::
2530

explore-analyze/discover/show-field-statistics.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,15 @@ applies_to:
66
serverless: ga
77
products:
88
- id: kibana
9+
description: Explore field statistics in Discover to view distributions, top values, and data quality metrics. Analyze numeric ranges, geographic coordinates, and field cardinality.
910
---
1011

1112
# View field statistics [show-field-statistics]
1213

13-
Explore the fields in your data with the **Field statistics** view in **Discover** and answer such questions as:
14-
15-
* What does the latency look like when one of the containers is down on a Sunday?
16-
* Is the field type and format in the data view appropriate for the data and its cardinality?
14+
The **Field statistics** view in **Discover** provides statistical summaries and visualizations of your data fields. View distributions, top values, minimum and maximum ranges, and cardinality to quickly understand your data quality and patterns. Use field statistics to identify data issues, understand field characteristics, and discover insights before building visualizations.
1715

1816
:::{note}
19-
Field statistics aren't available when **Discover** is in {{esql}} mode.
17+
Field statistics are only available when **Discover** is in default mode, not in {{esql}} mode.
2018
:::
2119

2220
This example explores the fields in the [sample web logs data](../index.md#gs-get-data-into-kibana), or you can use your own data.

explore-analyze/discover/try-esql.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,24 @@ applies_to:
66
serverless: ga
77
products:
88
- id: kibana
9+
description: Step-by-step tutorial for querying data with Elasticsearch Query Language (ES|QL) in Discover using piped commands to filter, transform, and aggregate data with sample data and visualizations.
910
---
1011

1112
# Using ES|QL [try-esql]
1213

13-
The Elasticsearch Query Language, {{esql}}, makes it easier to explore your data without leaving Discover.
14+
Elasticsearch Query Language ({{esql}}) helps you explore and analyze your {{product.elasticsearch}} data directly in **Discover**, without a [data view](discover-get-started.md#find-the-data-you-want-to-use). {{esql}} uses a piped syntax where you chain commands together to filter, transform, and aggregate data without needing to switch between different query interfaces. This tutorial walks you through querying sample data with {{esql}}, from basic field selection to complex filtering and visualization.
1415

15-
The examples on this page use the {{kib}} sample web logs in Discover and Lens to explore the data and create visualizations. You can also install it by following [Add sample data](../index.md#gs-get-data-into-kibana).
16+
## Prerequisites [try-esql-prerequisites]
1617

17-
::::{tip}
18-
For the complete {{esql}} documentation, including all supported commands, functions, and operators, refer to the [{{esql}} reference](elasticsearch://reference/query-languages/esql/esql-syntax-reference.md). For a more detailed overview of {{esql}} in {{kib}}, refer to [Use {{esql}} in Kibana](../query-filter/languages/esql-kibana.md).
18+
- The `enableESQL` setting enabled in **Advanced Settings** (enabled by default)
19+
- Have data in {{product.elasticsearch}}.
20+
The examples on this page use the {{product.kibana}} sample web logs to explore data and create visualizations. You can install sample data by following [Add sample data](../index.md#gs-get-data-into-kibana).
1921

22+
::::{tip}
23+
For the complete {{esql}} documentation, including all supported commands, functions, and operators, refer to the [{{esql}} reference](elasticsearch://reference/query-languages/esql/esql-syntax-reference.md). For a more detailed overview of {{esql}} in {{product.kibana}}, refer to [Use {{esql}} in Kibana](../query-filter/languages/esql-kibana.md).
2024
::::
2125

2226

23-
24-
## Prerequisite [prerequisite]
25-
26-
To view the {{esql}} option in **Discover**, the `enableESQL` setting must be enabled from Kibana’s **Advanced Settings**. It is enabled by default.
27-
28-
2927
## Use {{esql}} [tutorial-try-esql]
3028

3129
To load the sample data:

explore-analyze/visualize/manage-panels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ There are three types of **Discover** interactions you can add to dashboard pane
8484

8585
To use series data interactions, click a data series in the panel.
8686

87-
* **Discover session interactions** — Opens [saved Discover session](../discover.md#save-your-search) data in **Discover**.
87+
* **Discover session interactions** — Opens [saved Discover session](../discover/save-open-search.md) data in **Discover**.
8888

8989
To use saved Discover session interactions, open the panel menu and click **View Discover session**.
9090

0 commit comments

Comments
 (0)