Beats: Clarify documentation about indexers and matchers

Created on 13 Nov 2017  路  3Comments  路  Source: elastic/beats

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

:Processors Integrations Platforms containers docs

Most helpful comment

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.

All 3 comments

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.

Pinging @elastic/infrastructure

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

Was this page helpful?
0 / 5 - 0 ratings