:py:mod:`buildtest.log`
=======================

.. py:module:: buildtest.log

.. autoapi-nested-parse::

   Methods related to buildtest logging



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   buildtest.log.init_logfile



.. py:function:: init_logfile(logfile=BUILDTEST_LOGFILE, debug=None, loglevel='DEBUG')

   Initialize a log file intended for a builder. This requires
   passing the filename intended for the log (from the builder)
   and returns the logger.

   :param logfile: Path to logfile where buildtest will write logs
   :type logfile: str
   :param debug: To enable debugging of logs to stdout. This option is enabled via ``buildtest --debug``
   :type debug: bool, optional
   :param loglevel: This option will configure the loglevel by running `logging.setLevel <https://docs.python.org/3/library/logging.html#logging.Logger.setLevel>`_. This option is passed via ``buildtest --loglevel``
   :type loglevel: str, optional