hermes - 💡(How to fix) Fix reliability(scraper): implement structured logging for scraper strategies [1 participants]

TL;DR

Implement a scoped logging mechanism to create child loggers with context for better log filtering.

Guidance

• Review the logger.ts file to determine the best approach for creating a child logger with context, such as adding a WithContext method.
• Update the AllocineScraperStrategy to create a child logger with relevant context (e.g., cinemaId, strategyName, traceId) before executing the scraping task.
• Consider adding a unique traceId to each scraping task to facilitate log correlation across different strategies.
• Evaluate the logging framework's support for log filtering and aggregation to ensure the new logging mechanism can be effectively utilized in production.

Example

// logger.ts
class Logger {
  // ...
  withContext(context: { [key: string]: string }) {
    return new ChildLogger(this, context);
  }
}

class ChildLogger extends Logger {
  constructor(parent: Logger, private context: { [key: string]: string }) {
    super();
  }

  log(message: string) {
    // Include context in log output
    super.log(`${JSON.stringify(this.context)} ${message}`);
  }
}

Notes

The implementation details of the scoped logging mechanism may vary depending on the specific logging framework being used. It's essential to review the framework's documentation to ensure the solution is compatible and effective.

Recommendation

Apply workaround: Implement a scoped logging mechanism to improve log filtering and correlation capabilities, as this will provide more targeted and actionable logging without requiring significant changes to the existing logging infrastructure.