Logging

Regta provides an opportunity to log every job output. You can specify your own logger or if you don’t, regta will use its logger with standard output with ANSI highlight. To log some job results just use return statement.

Logger Factory

You can’t specify logger as an object because of object loader and logging module specific but can specify a factory function that will return an object. See an example of a factory:

logger.py

 import logging


 def logger_factory():
     level = logging.DEBUG

     formatter = logging.Formatter('%(asctime)s [%(job)s] [%(levelname)s] - %(message)s')

     handler = logging.FileHandler('output.log')
     handler.setLevel(level)
     handler.setFormatter(formatter)

     logger = logging.getLogger(__name__)
     logger.setLevel(level)
     logger.addHandler(handler)

     return logger

Note

You can add %(job)s to your formatter to show the job’s urn.

Pass Logger

To pass logger into run command use -L/--logger option in this format: <module>:<logger_factory>.

regta run --logger logger:logger_factory

To pass logger into run function use logger argument:

import regta

from logger import logger_factory

jobs_list = []  # Stub for example

regta.run(jobs=jobs_list, logger=logger_factory())

Note

If you use in-code start, you don’t have to use logger factory, you can specify logger as an object.