Skip to content

Commit

Permalink
[8.x] [DOCS][ResponseOps] Remove tech preview from ES query ES|QL rul…
Browse files Browse the repository at this point in the history
…e type (#194233) (#194345)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS][ResponseOps] Remove tech preview from ES query ES|QL rule type
(#194233)](#194233)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-09-27T19:45:09Z","message":"[DOCS][ResponseOps]
Remove tech preview from ES query ES|QL rule type
(#194233)","sha":"907c82da92b06f631d9bcc738bbda4db7f0f7cd8","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","v9.0.0","docs","v8.16.0","backport:version"],"title":"[DOCS][ResponseOps]
Remove tech preview from ES query ES|QL rule
type","number":194233,"url":"https://github.com/elastic/kibana/pull/194233","mergeCommit":{"message":"[DOCS][ResponseOps]
Remove tech preview from ES query ES|QL rule type
(#194233)","sha":"907c82da92b06f631d9bcc738bbda4db7f0f7cd8"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194233","number":194233,"mergeCommit":{"message":"[DOCS][ResponseOps]
Remove tech preview from ES query ES|QL rule type
(#194233)","sha":"907c82da92b06f631d9bcc738bbda4db7f0f7cd8"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
  • Loading branch information
kibanamachine and lcawl authored Sep 27, 2024
1 parent 39810fd commit d90b6a7
Show file tree
Hide file tree
Showing 5 changed files with 2 additions and 5 deletions.
Binary file modified docs/user/alerting/images/es-query-rule-action-query-matched.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user/alerting/images/es-query-rule-action-summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user/alerting/images/es-query-rule-action-variables.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/user/alerting/rule-types/es-query.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ For example:
If you use {kibana-ref}/kuery-query.html[KQL] or {kibana-ref}/lucene-query.html[Lucene], you must specify a data view then define a text-based query.
For example, `http.request.referrer: "https://example.com"`.

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."] If you use {ref}/esql.html[ES|QL], you must provide a source command followed by an optional series of processing commands, separated by pipe characters (|).
If you use {ref}/esql.html[ES|QL], you must provide a source command followed by an optional series of processing commands, separated by pipe characters (|). added:[8.16.0]
For example:

[source,sh]
Expand Down Expand Up @@ -101,7 +101,7 @@ For example:
image::user/alerting/images/rule-types-es-query-valid.png[Test {es} query returns number of matches when valid]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.

preview:[] If you use an ES|QL query, a table is displayed. For example:
If you use an ES|QL query, a table is displayed. For example:

[role="screenshot"]
image::user/alerting/images/rule-types-esql-query-valid.png[Test ES|QL query returns a table when valid]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,7 @@ title: Elasticsearch ES|QL query rule params
description: >
An Elasticsearch query rule can run an ES|QL query and compare the number of matches to a configured threshold.
These parameters are appropriate when `rule_type_id` is `.es-query`.
NOTE: This functionality is in technical pre view 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.
type: object
x-technical-preview: true
required:
- esqlQuery
- searchType
Expand Down

0 comments on commit d90b6a7

Please sign in to comment.