[DOCS] ES|QL pages in Kibana guide (#170226)
## Summary Two pages about ES|QL added to the Kibana guide. One page (titled ES|QL) under the 'Kibana concepts' heading, which is an overview page. One page added to the 'Discover' section (titled Try ES|QL) which is a short tutorial. Relates to: [#244](https://github.com/elastic/platform-docs-team/issues/244) --------- Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
40
docs/concepts/esql.asciidoc
Normal file
|
@ -0,0 +1,40 @@
|
|||
[[esql]]
|
||||
=== {esql}
|
||||
|
||||
preview::[]
|
||||
|
||||
The Elasticsearch Query Language, {esql}, has been created to make exploring your data faster and easier using the **Discover** application. From version 8.11 you can try this new feature, which is enabled by default.
|
||||
|
||||
[role="screenshot"]
|
||||
image:images/esql-data-view-menu.png[An image of the Discover UI where users can access the {esql} feature, width=30%]
|
||||
|
||||
This new piped language allows you to chain together multiple commands to query your data. Based on the query, Lens suggestions in Discover create a visualization of the query results.
|
||||
|
||||
{esql} comes with its own dedicated {esql} Compute Engine for greater efficiency. From one query you can search, aggregate, calculate and perform data transformations without leaving **Discover**. Write your query directly in **Discover** or use the **Dev Tools** with the {ref}/esql-rest.html[{esql} API].
|
||||
|
||||
{esql} also features in-app help, so you can get started faster and don't have to leave the application to check syntax.
|
||||
|
||||
[role="screenshot"]
|
||||
image:images/esql-in-app-help.png[An image of the Discover UI where users can browse the in-app help]
|
||||
|
||||
For more detailed information about the {esql} language, refer to {ref}/esql-language.html[Learning {esql}].
|
||||
|
||||
[float]
|
||||
[[esql-observability]]
|
||||
==== {observability}
|
||||
|
||||
{esql} makes it much easier to analyze metrics, logs and traces from a single query. Find performance issues fast by defining fields on the fly, enriching data with lookups, and using simultaneous query processing. Combining {esql} with {ml} and AiOps can improve detection accuracy and use aggregated value thresholds.
|
||||
|
||||
[float]
|
||||
[[esql-security]]
|
||||
==== Security
|
||||
|
||||
Use {esql} to retrieve important information for investigation by using lookups. Enrich data and create new fields on the go to gain valuable insight for faster decision-making and actions. For example, perform a lookup on an IP address to identify its geographical location, its association with known malicious entities, or whether it belongs to a known cloud service provider all from one search bar. {esql} ensures more accurate alerts by incorporating aggregated values in detection rules.
|
||||
|
||||
[float]
|
||||
[[esql-whats-next]]
|
||||
==== What's next?
|
||||
|
||||
Full documentation for this language is available in the {es} documentation, refer to {ref}/esql.html[{esql}].
|
||||
|
||||
Alternatively, a short tutorial is available in the **Discover** section <<try-esql, Try {esql}L>>.
|
BIN
docs/concepts/images/esql-activated.png
Normal file
After Width: | Height: | Size: 258 KiB |
BIN
docs/concepts/images/esql-data-view-menu.png
Normal file
After Width: | Height: | Size: 77 KiB |
BIN
docs/concepts/images/esql-in-app-help.png
Normal file
After Width: | Height: | Size: 362 KiB |
|
@ -155,8 +155,11 @@ include::data-views.asciidoc[]
|
|||
|
||||
include::set-time-filter.asciidoc[]
|
||||
|
||||
include::esql.asciidoc[]
|
||||
|
||||
include::kuery.asciidoc[]
|
||||
|
||||
include::lucene.asciidoc[]
|
||||
|
||||
include::save-query.asciidoc[]
|
||||
|
||||
|
|
BIN
docs/discover/images/esql-activated.png
Normal file
After Width: | Height: | Size: 258 KiB |
BIN
docs/discover/images/esql-full-query.png
Normal file
After Width: | Height: | Size: 318 KiB |
BIN
docs/discover/images/esql-limit.png
Normal file
After Width: | Height: | Size: 308 KiB |
BIN
docs/discover/images/esql-machine-os-ram.png
Normal file
After Width: | Height: | Size: 288 KiB |
BIN
docs/discover/images/try-esql.png
Normal file
After Width: | Height: | Size: 44 KiB |
91
docs/discover/try-esql.asciidoc
Normal file
|
@ -0,0 +1,91 @@
|
|||
[[try-esql]]
|
||||
== Try {esql}
|
||||
|
||||
preview::[]
|
||||
|
||||
The Elasticsearch Query Language, {esql}, makes it easier to explore your data without leaving Discover.
|
||||
|
||||
In this tutorial we'll use the {kib} sample web logs in Discover and Lens to explore the data and create visualizations.
|
||||
|
||||
[float]
|
||||
[[prerequisite]]
|
||||
=== Prerequisite
|
||||
|
||||
To be able to select **Try {esql}** from the Data views menu the `discover:enableESQL` setting must be enabled from **Stack Management > Advanced Settings**. It is enabled by default.
|
||||
|
||||
[float]
|
||||
[[tutorial-try-esql]]
|
||||
=== Trying {esql}
|
||||
|
||||
To load the sample data:
|
||||
|
||||
. On the home page, click **Try sample data**.
|
||||
. Click **Other sample data sets**.
|
||||
. On the Sample web logs card, click **Add data**.
|
||||
. Open the main menu and select *Discover*.
|
||||
. From the Data views menu, select *Try {esql}*.
|
||||
|
||||
Let's say we want to find out what operating system users have and how much RAM is on their machine.
|
||||
|
||||
. Set the time range to **Last 7 days**.
|
||||
. Expand image:images/expand-icon-2.png[An image of the expand icon] the query bar.
|
||||
. Put each processing command on a new line for better readability.
|
||||
. Copy the query below:
|
||||
+
|
||||
[source,esql]
|
||||
----
|
||||
FROM kibana_sample_data_logs
|
||||
| KEEP machine.os, machine.ram
|
||||
----
|
||||
+
|
||||
. Click **Update**.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image:images/esql-machine-os-ram.png[An image of the query result]
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
{esql} keywords are not case sensitive.
|
||||
====
|
||||
|
||||
Let's add `geo.dest` to our query, to find out the geographical destination of the visits, and limit the results.
|
||||
|
||||
. Copy the query below:
|
||||
+
|
||||
[source,esql]
|
||||
----
|
||||
FROM kibana_sample_data_logs
|
||||
| KEEP machine.os, machine.ram, geo.dest
|
||||
| LIMIT 10
|
||||
----
|
||||
+
|
||||
. Click **Update**.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image:images/esql-limit.png[An image of the extended query result]
|
||||
|
||||
Let's sort the data by machine ram and filter out the destination GB.
|
||||
|
||||
. Copy the query below:
|
||||
+
|
||||
[source,esql]
|
||||
----
|
||||
FROM kibana_sample_data_logs
|
||||
| KEEP machine.os, machine.ram, geo.dest
|
||||
| SORT machine.ram desc
|
||||
| WHERE geo.dest != "GB"
|
||||
| LIMIT 10
|
||||
----
|
||||
+
|
||||
. Click **Update**.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image:images/esql-full-query.png[]
|
||||
+
|
||||
. Click **Save** to save the query and visualization to a dashboard.
|
||||
|
||||
To make changes to the visualization you can use the visualization drop-down. To make changes to the colors used or the axes, or click the pencil icon. This opens an in-line editor where you can change the colors and axes of the visualization.
|
||||
|
||||
To learn more about {esql}, try other tutorials, see more examples and reference material, refer to {ref}/esql.html[{esql}].
|
||||
|
||||
|
|
@ -346,4 +346,7 @@ include::{kib-repo-dir}/discover/field-statistics.asciidoc[]
|
|||
|
||||
include::{kib-repo-dir}/discover/log-pattern-analysis.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/discover/search-sessions.asciidoc[]
|
||||
include::{kib-repo-dir}/discover/search-sessions.asciidoc[]
|
||||
|
||||
include::{kib-repo-dir}/discover/try-esql.asciidoc[]
|
||||
|
||||
|
|