elastic/logstash

Consider improving Logstash configs in the docs/static/filebeat_modules/*/*.conf

Open

Aperta il 25 ott 2017

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Ruby (14.197 star) (3496 fork)batch import
good first issuehacktoberfestmodules

Descrizione

These configs are part of the "adding Logstash to filebeat modules getting started experience" and therefore its very likely the first time a user will see a LS config.

For the best experience we should add a fair few comments to better inform what is going on. The user sees the nested field reference for the first time and there is a try three grok pattern scheme with two mutate renames that work only if earlier grok patterns fail that could be explained better. Also, we should add grok and date parse failure handling.

Optionally, we could add anchors to Grok patterns.

Guida contributor

Tech stack
Nessuno
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic knowledge of Logstash config syntaxFamiliarity with Grok patterns
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75
Direzione di ricerca
Examine the existing .conf files in the docs/static/filebeat modules/ directories. Identify areas where nested field references, grok pattern schemes, and mutate renames are used. Add clear comments explaining each step. Implement error handling for grok and date parse failures, possibly using conditional logic. Optionally, add anchors to Grok patterns for clarity. Review Logstash best practices for configuration documentation.