Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ES|QL tab added to Timeline #4065

Merged
merged 42 commits into from
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
bfd6f57
First draft
nastasha-solomon Oct 17, 2023
f24ec36
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Oct 17, 2023
b3a1e4e
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Oct 23, 2023
4331794
Revisions
nastasha-solomon Oct 24, 2023
cb8a0bd
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Oct 24, 2023
9f217cc
Draft updates
nastasha-solomon Oct 24, 2023
b163f22
Pulling in ES content
nastasha-solomon Oct 24, 2023
a20ca92
Removing parenth
nastasha-solomon Oct 24, 2023
7b19b2c
Shuffling
nastasha-solomon Oct 24, 2023
47f4189
Add icon
nastasha-solomon Oct 24, 2023
8430210
Fixing image ref
nastasha-solomon Oct 24, 2023
9b59989
Re-ordering info
nastasha-solomon Oct 24, 2023
8496920
Removing extra spaces
nastasha-solomon Oct 24, 2023
9cf5211
Minor adjustments
nastasha-solomon Oct 24, 2023
2db6611
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Oct 25, 2023
d1119c3
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Oct 26, 2023
8250c01
Adding refs to additional docs
nastasha-solomon Oct 27, 2023
5a60b7e
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Oct 27, 2023
2150887
Minor wording adjustments
nastasha-solomon Oct 27, 2023
639b5da
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Oct 27, 2023
7885dd0
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Oct 27, 2023
5a7076b
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Oct 27, 2023
8c281ee
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Oct 27, 2023
94dab4a
smol edit
nastasha-solomon Oct 28, 2023
03a7661
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Oct 31, 2023
aa42db1
Adding shared attribute
nastasha-solomon Oct 31, 2023
c27e3c2
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Oct 31, 2023
1f51f1b
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Oct 31, 2023
48c6256
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Oct 31, 2023
f47b841
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Oct 31, 2023
e768a1e
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Oct 31, 2023
5ae750d
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Oct 31, 2023
5f492e8
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Nov 1, 2023
0385a25
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Nov 2, 2023
6544266
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Nov 2, 2023
cc404c2
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Nov 2, 2023
d489cc0
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Nov 2, 2023
1a2a9be
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Nov 2, 2023
907848e
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Nov 6, 2023
27e7cb2
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Nov 6, 2023
b8e28b4
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Nov 6, 2023
9bf64e0
Merge branch 'main' into issue-4025-esql-timeline
nastasha-solomon Nov 6, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/events/images/esql-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/events/timeline-ui-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -178,3 +178,29 @@ From the *Correlation* tab, you can also do the following:
* Specify the date and time range that you want to investigate.
* Reorder the columns and choose which fields to display.
* Choose a data view and whether to show detection alerts only.

[discrete]
[[esql-in-timeline]]
== Use {esql} to investigate events

preview::[]

The {ref}/esql.html[Elasticsearch Query Language ({esql})] provides a powerful way to filter, transform, and analyze event data stored in {es}. {esql} queries use "pipes" to manipulate and transform data in a step-by-step fashion. This approach allows you to compose a series of operations, where the output of one operation becomes the input for the next, enabling complex data transformations and analysis.

You can use {esql} in Timeline by opening the **{esql}** tab. From there, you can:

- Explore your events using the default query, or create a custom one. The default query searches documents within the Security alert index (`.alerts-security.alerts-default`) and indices specified in the <<update-sec-indices,Security data view>>, then returns 10 events from the defined time range.
- Click the help icon (image:images/esql-ref-button.png[Click the ES|QL reference button,20,20]) on the far right side of the query editor to open the in-product reference documentation for all {esql} commands and functions.
- Visualize query results using {kibana-ref}/discover.html[Discover] functionality.

[role="screenshot"]
image::images/esql-tab.png[a Timeline's ES|QL tab]

[discrete]
[[esql-in-timeline-resources]]
=== Additional {esql} resources

To get started using {esql}, read the tutorial for {ref}/esql-kibana.html[using {esql} in {kib}]. Much of the functionality available in {kib} is also available in Timeline.

To find examples of using {esql} for threat hunting, check out https://www.elastic.co/blog/introduction-to-esql-new-query-language-flexible-iterative-analytics[our blog].

Binary file added docs/images/esql-ref-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.