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

Existing logsdb "not supported" note needs clarification to avoid confusion #6518

Closed
MikePaquette opened this issue Feb 10, 2025 · 2 comments
Assignees
Labels
Priority: Urgent Issues that need to be resolved as soon as possible Team: Detection Engine v8.17.0

Comments

@MikePaquette
Copy link
Contributor

What can we change to make the docs better?

Current docs are creating confusion with customers and Elastic field personnel.

Doc URL

Doc URL: https://www.elastic.co/guide/en/security/8.17/detections-logsdb-index-mode-impact.html
Github issue link(s)/Other resources: None

Customers and Elastic field personnel have expressed confusion about the current "not supported" statement with regards to logsdb index mode, and have asked us to provide some clarification regarding new deployments vs. existing deployments.

As a short-term solution, we should replace the current text with something like:

Logsdb index mode is fully supported, and is recommended for new Elastic Security deployments. LogsDB is not recommended for existing Elastic Security deployments unless users fully understand and accept the documented changes to detection alert documents (see below), and ensure that their deployment has sufficient excess hot data tier CPU capacity to support the LogsDB ingest/indexing process. Enabling logsdb index mode without sufficient excess hot data tier CPU capacity may result in data ingestion backups and/or security detection rule timeouts and errors.

Which documentation set needs improvement?

ESS and serverless

Software version

Any version where LogsDB impact statement is included.

@MikePaquette MikePaquette added the Priority: Urgent Issues that need to be resolved as soon as possible label Feb 10, 2025
@nastasha-solomon nastasha-solomon self-assigned this Feb 10, 2025
@MikePaquette MikePaquette changed the title Existing logsdb impact note needs clarification to avoid confusion. Existing logsdb "not supported" note needs clarification to avoid confusion Feb 10, 2025
@MikePaquette
Copy link
Contributor Author

MikePaquette commented Feb 10, 2025

Hi @nastasha-solomon one further tweak to the suggested text (of course still subject to copy review/editing):

Logsdb index mode is fully supported, and is recommended for new Elastic Security deployments. LogsDB is not recommended for existing Elastic Security deployments unless users fully understand and accept the documented changes to detection alert documents, runtime fields, and rule actions (see below), and ensure that their deployment has sufficient excess hot data tier CPU capacity to support the LogsDB ingest/indexing process. Enabling LogsDB without sufficient excess hot data tier CPU capacity may result in data ingestion backups and/or security detection rule timeouts and errors.

@nastasha-solomon
Copy link
Contributor

Hey, @MikePaquette - the 8.17 docs have been updated. The changes should be reflected on this page once the docs rebuilt (it usually takes about an hour).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Urgent Issues that need to be resolved as soon as possible Team: Detection Engine v8.17.0
Projects
None yet
Development

No branches or pull requests

3 participants