Skip to content

Improve production logging for minimum pertinent details and clarify use of logging.info vs logging.debug #50

@blue442

Description

@blue442

Currently, the logging in production does not provide the minimum required details to ensure proper functioning of the service. This issue proposes an enhancement to the logging system so that it consistently records key events, errors, and relevant metadata, helping with debugging and monitoring in live environments.

Additionally, this issue requires a clear distinction between the use of logging.info and logging.debug:

  • logging.info should be used for recording significant runtime events, such as service start/stop, key user actions, and important state changes that are relevant for operational monitoring and troubleshooting in production.
  • logging.debug should be used for verbose output intended for development or detailed investigation, such as variable values, detailed execution flow, and non-critical events that are not required in standard production monitoring.

The logging level (e.g., INFO, DEBUG) should be configurable using an environment variable, allowing different verbosity in production and development environments without code changes.

Acceptance Criteria:

  • Update logging configuration to capture essential information (request IDs, timestamps, error messages, user actions, etc.)
  • Ensure logs do not include sensitive data
  • Make logging level configurable via an environment variable
  • Document the updated logging strategy and the use of environment variables for logging level
  • Test logging in a production-like environment to verify completeness and clarity

This will improve operational visibility and make troubleshooting issues in production more efficient.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions