Add console handler for logging

[niksirbi]

Our current logging configuration only adds a rotating file handler, and does not configure a console handler. This means:

• All log messages at the DEBUG level and above are written to the log file.
• No log messages are output to the console.

What we would actually want:

• INFO, WARNING, and ERROR messages should be printed both to the log file and the console.
• DEBUG messages should be written only to the log file.

To achieve this behaviour, we need to add a console handler to our logger and set the appropriate log levels for both handlers.

[niksirbi]

We could also use loguru or fancylog to reduce the amount of logging configuration we have to do on our side.

If we go with fancylog, we'd have to first address this issue.

[sfmig]

naive question:

is it a matter of adding a

import logging
logging.getLogger().setLevel(logging.INFO)

?

EDIT: we confirm this was indeed naive 😬

I had in my notes that this logging tutorial was useful so linking here in case it helps

[niksirbi]

Todays discussions with @sfmig about logging made me look into this issue again, and I think this may be a one-line-ish fix.

The problem is that the log_warning utility only logs the warning message, and doesn't actually emit a warning! 🤦🏼
This is totally on me!

It should be changed to sth like this:

def log_warning(message: str, logger_name: str = "movement"):
    """Log a warning message and emit a UserWarning.

    Parameters
    ----------
    message : str
        The warning message.
    logger_name : str, optional
        The name of the logger to use. Defaults to "movement".

    """
    logger = logging.getLogger(logger_name)
    logger.warning(message)
    warnings.warn(message, UserWarning, stacklevel=2)

[niksirbi]

I've started attempting a fix in #412

I think it works, based on the fact that warning messages that we were missing before started appearing now.
For example, attempting to import sample_data without an internet now results in:

/Users/nsirmpilatze/Code/NIU/movement/movement/sample_data.py:105: UserWarning: Failed to download the newest sample metadata file. Will use the existing local version instead.

The absence of this message was what made us notice the problem in the first place, right @sfmig?

If I'm right #412 is sufficient to close this issue. The problem now is that tests now emit >100 warnings, because of all the times they hit a log_warning statement. We have to filter those somehow, to minimise pytest noise.

[sfmig]

The absence of this message was what made us notice the problem in the first place, right @sfmig?

I think so, yes!

The problem now is that tests now emit >100 warnings

Would this be reduced if we set the logging level to INFO rather than DEBUG by default (so the opposite change of PR #411 )

[niksirbi]

Would this be reduced if we set the logging level to INFO rather than DEBUG by default (so the opposite change of PR #411 )

No that's unrelated I think. The warnings are emitted because of the warnings.warn statement I added in #411, not by the logging of those warnings (which was happening before anyway).