Skip to content

Commit 79efa7f

Browse files
refresh ESQL kibana docs (elastic#116441) (elastic#116474)
(cherry picked from commit ba65914) Co-authored-by: florent-leborgne <[email protected]>
1 parent 12ff76a commit 79efa7f

10 files changed

+17
-22
lines changed

docs/reference/esql/esql-kibana.asciidoc

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ You can use {esql} in {kib} to query and aggregate your data, create
99
visualizations, and set up alerts.
1010

1111
This guide shows you how to use {esql} in Kibana. To follow along with the
12-
queries, load the "Sample web logs" sample data set by clicking *Try sample
13-
data* from the {kib} Home, selecting *Other sample data sets*, and clicking *Add
14-
data* on the *Sample web logs* card.
12+
queries, load the "Sample web logs" sample data set by selecting **Sample Data**
13+
from the **Integrations** page in {kib}, selecting *Other sample data sets*,
14+
and clicking *Add data* on the *Sample web logs* card.
1515

1616
[discrete]
1717
[[esql-kibana-enable]]
@@ -30,9 +30,7 @@ However, users will be able to access existing {esql} artifacts like saved searc
3030

3131
// tag::esql-mode[]
3232
To get started with {esql} in Discover, open the main menu and select
33-
*Discover*. Next, from the Data views menu, select *Language: ES|QL*.
34-
35-
image::images/esql/esql-data-view-menu.png[align="center",width=33%]
33+
*Discover*. Next, select *Try ES|QL* from the application menu bar.
3634
// end::esql-mode[]
3735

3836
[discrete]
@@ -54,8 +52,9 @@ A source command can be followed by one or more <<esql-commands,processing
5452
commands>>. In this query, the processing command is <<esql-limit>>. `LIMIT`
5553
limits the number of rows that are retrieved.
5654

57-
TIP: Click the help icon (image:images/esql/esql-icon-help.svg[Static,20]) to open the
58-
in-product reference documentation for all commands and functions.
55+
TIP: Click the **ES|QL help** button to open the
56+
in-product reference documentation for all commands and functions or to get
57+
recommended queries that will help you get started.
5958

6059
// tag::autocomplete[]
6160
To make it easier to write queries, auto-complete offers suggestions with
@@ -76,7 +75,7 @@ FROM kibana_sample_data_logs | LIMIT 10
7675
====
7776

7877
[discrete]
79-
==== Expand the query bar
78+
==== Make your query readable
8079

8180
For readability, you can put each processing command on a new line. The
8281
following query is identical to the previous one:
@@ -87,15 +86,12 @@ FROM kibana_sample_data_logs
8786
| LIMIT 10
8887
----
8988

90-
// tag::compact[]
91-
To make it easier to write multi-line queries, click the double-headed arrow
92-
button (image:images/esql/esql-icon-expand-query-bar.svg[]) to expand the query
93-
bar:
89+
You can do that using the **Add line breaks on pipes** button from the query editor's footer.
9490

95-
image::images/esql/esql-expanded-query-bar.png[align="center"]
91+
image::https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/bltd5554518309e10f6/672d153cfeb8f9d479ebcc6e/esql-line-breakdown.gif[Automatic line breaks for ES|QL queries]
9692

97-
To return to a compact query bar, click the minimize editor button
98-
(image:images/esql/esql-icon-minimize-query-bar.svg[]).
93+
// tag::compact[]
94+
You can adjust the editor's height by dragging its bottom border to your liking.
9995
// end::compact[]
10096

10197
[discrete]
@@ -110,9 +106,7 @@ detailed warning, expand the query bar, and click *warnings*.
110106
==== Query history
111107

112108
You can reuse your recent {esql} queries in the query bar.
113-
In the query bar click *Show recent queries*:
114-
115-
image::images/esql/esql-discover-show-recent-query.png[align="center",size="50%"]
109+
In the query bar click *Show recent queries*.
116110

117111
You can then scroll through your recent queries:
118112

@@ -220,8 +214,9 @@ FROM kibana_sample_data_logs
220214
=== Analyze and visualize data
221215

222216
Between the query bar and the results table, Discover shows a date histogram
223-
visualization. If the indices you're querying do not contain a `@timestamp`
224-
field, the histogram is not shown.
217+
visualization. By default, if the indices you're querying do not contain a `@timestamp`
218+
field, the histogram is not shown. But you can use a custom time field with the `?_tstart`
219+
and `?_tend` parameters to enable it.
225220

226221
The visualization adapts to the query. A query's nature determines the type of
227222
visualization. For example, this query aggregates the total number of bytes per
@@ -250,7 +245,7 @@ save button (image:images/esql/esql-icon-save-visualization.svg[]). Once saved
250245
to a dashboard, you'll be taken to the Dashboards page. You can continue to
251246
make changes to the visualization. Click the
252247
options button in the top-right (image:images/esql/esql-icon-options.svg[]) and
253-
select *Edit ESQL visualization* to open the in-line editor:
248+
select *Edit ES|QL visualization* to open the in-line editor:
254249

255250
image::images/esql/esql-kibana-edit-on-dashboard.png[align="center",width=66%]
256251

-28.4 KB
Loading
96.9 KB
Loading
-74.6 KB
Binary file not shown.
106 KB
Loading
68.9 KB
Loading
-74.6 KB
Loading
31.7 KB
Loading
11.6 KB
Loading
89.7 KB
Loading

0 commit comments

Comments
 (0)