jame-developer / gelf-logger Goto Github PK

Description

The goal of this task is to integrate our existing Go package, which acts as a GELF compatible server logger, with the zap logging library. Just like the current setup where we have integrated with zerolog and provided a writer as a MultilevelWriter, similar implementation is expected for zap logger.

Task Details

1. Study the Zap logger: Understand the architecture of zap logger. Find out how it manages logging levels and how it writes to different output destinations.
2. Create a Zap Writer: Model a new writer that can take the logs from zap and send it to our GELF server. This includes working out error handling and any buffering or concurrency issues.
3. Manage Logging Levels: Just like our zerolog integration which handles multi levels, implement handling of zap logger's multi level logs in our integration.
4. Test the Integration: Write unit test cases to validate the integration. Ensure that logs are correctly getting sent to the GELF server and that all logging levels as per zap logger's standards are handled properly.
5. Documentation: Update the project's readme file with new updates to describe how to use the project with zap logger.
6. We would also need to maintain the current integration with zerolog while adding this zap logger functionality.

Deliverables

• New Zap logger integration with GELF server log package.
• Unit tests validating the correct behavior of new zap logger integration.
• Updated readme describing the use of new zap logger integration.

Definition of Done

• The task would be considered done when the zap logger can successfully redirect logs of all levels to the GELF server, without impacting the current zerolog integration. All new and modified functions should have unit tests, and all tests must pass.