elastic/logstash

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

Open

#8.527 aberto em 25 de out. de 2017

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Ruby (14.197 stars) (3.496 forks)batch import
good first issuehacktoberfestmodules

Description

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.

Guia do colaborador

Pilha de tecnologia
None
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic knowledge of Logstash config syntaxFamiliarity with Grok patterns
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75
Direção de pesquisa
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.