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

Clarify documentation about indexers and matchers #5566

Closed
exekias opened this issue Nov 13, 2017 · 4 comments · Fixed by #17139
Closed

Clarify documentation about indexers and matchers #5566

exekias opened this issue Nov 13, 2017 · 4 comments · Fixed by #17139
Assignees
Labels
containers Related to containers use case docs :Processors Team:Integrations Label for the Integrations team Team:Platforms Label for the Integrations - Platforms team

Comments

@exekias
Copy link
Contributor

exekias commented Nov 13, 2017

We could clarify add_kubernetes_metadata indexers and matchers functionality: https://www.elastic.co/guide/en/beats/filebeat/6.0/add-kubernetes-metadata.html

Indexers extract pod metadata from kubernetes events and store it in a map in memory
Matchers process beat events and enrich them with metadata from the in-memory map

We should try to avoid indexing related words to avoid confusion with ES indexing, as this is totally unrelated

@huskerdhf
Copy link

I would suggest expanding the scope of the documentation updates to also include:

  • Document the available indexers and matchers
  • For each beat, document the default indexer(s) and matcher(s)
  • Document how to configure each indexer and matcher

I'm currently trying to get the add_kubernetes_metadata feature working with our Metricbeat deployment (without any luck yet) and having this type of documentation would be very helpful. At this point I'm having to dig through the beats code to try and understand all of this information which clearly is not the most efficient means for a user to find out how to use a feature.

@exekias exekias self-assigned this May 15, 2018
@exekias exekias added the containers Related to containers use case label May 15, 2018
@alvarolobato alvarolobato added the Team:Integrations Label for the Integrations team label Dec 3, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/infrastructure

@jsoriano jsoriano added the Team:Platforms Label for the Integrations - Platforms team label Mar 11, 2020
@elasticmachine
Copy link
Collaborator

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

@offero
Copy link

offero commented Feb 2, 2021

It's 2021 and it's still confusing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
containers Related to containers use case docs :Processors Team:Integrations Label for the Integrations team Team:Platforms Label for the Integrations - Platforms team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants