Refs #32880 -- Improved some headings and text in logging topic.

This commit is contained in:
Daniele Procida 2021-06-24 13:41:56 +02:00 committed by GitHub
parent 27e156fa31
commit 64839512a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions

View File

@ -5,8 +5,8 @@ Logging
.. module:: django.utils.log .. module:: django.utils.log
:synopsis: Logging tools for Django applications :synopsis: Logging tools for Django applications
A quick logging primer Overview
====================== ========
Django uses Python's builtin :mod:`logging` module to perform system logging. Django uses Python's builtin :mod:`logging` module to perform system logging.
The usage of this module is discussed in detail in Python's own documentation. The usage of this module is discussed in detail in Python's own documentation.
@ -68,7 +68,7 @@ it is passed to a *Handler*.
Handlers Handlers
~~~~~~~~ ~~~~~~~~
The handler is the engine that determines what happens to each message The *handler* is the engine that determines what happens to each message
in a logger. It describes a particular logging behavior, such as in a logger. It describes a particular logging behavior, such as
writing a message to the screen, to a file, or to a network socket. writing a message to the screen, to a file, or to a network socket.
@ -89,7 +89,7 @@ file for later analysis.
Filters Filters
~~~~~~~ ~~~~~~~
A filter is used to provide additional control over which log records A *filter* is used to provide additional control over which log records
are passed from logger to handler. are passed from logger to handler.
By default, any log message that meets log level requirements will be By default, any log message that meets log level requirements will be
@ -111,14 +111,14 @@ can be used in a chain to perform multiple filtering actions.
Formatters Formatters
~~~~~~~~~~ ~~~~~~~~~~
Ultimately, a log record needs to be rendered as text. Formatters Ultimately, a log record needs to be rendered as text. *Formatters*
describe the exact format of that text. A formatter usually consists describe the exact format of that text. A formatter usually consists
of a Python formatting string containing of a Python formatting string containing
:ref:`LogRecord attributes <python:logrecord-attributes>`; however, :ref:`LogRecord attributes <python:logrecord-attributes>`; however,
you can also write custom formatters to implement specific formatting behavior. you can also write custom formatters to implement specific formatting behavior.
Using logging How to use logging
============= ==================
Once you have configured your loggers, handlers, filters and Once you have configured your loggers, handlers, filters and
formatters, you need to place logging calls into your code. Using the formatters, you need to place logging calls into your code. Using the
@ -492,11 +492,11 @@ configuring the logging in your settings file will load your logging config
immediately. As such, your logging config must appear *after* any settings on immediately. As such, your logging config must appear *after* any settings on
which it depends. which it depends.
Django's logging extensions Django logging extension reference
=========================== ==================================
Django provides a number of utilities to handle the unique Django provides a number of utilities to handle the unique
requirements of logging in Web server environment. requirements of logging in a web server environment.
Loggers Loggers
------- -------