.. _api:

structlog Package
=================

.. module:: structlog

:mod:`structlog` Package
------------------------

.. autofunction:: get_logger

----

.. autofunction:: getLogger

----

.. autofunction:: wrap_logger

----

.. autofunction:: configure

----

.. autofunction:: configure_once

----

.. autofunction:: reset_defaults

----

.. autoclass:: BoundLogger
   :members: new, bind, unbind

----

.. autoclass:: PrintLogger
   :members: msg, err, debug, info, warning, error, critical, log

----

.. autoclass:: ReturnLogger
   :members: msg, err, debug, info, warning, error, critical, log


----

.. autoexception:: DropEvent


----

.. autoclass:: BoundLoggerBase
   :members: new, bind, unbind, _logger, _process_event, _proxy_to_logger

----

:mod:`threadlocal` Module
-------------------------

.. automodule:: structlog.threadlocal

----

.. autofunction:: wrap_dict

----

.. autofunction:: tmp_bind(logger, **tmp_values)

----

.. autofunction:: as_immutable

----

.. _procs:

:mod:`processors` Module
------------------------

.. automodule:: structlog.processors

----

.. autoclass:: JSONRenderer

----

.. autoclass:: KeyValueRenderer

----

.. autofunction:: format_exc_info

----

:mod:`stdlib` Module
--------------------

.. automodule:: structlog.stdlib

----

.. autoclass:: BoundLogger

----

.. autoclass:: LoggerFactory
   :members: __call__

----

.. autofunction:: filter_by_level

----

:mod:`twisted` Module
---------------------

.. automodule:: structlog.twisted

----

.. autoclass:: BoundLogger
   :members: bind, unbind, new, msg, err

----

.. autoclass:: LoggerFactory

----

.. autoclass:: EventAdapter

----

.. autoclass:: JSONRenderer

----

.. autofunction:: plainJSONStdOutLogger

----

.. autofunction:: JSONLogObserverWrapper

----

.. autoclass:: PlainFileLogObserver
