Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Structured Logging and Correlation IDs #41

Open
snobbee opened this issue Dec 19, 2024 · 0 comments
Open

Implement Structured Logging and Correlation IDs #41

snobbee opened this issue Dec 19, 2024 · 0 comments
Labels

Comments

@snobbee
Copy link
Contributor

snobbee commented Dec 19, 2024

Is your feature request related to a problem? Please describe.

Initializing a repository without proper logging practices is a missed opportunity for observability, which could lead to challenges in debugging and monitoring.

Describe the solution you'd like

Implement a structured logging system that:

  • Utilizes JSON format for all logs
  • Includes essential fields such as timestamp, severity, and correlation ID
  • Supports context injection for better traceability
  • Offers different log levels (DEBUG, INFO, WARN, ERROR)
  • Allows the addition of custom fields for specific use cases
  • Provides utilities for performance logging

Describe alternatives you've considered

  • Relying on plain text logs and using grep for searching
  • Manual JSON formatting for logs
  • Using Application Performance Monitoring (APM) tools without structured logging

Additional context

Implementing these logging practices from the start will help ensure we have a solid foundation for observability, enabling easier debugging and monitoring in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant