[doc] Update documentation on logging optimization. (GH-22075)

This commit is contained in:
Vinay Sajip 2020-09-03 19:44:12 +01:00 committed by GitHub
parent e55a0e971b
commit cdbff3527c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 14 deletions

View File

@ -1078,20 +1078,22 @@ need more precise control over what logging information is collected. Here's a
list of things you can do to avoid processing during logging which you don't list of things you can do to avoid processing during logging which you don't
need: need:
+-----------------------------------------------+----------------------------------------+ +-----------------------------------------------------+---------------------------------------------------+
| What you don't want to collect | How to avoid collecting it | | What you don't want to collect | How to avoid collecting it |
+===============================================+========================================+ +=====================================================+===================================================+
| Information about where calls were made from. | Set ``logging._srcfile`` to ``None``. | | Information about where calls were made from. | Set ``logging._srcfile`` to ``None``. |
| | This avoids calling | | | This avoids calling :func:`sys._getframe`, which |
| | :func:`sys._getframe`, which may help | | | may help to speed up your code in environments |
| | to speed up your code in environments | | | like PyPy (which can't speed up code that uses |
| | like PyPy (which can't speed up code | | | :func:`sys._getframe`). |
| | that uses :func:`sys._getframe`). | +-----------------------------------------------------+---------------------------------------------------+
+-----------------------------------------------+----------------------------------------+ | Threading information. | Set ``logging.logThreads`` to ``False``. |
| Threading information. | Set ``logging.logThreads`` to ``0``. | +-----------------------------------------------------+---------------------------------------------------+
+-----------------------------------------------+----------------------------------------+ | Current process ID (:func:`os.getpid`) | Set ``logging.logProcesses`` to ``False``. |
| Process information. | Set ``logging.logProcesses`` to ``0``. | +-----------------------------------------------------+---------------------------------------------------+
+-----------------------------------------------+----------------------------------------+ | Current process name when using ``multiprocessing`` | Set ``logging.logMultiprocessing`` to ``False``. |
| to manage multiple processes. | |
+-----------------------------------------------------+---------------------------------------------------+
Also note that the core logging module only includes the basic handlers. If Also note that the core logging module only includes the basic handlers. If
you don't import :mod:`logging.handlers` and :mod:`logging.config`, they won't you don't import :mod:`logging.handlers` and :mod:`logging.config`, they won't