#3279 feat: Emit structured logs and document this new capability for downstream consumers
Pull request opened by
edgarrmondragon
## Related
•
meltano/hub#2114
•
#3279
•
meltano/meltano#9506
## Summary by Sourcery
Enable structured logging throughout the Singer SDK by introducing JSON formatters, contextual logger adapters, structured error utilities, and metrics serialization, and by declaring and propagating a new structured-logging capability in plugins and templates.
New Features:
• Add JSON ConsoleFormatter and StructuredFormatter classes for structured and metric logging.
• Introduce ContextualLoggerAdapter for enriching log records with contextual information.
• Add StructuredError dataclass, error code enum, and utilities for logging and exiting on structured errors.
• Declare a new STRUCTURED_LOGGING capability and include it by default in PluginBase and cookiecutter templates.
• Implement JSON serialization for metrics via Measure.to_json and update metric emission to use structured logs.
Enhancements:
• Update default console logging setup to use the new ConsoleFormatter.
• Propagate structured-logging capability in default plugin capabilities and meltano.yml templates.
Tests:
• Add comprehensive tests for structured logging output, inclusion of structured-logging capability, and structured error handling.
## Summary by Sourcery
Enable structured logging across the Singer SDK by introducing JSON-based log formatters, contextual logging adapters, structured error utilities, metrics serialization, and a new structured-logging capability, with tests validating the end-to-end functionality
New Features:
• Add ConsoleFormatter and StructuredFormatter classes for structured and metric logging
• Introduce ContextualLoggerAdapter to enrich log records with contextual information
• Add StructuredError dataclass with error codes and utilities for structured error handling
• Implement JSON serialization for metrics and update metric emission to use structured logs
• Declare and propagate a new STRUCTURED_LOGGING capability in plugins and cookiecutter templates
Enhancements:
• Update default console logging setup to use the new ConsoleFormatter
• Include structured-logging capability by default in PluginBase and in cookiecutter templates
Tests:
• Add comprehensive tests for StructuredFormatter and ConsoleFormatter behaviors, metrics serialization, and structured logging capability declaration
meltano/sdk