Python programmers will often use print() in their code as a quick and\nconvenient debugging tool. Using the logging framework is only a little more\neffort than that, but it’s much more elegant and flexible. As well as being\nuseful for debugging, logging can also provide you with more - and better\nstructured - information about the state and health of your application.
Django uses and extends Python’s builtin logging module to perform\nsystem logging. This module is discussed in detail in Python’s own\ndocumentation; this section provides a quick overview.
A configuração de logs do Python é composta por quatro partes:
\nA logger is the entry point into the logging system. Each logger is a named\nbucket to which messages can be written for processing.
\nO logger é configurado para possuir um level de log. Esse level descreve o grau de severidade das mensagens que o logger irá manipular. O Python define os seguintes leveis de log:
\nDEBUG: Informações de sistema de baixo nível para propósitos de depuração
INFO: Informações gerais de sistema
WARNING: Informações descrevendo a ocorrência de um pequeno problema
ERROR: Informações descrevendo a ocorrência de um problema grande.
CRITICAL: Informações descrevendo a ocorrência de um problema crítico.
Cada mensagem que é escrita para o logger é um Registro de Log. Cada registro de log também tem um level de log indicando a gravidade de cada mensagem em específico. O registro de log pode conter também metadados úteis descrevendo o evento que está sendo logado. Isso pode incluir detalhes como um código de erro ou um “stack trace” ou “rastreamento de pilha” em português.
\nQuando a mensagem é dada ao logger, o level de log da mensagem é comparado com o level de log do logger. Se o level de log da mensagem for igual ou maior que o level de log do próprio logger, a mensagem seguirá em diante para processamento. Caso contrário, a mensagem será ignorada.
\nSe o logger determinar que a mensagem precisa ser processada, ela será passada para um Handler.
\nThe handler is the engine that determines what happens to each message\nin a logger. It describes a particular logging behavior, such as\nwriting a message to the screen, to a file, or to a network socket.
\nAssim como os loggers, os handlers também possuem um level de log. Se o level de um registro de log não for igual ou maior ao level do handler, o handler irá ignorar a mensagem.
\nCada logger pode ter múltiplos handlers, e cada handler pode ter um level de log diferente. Desta forma, é possível fornecer diferentes formas de notificação dependendo da importância da mensagem. Por exemplo, você pode instalar um handler que encaminha mensagens do tipo ERROR e CRITICAL para um serviço de paginação, enquanto que um segundo handler loga todas as mensagens (incluindo mensagens do tipo ERROR e CRITICAL) para um arquivo para análise posterior.
A filter is used to provide additional control over which log records\nare passed from logger to handler.
\nPor padrão, qualquer mensagem de log que satisfaça os pré-requisitos de level de log será manipulada. Contudo, instalando um filtro, você pode colocar critérios adicionais no processamento de logs. Por exemplo, você pode instalar um filtro que permite a emissão de mensagens do tipo ERROR de apenas uma fonte em particular.
Os filters também podem ser usados para modificar o registro de log antes dele ser emitido. Por exemplo, você pode escrever um filter que rebaixa registros de logs do tipo ERROR para registros do tipo WARNING se um conjunto de critérios em particular for atingido.
Filters podem ser instalados em loggers ou em handlers; múltiplos filters podem ser usados em sequência para realizar múltiplas ações de filtragem.
\nUltimately, a log record needs to be rendered as text. Formatters\ndescribe the exact format of that text. A formatter usually consists\nof a Python formatting string containing\nLogRecord attributes; however,\nyou can also write custom formatters to implement specific formatting behavior.
\nThe logging system handles potentially sensitive information. For example, the\nlog record may contain information about a web request or a stack trace, while\nsome of the data you collect in your own loggers may also have security\nimplications. You need to be sure you know:
\nwhat information is collected
where it will subsequently be stored
how it will be transferred
who might have access to it.
To help control the collection of sensitive information, you can explicitly\ndesignate certain sensitive information to be filtered out of error reports –\nread more about how to filter error reports.
\nAdminEmailHandlerLink para este cabeçalho#The built-in AdminEmailHandler deserves a mention in\nthe context of security. If its include_html option is enabled, the email\nmessage it sends will contain a full traceback, with names and values of local\nvariables at each level of the stack, plus the values of your Django settings\n(in other words, the same level of detail that is exposed in a web page when\nDEBUG is True).
It’s generally not considered a good idea to send such potentially sensitive\ninformation over email. Consider instead using one of the many third-party\nservices to which detailed logs can be sent to get the best of multiple worlds\n– the rich information of full tracebacks, clear management of who is notified\nand has access to the information, and so on.
\nA biblioteca de log do Python fornece várias técnicas para configurar o log, desde uma interface programática até arquivos de configuração. Por padrão, o Django usa o formato dictConfig.
\nIn order to configure logging, you use LOGGING to define a\ndictionary of logging settings. These settings describe the loggers,\nhandlers, filters and formatters that you want in your logging setup,\nand the log levels and other properties that you want those components\nto have.
Por padrão, a configuração LOGGING é mesclada a configuração padrão de logs do Django usando o esquema a seguir.
If the disable_existing_loggers key in the LOGGING dictConfig is\nset to True (which is the dictConfig default if the key is missing)\nthen all loggers from the default configuration will be disabled. Disabled\nloggers are not the same as removed; the logger will still exist, but will\nsilently discard anything logged to it, not even propagating entries to a\nparent logger. Thus you should be very careful using\n'disable_existing_loggers': True; it’s probably not what you want. Instead,\nyou can set disable_existing_loggers to False and redefine some or all\nof the default loggers; or you can set LOGGING_CONFIG to None\nand handle logging config yourself.
O log é configurado como parte da função geral setup() do Django. Assim sendo, você pode se certificar que os loggers estarão sempre prontos para serem usados no código do seu projeto.
A documentação completa para o formato dictConfig é a melhor fonte de informação sobre configuração de dicionários de log. Contudo, para te dar uma ideia das possibilidades, aqui vão vários exemplos.
\nTo begin, here’s a small configuration that will allow you to output all log\nmessages to the console:
\nsettings.pyimport os\n\nLOGGING = {\n "version": 1,\n "disable_existing_loggers": False,\n "handlers": {\n "console": {\n "class": "logging.StreamHandler",\n },\n },\n "root": {\n "handlers": ["console"],\n "level": "WARNING",\n },\n}\nThis configures the parent root logger to send messages with the\nWARNING level and higher to the console handler. By adjusting the level to\nINFO or DEBUG you can display more messages. This may be useful during\ndevelopment.
Next we can add more fine-grained logging. Here’s an example of how to make the\nlogging system print more messages from just the django named\nlogger:
\nsettings.pyimport os\n\nLOGGING = {\n "version": 1,\n "disable_existing_loggers": False,\n "handlers": {\n "console": {\n "class": "logging.StreamHandler",\n },\n },\n "root": {\n "handlers": ["console"],\n "level": "WARNING",\n },\n "loggers": {\n "django": {\n "handlers": ["console"],\n "level": os.getenv("DJANGO_LOG_LEVEL", "INFO"),\n "propagate": False,\n },\n },\n}\nBy default, this config sends messages from the django logger of level\nINFO or higher to the console. This is the same level as Django’s default\nlogging config, except that the default config only displays log records when\nDEBUG=True. Django does not log many such INFO level messages. With\nthis config, however, you can also set the environment variable\nDJANGO_LOG_LEVEL=DEBUG to see all of Django’s debug logging which is very\nverbose as it includes all database queries.
You don’t have to log to the console. Here’s a configuration which writes all\nlogging from the django named logger to a local file:
\nsettings.pyLOGGING = {\n "version": 1,\n "disable_existing_loggers": False,\n "handlers": {\n "file": {\n "level": "DEBUG",\n "class": "logging.FileHandler",\n "filename": "/path/to/django/debug.log",\n },\n },\n "loggers": {\n "django": {\n "handlers": ["file"],\n "level": "DEBUG",\n "propagate": True,\n },\n },\n}\nSe você usar esse exemplo, certifique-se de alterar o caminho 'filename' para um local com permissões de escrita pelo usuário que estiver rodando a aplicação Django.
Finally, here’s an example of a fairly complex logging setup:
\nsettings.pyLOGGING = {\n "version": 1,\n "disable_existing_loggers": False,\n "formatters": {\n "verbose": {\n "format": "{levelname} {asctime} {module} {process:d} {thread:d} {message}",\n "style": "{",\n },\n "simple": {\n "format": "{levelname} {message}",\n "style": "{",\n },\n },\n "filters": {\n "special": {\n "()": "project.logging.SpecialFilter",\n "foo": "bar",\n },\n "require_debug_true": {\n "()": "django.utils.log.RequireDebugTrue",\n },\n },\n "handlers": {\n "console": {\n "level": "INFO",\n "filters": ["require_debug_true"],\n "class": "logging.StreamHandler",\n "formatter": "simple",\n },\n "mail_admins": {\n "level": "ERROR",\n "class": "django.utils.log.AdminEmailHandler",\n "filters": ["special"],\n },\n },\n "loggers": {\n "django": {\n "handlers": ["console"],\n "propagate": True,\n },\n "django.request": {\n "handlers": ["mail_admins"],\n "level": "ERROR",\n "propagate": False,\n },\n "myproject.custom": {\n "handlers": ["console", "mail_admins"],\n "level": "INFO",\n "filters": ["special"],\n },\n },\n}\nEssa configuração de log faz o seguinte:
\nIdentifica a configuração como sendo da ‘versão 1 do formato dictConfig’. Atualmente, essa é a única versão disponível.
Define dois formatters:
\nsimple, that outputs the log level name (e.g., DEBUG) and the log\nmessage.
A string format é uma string normal de formatação Python descrevendo os detalhes que devem ser exibidos em cada linha de log. A lista completa de detalhes que podem ser exibidos pode ser encontrada em Formatter Objects.
verbose, que exibe o nome do level de log, a mensagem de log, e também o tempo, o processo, a thread e o módulo que gerou a mensagem de log.
Define dois filters:
\nproject.logging.SpecialFilter, utilizando o alias special. Se esse filtro necessitar de argumentos adicionais, eles podem ser fornecidos como chaves adicionais no dicionário de configuração do filter. Nesse caso, o argumento foo será dado para o valor de bar na instanciação de SpecialFilter.
django.utils.log.RequireDebugTrue, que transmite registros quando DEBUG é True.
Define dois handlers:
\nconsole, a StreamHandler, which prints any INFO\n(or higher) message to sys.stderr. This handler uses the simple\noutput format.
mail_admins, an AdminEmailHandler, which\nemails any ERROR (or higher) message to the site ADMINS.\nThis handler uses the special filter.
Configura três loggers:
\ndjango, que transmite todas as mensagens para o handler console.
django.request, que transmite todas as mensagens do tipo ERROR para o handler mail_admins. Adicionalmente, esse logger é marcado para não propagar mensagens. Isso significa que as mensagens de log gravadas em django.request não serão manipuladas pelo logger django.
myproject.custom, que transmite todas as mensagens do level INFO ou maior e que também transmite o filtro special para dois handlers – o console, e o mail_admins. Isso significa que todas as mensagens de level INFO (ou maiores) serão exibidas no console; mensagens ERROR e CRITICAL também serão emitidas via email.
Se você não quer usar o formato dictConfig do Python para configurar o seu logger, você pode especificar o seu próprio esquema de configuração.
\nThe LOGGING_CONFIG setting defines the callable that will\nbe used to configure Django’s loggers. By default, it points at\nPython’s logging.config.dictConfig() function. However, if you want to\nuse a different configuration process, you can use any other callable\nthat takes a single argument. The contents of LOGGING will\nbe provided as the value of that argument when logging is configured.
If you don’t want to configure logging at all (or you want to manually\nconfigure logging using your own approach), you can set\nLOGGING_CONFIG to None. This will disable the\nconfiguration process for Django’s default logging.
Configurar LOGGING_CONFIG como None significa tão somente que o processo de configuração automática está desabilitado, não os logs em si. Se você desabilitar o processo de configuração, o Django ainda fará chamadas de logs, recorrendo a qualquer comportamento padrão de log que for definido.
Here’s an example that disables Django’s logging configuration and then\nmanually configures logging:
\nsettings.pyLOGGING_CONFIG = None\n\nimport logging.config\n\nlogging.config.dictConfig(...)\nNote that the default configuration process only calls\nLOGGING_CONFIG once settings are fully-loaded. In contrast, manually\nconfiguring the logging in your settings file will load your logging config\nimmediately. As such, your logging config must appear after any settings on\nwhich it depends.