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

[Request][ESS] Document advanced setting that allows users to disable ES|QL in ESS #5181

Merged
merged 16 commits into from
May 20, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
3 changes: 3 additions & 0 deletions docs/detections/api/rules/rules-api-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ an event's `destination.ip` equals a value in the index. The index's field
mappings should be {ecs-ref}[ECS-compliant].
* *New terms*: Generates an alert for each new term detected in source documents within a specified time range.
* *{esql}*: Uses {ref}/esql.html[Elasticsearch Query Language ({esql})] to find events and aggregate search results.
+
NOTE: The {esql} rule type is available by default. Turn it off by toggling the {kibana-ref}/advanced-options.html#kibana-general-settings[`enableESQL`] advanced setting off.

* *{ml-cap} rules*: Creates an alert when a {ml} job discovers an anomaly above
the defined threshold (see <<machine-learning>>).

Expand Down
2 changes: 2 additions & 0 deletions docs/detections/rules-ui-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,8 @@ For example, if a rule has an interval of 5 minutes, no additional look-back tim
[[create-esql-rule]]
=== Create an {esql} rule

NOTE: The {esql} rule type is available by default. Turn it off by toggling the {kibana-ref}/advanced-options.html#kibana-general-settings[`enableESQL`] advanced setting off.

Use {ref}/esql.html[{esql}] to query your source events and aggregate event data. Query results are returned in a table with rows and columns. Each row becomes an alert.

To create an {esql} rule:
Expand Down
2 changes: 2 additions & 0 deletions docs/events/timeline-ui-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,8 @@ From the *Correlation* tab, you can also do the following:
[[esql-in-timeline]]
== Use {esql} to investigate events

NOTE: The **{esql}** Timeline tab is available by default. Turn it off by toggling the {kibana-ref}/advanced-options.html#kibana-general-settings[`enableESQL`] advanced setting off.

preview::["Do not use {esql} on production environments. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features."]

NOTE: The {esql} tab is available by default. Since it's in technical preview, you can remove it by editing your {cloud}/ec-manage-kibana-settings.html#ec-manage-kibana-settings[{kib} user settings] and adding the `xpack.securitySolution.enableExperimental: ["timelineEsqlTabDisabled"]` feature flag.
Expand Down