47 lines
1.6 KiB
ReStructuredText
47 lines
1.6 KiB
ReStructuredText
:orphan:
|
|
|
|
.. versionadded:: 0.6.0
|
|
.. _logging_setup:
|
|
|
|
Setting Up Logging
|
|
===================
|
|
|
|
*discord.py* logs errors and debug information via the :mod:`logging` python
|
|
module. It is strongly recommended that the logging module is
|
|
configured, as no errors or warnings will be output if it is not set up.
|
|
Configuration of the ``logging`` module can be as simple as::
|
|
|
|
import logging
|
|
|
|
logging.basicConfig(level=logging.INFO)
|
|
|
|
Placed at the start of the application. This will output the logs from
|
|
discord as well as other libraries that use the ``logging`` module
|
|
directly to the console.
|
|
|
|
The optional ``level`` argument specifies what level of events to log
|
|
out and can be any of ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO``, and
|
|
``DEBUG`` and if not specified defaults to ``WARNING``.
|
|
|
|
More advanced setups are possible with the :mod:`logging` module. For
|
|
example to write the logs to a file called ``discord.log`` instead of
|
|
outputting them to the console the following snippet can be used::
|
|
|
|
import discord
|
|
import logging
|
|
|
|
logger = logging.getLogger('discord')
|
|
logger.setLevel(logging.DEBUG)
|
|
handler = logging.FileHandler(filename='discord.log', encoding='utf-8', mode='w')
|
|
handler.setFormatter(logging.Formatter('%(asctime)s:%(levelname)s:%(name)s: %(message)s'))
|
|
logger.addHandler(handler)
|
|
|
|
This is recommended, especially at verbose levels such as ``INFO``
|
|
and ``DEBUG``, as there are a lot of events logged and it would clog the
|
|
stdout of your program.
|
|
|
|
|
|
|
|
For more information, check the documentation and tutorial of the
|
|
:mod:`logging` module.
|