elastic/logstash

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

Open

#8.527 geöffnet am 25. Okt. 2017

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Ruby (14.197 Stars) (3.496 Forks)batch import
good first issuehacktoberfestmodules

Beschreibung

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.

Contributor Guide

Tech Stack
Keine
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic knowledge of Logstash config syntaxFamiliarity with Grok patterns
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75
Research-Richtung
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.