elastic/logstash

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

Open

#8,527 创建于 2017年10月25日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Ruby (14,197 star) (3,496 fork)batch import
good first issuehacktoberfestmodules

描述

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.

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic knowledge of Logstash config syntaxFamiliarity with Grok patterns
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
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.
Consider improving Logstash configs in the docs/static/filebeat_modules/*/*.conf · elastic/logstash#8527 | Good First Issue