boristane/logging-best-practices

Was ist logging-best-practices?

Diese Skill-Richtlinie vermittelt Best Practices für das Logging in Softwareprojekten, mit besonderem Schwerpunkt auf 'breiten Ereignissen' (auch bekannt als kanonische Log-Zeilen). Ziel ist es, Entwicklern zu helfen, aussagekräftige, strukturierte Logs zu erstellen, die sowohl für manuelles Debugging als auch für automatisierte Analysen und Überwachung optimiert sind. Der Skill unterstützt plattformunabhängig alle Arten von Anwendungen, von Microservices bis hin zu monolithischen Systemen. Er erklärt, wie man relevante Kontextinformationen pro Log-Ereignis erfasst (z. B. Benutzer-ID, Anforderungs-ID, Latenz, Fehlercode) und diese in einem einheitlichen Format protokolliert. Durch die Verwendung solcher kanonischer Log-Zeilen wird die Fehlersuche erheblich vereinfacht, da alle relevanten Daten auf einen Blick verfügbar sind, und die Integration in Log-Analyse-Tools (z. B. ELK Stack, Grafana, CloudWatch) wird nahtlos ermöglicht. Der Skill ist nützlich für jedes Team, das die Beobachtbarkeit seiner Systeme verbessern möchte.