The Guardian is an innovative open-source platform that streamlines the creation, management, and verification of digital environmental assets. It leverages a customizable Policy Workflow Engine and Web3 technology to ensure transparent and fraud-proof operations, making it a key tool for transforming sustainability practices and carbon markets.
Our current logging system utilizes winston, which has served us well but has limitations in terms of performance and structured logging capabilities. As our application grows, we need a more efficient and feature-rich logging solution. Pino offers better performance, structured logging out of the box, and is more aligned with our future scalability needs.
Additionally, we are currently using Fastify as our web framework, which uses Pino as its default logger. By migrating our application logging to Pino, we can achieve better integration and consistency across our stack, leading to several benefits:
Unified logging: Consistent logging format and methodology across both application and server logs.
Improved performance: Pino is known for its low overhead, which aligns well with Fastify's performance-focused design.
Better integration with Fastify ecosystem: Many Fastify plugins and tools are designed to work seamlessly with Pino logs.
Simplified configuration: We can use a single configuration for both Fastify and our application logging.
Enhanced debugging: With unified logging, it's easier to trace requests through our entire system.
Requirements
Replace winston with pino as the primary logging library across the entire application.
Refactor all existing log statements to use pino's syntax and features.
Configure pino to match or improve upon our current logging levels and formats.
Implement any custom logging functions or wrappers necessary to maintain current functionality.
Ensure all error tracking and monitoring systems are compatible with the new logging format.
Update documentation to reflect the new logging practices and usage.
Integrate application logging with Fastify's Pino instance for unified logging.
Configure serializers and redaction rules (if needed) to protect sensitive data consistently across server and application logs.
Implement a flexible logging output system that allows easy configuration for multiple targets:
File output
Database storage (MongoDB)
Integration with search and analysis applications (e.g., Seq)
Console output for development environments
Definition of done
All instances of winston have been removed from the codebase and replaced with pino.
All log statements throughout the application are using pino correctly.
Log output matches or exceeds the quality and detail of the previous winston implementation.
Performance metrics show improved logging efficiency.
Documentation has been updated to reflect the new logging practices.
Fastify and application logs are unified and consistent.
Logging configuration is streamlined, using Fastify's Pino instance where appropriate.
Logging output can be easily configured for different targets (files, database, analysis tools) without (or with minimal) code changes.
Acceptance criteria
[ ] No winston imports or usage remain in the codebase.
[ ] All log levels (error, warn, info, debug, etc.) are correctly implemented in pino.
[ ] Structured logging is being used effectively, with relevant metadata included in log entries.
[ ] Log files or log streams are being correctly generated and rotated as needed.
[ ] Integration tests pass, confirming that logging doesn't break any existing functionality.
[ ] Performance tests show that logging operations are at least as fast as before, preferably faster.
[ ] Developers can successfully use the new logging system in their local development environments.
[ ] Fastify server logs and application logs show a consistent format and are easily correlated.
[ ] Sensitive data is properly redacted in both server and application logs.
[ ] Logging output can be easily switched between file, database, and search/analysis app targets through configuration changes.
[ ] Documentation is provided on how to configure different logging outputs.
Problem description
Our current logging system utilizes winston, which has served us well but has limitations in terms of performance and structured logging capabilities. As our application grows, we need a more efficient and feature-rich logging solution. Pino offers better performance, structured logging out of the box, and is more aligned with our future scalability needs. Additionally, we are currently using Fastify as our web framework, which uses Pino as its default logger. By migrating our application logging to Pino, we can achieve better integration and consistency across our stack, leading to several benefits:
Requirements
Definition of done
Acceptance criteria