Skip to content

[DOCS] EQL: Use data streams in EQL docs #70822

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 25, 2021
Merged

[DOCS] EQL: Use data streams in EQL docs #70822

merged 1 commit into from
Mar 25, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Mar 24, 2021 •
edited
Loading

Data streams are now the preferred way to index time series data. This updates the EQL docs to use data streams in examples. This should be more inline with the typical user experience.

Changes:

  • Updates the sec_logs and atomic_red_regsvr32 test setups and related snippets to use data streams.
  • Adds a simple index template to the Detect threats with EQL tutorial.
  • Updates a range query example to use the @timestamp field.
  • Replaces a frozen index reference with one for frozen and cold data tiers.

Previews

@jrodewig jrodewig changed the title [DOCS] EQL: Use data streams in docs [DOCS] EQL: Use data streams in EQL docs Mar 24, 2021
@jrodewig jrodewig marked this pull request as ready for review March 24, 2021 16:44
@jrodewig jrodewig requested a review from a team March 24, 2021 16:44
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:QL (Deprecated) Meta label for query languages team labels Mar 24, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-ql (Team:QL)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

jrodewig
jrodewig commented Mar 24, 2021
View reviewed changes
docs/reference/eql/eql.asciidoc
Comment on lines +624 to +625
searches across large data sets, <<data-tiers,cold>> or <<data-tiers,frozen>>
data, or <<modules-cross-cluster-search,multiple clusters>>.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, this would still apply to frozen indices too, but that functionality is outdated with frozen tiers. See #70192.

jrodewig
jrodewig commented Mar 24, 2021
View reviewed changes
docs/reference/eql/detect-threats-with-eql.asciidoc
+
[source,sh]
----
curl -H "Content-Type: application/json" -XPOST "localhost:9200/my-index-000001/_bulk?pretty&refresh" --data-binary "@normalized-T1117-AtomicRed-regsvr32.json"
curl -H "Content-Type: application/json" -XPOST "localhost:9200/my-data-stream/_bulk?pretty&refresh" --data-binary "@normalized-T1117-AtomicRed-regsvr32.json"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note for reviewers:

If testing this, be sure to use the updated normalized-T1117-AtomicRed-regsvr32.json file in this PR. The one in the preview will be outdated until this PR is merged.

jrodewig
jrodewig commented Mar 24, 2021
View reviewed changes
docs/reference/eql/detect-threats-with-eql.asciidoc
Comment on lines +42 to +49
////
[source,console]
----
DELETE /_data_stream/*
DELETE /_index_template/*
----
// TEARDOWN
////
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll replace this with a reusable teardown once #70831 is merged.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reusable teardowns don't play nicely with test responses. I'm going to leave this in for now.

jrodewig
jrodewig commented Mar 24, 2021
View reviewed changes
docs/reference/eql/eql-search-api.asciidoc
Comment on lines +18 to +22
DELETE /_data_stream/*
DELETE /_index_template/*
----
// TEARDOWN
////
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll replace this with a reusable teardown once #70831 is merged.

jrodewig
jrodewig commented Mar 24, 2021
View reviewed changes
docs/reference/eql/eql.asciidoc
Comment on lines +56 to +60
DELETE /_data_stream/*
DELETE /_index_template/*
----
// TEARDOWN
////
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll replace this with a reusable teardown once #70831 is merged.

debadair
debadair approved these changes Mar 24, 2021
View reviewed changes
Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for doing this & raising the idea of reusable teardowns for the tests.

@jrodewig
Copy link
Contributor Author

Thanks @debadair!

@jrodewig jrodewig merged commit 6504b54 into elastic:master Mar 25, 2021
@jrodewig jrodewig deleted the docs__eql-use-data-streams branch March 25, 2021 13:41
This was referenced Mar 25, 2021
Merged
Merged
jrodewig added a commit that referenced this pull request Mar 25, 2021
@jrodewig
[DOCS] EQL: Use data streams in docs (#70822) (#70873)
8f78784
jrodewig added a commit that referenced this pull request Mar 25, 2021
@jrodewig
[DOCS] EQL: Use data streams in docs (#70822) (#70874)
6123caf
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@debadair debadair debadair approved these changes

Assignees
No one assigned
Labels
:Analytics/EQL EQL querying >docs General docs changes Team:Docs Meta label for docs team Team:QL (Deprecated) Meta label for query languages team v7.12.1 v7.13.0 v8.0.0-alpha1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jrodewig @elasticmachine @debadair @jakelandis