============================= Structured Logging for Python ============================= Release v\ |version| (:doc:`What's new? `). .. include:: ../README.rst :start-after: -begin-short- :end-before: -end-short- First steps: - If you're not sure whether ``structlog`` is for you, have a look at :doc:`why`. - If you can't wait to log your first entry, start at :doc:`getting-started` and then work yourself through the basic docs. - Once you have basic grasp of how ``structlog`` works, acquaint yourself with the `integrations <#integration-with-existing-systems>`_ ``structlog`` is shipping with. User's Guide ============ Basics ------ .. toctree:: :maxdepth: 1 why getting-started loggers configuration thread-local processors examples development Integration with Existing Systems --------------------------------- ``structlog`` can be used immediately with *any* existing logger. However it comes with special wrappers for the Python standard library and Twisted that are optimized for their respective underlying loggers and contain less magic. .. toctree:: :maxdepth: 1 standard-library twisted logging-best-practices Advanced Topics --------------- .. toctree:: :maxdepth: 1 custom-wrappers performance API Reference ============= .. toctree:: :maxdepth: 4 api .. include:: ../README.rst :start-after: -begin-meta- .. toctree:: :maxdepth: 1 backward-compatibility contributing license changelog Indices and tables ================== - :ref:`genindex` - :ref:`modindex` - :ref:`search`