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

Add reference documentation about indexers and matchers #17139

Merged
merged 3 commits into from
Mar 31, 2020

Conversation

jsoriano
Copy link
Member

@jsoriano jsoriano commented Mar 19, 2020

Add reference documentation about the available indexers and matchers
in the add_kubernetes_metadata processor.
Rephrase some sentences to avoid indexing terminology that could create
confusion with ES indexing.

Fixes #5566.
Closes #14058.

@jsoriano jsoriano added docs review needs_backport PR is waiting to be backported to other branches. :Processors [zube]: In Review Team:Platforms Label for the Integrations - Platforms team labels Mar 19, 2020
@jsoriano jsoriano self-assigned this Mar 19, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations-platforms (Team:Platforms)

Copy link
Member

@ChrsMark ChrsMark left a comment

Choose a reason for hiding this comment

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

Hey @jsoriano thank you for adding this! How about adding a table of the defaults for each Beat? That was started on #14058, but your PR is more complete.

@jsoriano
Copy link
Member Author

Hey @jsoriano thank you for adding this! How about adding a table of the defaults for each Beat? That was started on #14058, but your PR is more complete.

@ChrsMark ok, good idea to do it here all together. I have added some docs about the defaults mentioned in #14058. Please take another look. Thanks!

contain a `metricset.host` field are enriched with metadata of the pods that
exposes the same port in the same IP.

This behaviour can be disabled disabling default indexers and matchers in the
Copy link
Member

Choose a reason for hiding this comment

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

minor but maybe a by is needed here:

Suggested change
This behaviour can be disabled disabling default indexers and matchers in the
This behaviour can be disabled by disabling default indexers and matchers in the

Copy link
Member

@ChrsMark ChrsMark left a comment

Choose a reason for hiding this comment

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

overall lgtm! thanks!

contains a reference to a container ID are enriched with metadata of the pod of
this container.

This behaviour can be disabled disabling default indexers and matchers in the
Copy link
Member

Choose a reason for hiding this comment

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

minor but maybe a by is needed here:

Suggested change
This behaviour can be disabled disabling default indexers and matchers in the
This behaviour can be disabled by disabling default indexers and matchers in the

Copy link
Member Author

Choose a reason for hiding this comment

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

Better, yes, thanks!

@jsoriano jsoriano merged commit 819136f into elastic:master Mar 31, 2020
@jsoriano jsoriano deleted the indexers-matchers-docs branch March 31, 2020 10:23
@jsoriano jsoriano added v7.8.0 and removed needs_backport PR is waiting to be backported to other branches. labels Mar 31, 2020
jsoriano added a commit to jsoriano/beats that referenced this pull request Mar 31, 2020
Add reference documentation about the available indexers and matchers
in the `add_kubernetes_metadata` processor.
Rephrase some sentences to avoid indexing terminology that could create
confusion with ES indexing.

Co-authored-by: Chris Mark <[email protected]>
(cherry picked from commit 819136f)
jsoriano added a commit to jsoriano/beats that referenced this pull request Mar 31, 2020
Add reference documentation about the available indexers and matchers
in the `add_kubernetes_metadata` processor.
Rephrase some sentences to avoid indexing terminology that could create
confusion with ES indexing.

Co-authored-by: Chris Mark <[email protected]>
(cherry picked from commit 819136f)
jsoriano added a commit to jsoriano/beats that referenced this pull request Mar 31, 2020
Add reference documentation about the available indexers and matchers
in the `add_kubernetes_metadata` processor.
Rephrase some sentences to avoid indexing terminology that could create
confusion with ES indexing.

Co-authored-by: Chris Mark <[email protected]>
(cherry picked from commit 819136f)
@dedemorton dedemorton added the needs_edit Indicates that the doc changes need an edit after merging. label Mar 31, 2020
@dedemorton dedemorton removed the needs_edit Indicates that the doc changes need an edit after merging. label Mar 31, 2020
jsoriano added a commit that referenced this pull request Apr 1, 2020
)

Add reference documentation about the available indexers and matchers
in the `add_kubernetes_metadata` processor.
Rephrase some sentences to avoid indexing terminology that could create
confusion with ES indexing.

(cherry picked from commit 819136f)

Co-authored-by: Chris Mark <[email protected]>
jsoriano added a commit that referenced this pull request Apr 1, 2020
)

Add reference documentation about the available indexers and matchers
in the `add_kubernetes_metadata` processor.
Rephrase some sentences to avoid indexing terminology that could create
confusion with ES indexing.

(cherry picked from commit 819136f)

Co-authored-by: Chris Mark <[email protected]>
jsoriano added a commit that referenced this pull request Apr 1, 2020
)

Add reference documentation about the available indexers and matchers
in the `add_kubernetes_metadata` processor.
Rephrase some sentences to avoid indexing terminology that could create
confusion with ES indexing.

(cherry picked from commit 819136f)

Co-authored-by: Chris Mark <[email protected]>
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
… (elastic#17355)

Add reference documentation about the available indexers and matchers
in the `add_kubernetes_metadata` processor.
Rephrase some sentences to avoid indexing terminology that could create
confusion with ES indexing.

(cherry picked from commit 3a5ff25)

Co-authored-by: Chris Mark <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify documentation about indexers and matchers
6 participants