-
Notifications
You must be signed in to change notification settings - Fork 163
[Security][9.x] Add 'search.allow_expensive_queries' to detections-requirements.md #3543
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
base: main
Are you sure you want to change the base?
Conversation
🔍 Preview links for changed docs |
Ready to review. Thanks! 😁 🙏 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @sdesalas for the important observation and opening this documentation improvement! I left a small suggestion.
Let's defer to @nastasha-solomon for a final review and approval.
478abde
to
1316de5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 🚀
Co-authored-by: Georgii Gorbachev <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some suggestions for your consideration and a few questions as well. Thanks!
Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested changing the numbers to list bullets because these tasks don't need to be completed in a specific order. They just need to be completed in the same file (the elasticsearch.yml
file).
Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>
* In [`elasticsearch.yml`](/deploy-manage/deploy/self-managed/configure-elasticsearch.md): | ||
* Set the `xpack.security.enabled` setting to `true`. Refer to [General security settings](elasticsearch://reference/elasticsearch/configuration-reference/security-settings.md#general-security-settings) for more information. | ||
* Remove the line `search.allow_expensive_queries=false` if you find it. The `search.allow_expensive_queries` setting must be left on its default value of `true` for key detection features like [alerting rules](https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts/alerting-setup#alerting-prerequisites) and rule exceptions to work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just noticed that the link is hardcoded in. I fixed the syntax below and pointed to an explanation of alerting rules instead. Also expanded the explanation around the setting a bit so users know when and when not to act.
* Remove the line `search.allow_expensive_queries=false` if you find it. The `search.allow_expensive_queries` setting must be left on its default value of `true` for key detection features like [alerting rules](https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts/alerting-setup#alerting-prerequisites) and rule exceptions to work. | |
* If the `search.allow_expensive_queries` setting is set to `false`, remove it. If the setting is set to its default value of `true` or not included in the `elasticsearch.yml` file, you don't need to change it. When this setting is set to `true`, it allows key detection features, such as [alerting rules](../../../explore-analyze/alerts-cases/alerts/alerting-getting-started.md#_rules) and rule exceptions, to work. |
Summary
De-facto requirement of Security Detections, (and much of Kibana) that has not been documented properly.
Errors go as far back as
v8.18
(but likely much further), and not only affect Security app, but also manyServer Management
features such as Fleet, Saved Objects, Tags, etc.For more info: elastic/kibana#237496 -> Section
Risks that were found acceptable
We're documenting it under the correct location to make sure that users know about it. There is an internal slack thread for discussion.
Note also that this is documented as a requirement of the 'alerting' plugin that we're using under the hood.