O Django usa o módulo logging da linguagem Python para realizar logs de sistema. A utilização desse módulo é discutida em detalhes na própria documentação do Python. Contudo, se você nunca usou o framework de logs do Python (ou mesmo que você tenha usado), aqui vai um breve resumo.
A configuração de logs do Python é composta por quatro partes:
\nO logger é o ponto de entrada no sistema de logs. Cada logger é um balde nomeado para o qual mensagens podem ser escritas para serem processadas.
\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.
\nO handler ou manipulador em português, é o motor que determina o que acontece com cada mensagem em um logger. Ele descreve o comportamento de um logger em particular, tais como escrever a mensagem na tela, em um arquivo, ou em um socket de rede.
\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.
O filter ou filtro em português, é usado para fornecer controle adicional sobre quais registros de logs serão passados do logger para o 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.
\nFinalmente, um registro de log precisa ser renderizado como texto. Formatters ou formatadores em portuguẽs, descrevem o exato formato desse texto. O formatter geralmente consiste de uma string de formatação Python contendo atributos de um LogRecord; contudo, você também pode escrever um formatador customizado para implementar comportamentos específicos de formatação.
\nOnce you have configured your loggers, handlers, filters and\nformatters, you need to place logging calls into your code. Using the\nlogging framework works like this:
\n# import the logging library\nimport logging\n\n# Get an instance of a logger\nlogger = logging.getLogger(__name__)\n\ndef my_view(request, arg1, arg):\n ...\n if bad_mojo:\n # Log an error message\n logger.error('Something went wrong!')\nE é só isso! Toda vez que a condição bad_mojo for válida, um registro de log indicando um erro será gravado.
A chamada logging.getLogger() obtém (cria, se necessário) uma instância de um logger. A instância do logger é identificada por um nome. Esse nome é usado para identificar o logger para propósitos de configuração.
By convention, the logger name is usually __name__, the name of\nthe Python module that contains the logger. This allows you to filter\nand handle logging calls on a per-module basis. However, if you have\nsome other way of organizing your logging messages, you can provide\nany dot-separated name to identify your logger:
# Get an instance of a specific named logger\nlogger = logging.getLogger('project.interesting.stuff')\nOs caminhos com pontos do nome de um logger definem a hierarquia. O logger project.interesting é considerado como o pai do logger project.interesting.stuff; o logger project é o pai do logger project.interesting.
Why is the hierarchy important? Well, because loggers can be set to\npropagate their logging calls to their parents. In this way, you can\ndefine a single set of handlers at the root of a logger tree, and\ncapture all logging calls in the subtree of loggers. A logger defined\nin the project namespace will catch all logging messages issued on\nthe project.interesting and project.interesting.stuff loggers.
A propagação pode ser controlada para cada logger em especifico. Se você não quiser que um logger em particular propague para os seus pais, você pode desativar esse comportamento.
\nCada instância de um logger contém um método de entrada para cada um dos leveis padrão de log:
\nlogger.debug()
logger.info()
logger.warning()
logger.error()
logger.critical()
Existem ainda outras duas chamadas de log disponíveis:
\nlogger.log(): Emite manualmente uma mensagem de log com um level de log em específico.
logger.exception(): Cria uma mensagem de log usando o level ERROR envolvendo a stack frame, ou estrutura de pilha em português, da exceção atual.
It isn’t enough to just put logging calls into your code. You also need to\nconfigure the loggers, handlers, filters, and formatters to ensure you can use\nthe logging output.
\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 emails any ERROR\n(or higher) message to the site ADMINS. This handler uses the\nspecial 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.
\nA configuração LOGGING_CONFIG define o callable que será usado para configurar os loggers do Django. Por padrão, ele aponta para a função logging.config.dictConfig() do Python. Contudo, se você quiser usar um processo diferente de configuração, você pode usar qualquer outro callable que recebe um único argumento. O conteúdo de LOGGING será fornecido como sendo o valor do argumento onde o log será configurado.
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\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.
O Django fornece uma série de recursos para lidar com requisitos únicos de log em ambientes de Web servers.
\nO Django fornece vários loggers embutidos.
\ndjangoLink para este cabeçalho#The catch-all logger for messages in the django hierarchy. No messages are\nposted using this name but instead using one of the loggers below.
django.requestLink para este cabeçalho#Log messages related to the handling of requests. 5XX responses are\nraised as ERROR messages; 4XX responses are raised as WARNING\nmessages. Requests that are logged to the django.security logger aren’t\nlogged to django.request.
Mensagens para esse logger possuem o seguinte contexto adicional:
\nstatus_code: o código da resposta HTTP associado a requisição.
request: O objeto da requisição que gerou a mensagem de log.
django.serverLink para este cabeçalho#Mensagens de log relacionadas com a manipulação de requisições recebidas pelo comando runserver. Respostas HTTP 5XX são logadas como mensagens do tipo ERROR, respostas HTTP 4XX são logadas como mensagens do tipo WARNING, e todo o resto é logado como INFO.
Mensagens para esse logger possuem o seguinte contexto adicional:
\nstatus_code: o código da resposta HTTP associado a requisição.
request: O objeto da requisição que gerou a mensagem de log.
django.templateLink para este cabeçalho#Mensagens de log relacionadas a renderização de templates.
\nVariáveis de contexto esquecidas são logadas como mensagens do tipo DEBUG.
django.db.backendsLink para este cabeçalho#Mensagens relacionadas a interação de código com o banco de dados. Por exemplo, cada comando SQL executado por uma requisição é logada no level DEBUG para esse logger.
Mensagens para esse logger possuem o seguinte contexto adicional:
\nduration: O tempo tomado para executar o comando SQL.
sql: O comando SQL que foi executado.
params: Os parâmetros que foram usados na chamada SQL.
Por questões de performance, o log de SQL só é ativado quando settings.DEBUG é configurado como True, independentemente do level de log ou dos handlers que estão instalados.
Nesse logger não estão incluídos initializações a level de framework (ex SET TIMEZONE) ou consultas relacionadas ao gerenciamento de transações (ex BEGIN, COMMIT, e ROLLBACK). Ative o log de consultas no seu banco de dados se você desejar ver todas as consultas de banco.
django.security.*Link para este cabeçalho#Os loggers de segurança irão receber mensagens em qualquer ocorrência de SuspiciousOperation e outros erros relacionados a segurança. Existe um sub-logger para cada subtipo de erro de segurança, incluindo todos do tipo SuspiciousOperations. O level de log depende de onde a exceção for manipulada. A maioria das ocorrências serão logadas como um aviso. enquanto que qualquer SuspiciousOperations que alcançar o handler WSGI será logada como um erro. Por exemplo, quando um cabeçalho HTTP Host é incluído em uma requisição de um cliente que não for encontrado em ALLOWED_HOSTS, Django irá retornar uma resposta 400, e uma mensagem de erro será logada para o logger django.security.DisallowedHost.
Esses eventos de log irão alcançar o logger django por padrão, que irá enviar emails de eventos de erro para os administradores quando DEBUG=False. Requisições resultando em uma resposta 400 devido a uma SuspiciousOperation não serão logadas no logger django.request, mas somente para o logger django.security.
To silence a particular type of SuspiciousOperation, you can override that\nspecific logger following this example:
'handlers': {\n 'null': {\n 'class': 'logging.NullHandler',\n },\n},\n'loggers': {\n 'django.security.DisallowedHost': {\n 'handlers': ['null'],\n 'propagate': False,\n },\n},\nOutros loggers django.security não baseados em SuspiciousOperation são:
django.security.csrf: Para falhas CSRF.
django.db.backends.schemaLink para este cabeçalho#Loga as consultas SQL que são executadas durante mudanças de esquema no banco de dados pelo migrations framework. Note que ele não irá logar as consultas executadas pela classe RunPython. As mensagens para esse logger possuem params e sql em seu contexto extra (mas ao contrário de django.db.backends, não possui duration). Os valores tem o mesmo significado como explicado em django.db.backends.
O Django fornece um handler de log adicional para os já fornecidos pelo módulo de log do Python.
\nThis handler sends an email to the site ADMINS for each log\nmessage it receives.
Se o registro de log contém um atributo request, todos os detalhes da requisição serão incluídos no email. O assunto do email irá incluir a fase “internal IP” se o endereço IP do cliente foi informado em INTERNAL_IPS; Caso contrário, ele irá incluir o “EXTERNAL IP”.
Se o registro de log contiver infromações de rastreamento de pilha, o rastreamento de pilha será incluído no email.
\nThe include_html argument of AdminEmailHandler is used to\ncontrol whether the traceback email includes an HTML attachment\ncontaining the full content of the debug Web page that would have been\nproduced if DEBUG were True. To set this value in your\nconfiguration, include it in the handler definition for\ndjango.utils.log.AdminEmailHandler, like this:
'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'class': 'django.utils.log.AdminEmailHandler',\n 'include_html': True,\n }\n},\nNote que a versão HTML do email contém um traceback completo, com nomes e valores de variáveis locais em cada level da pilha, além dos valores da sua configuração do Django. Essa informação é potencialmente muito sensível, e você pode não querer enviá-la por email. Considere usar algo como Sentry para obter o melhor dos dois mundos – a rica informação dos tracebacks completos e mais a segurança de não enviar informações por email. Você pode também explicitamente designar certas informações sensíveis para serem filtradas para fora dos relatórios de erro – saiba mais em Filtrando relatórios de erro.
\nBy setting the email_backend argument of AdminEmailHandler, the\nemail backend that is being used by the\nhandler can be overridden, like this:
'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'class': 'django.utils.log.AdminEmailHandler',\n 'email_backend': 'django.core.mail.backends.filebased.EmailBackend',\n }\n},\nPor padrão, uma instância do backend de email especificado em EMAIL_BACKEND será usado.
The reporter_class argument of AdminEmailHandler allows providing\nan django.views.debug.ExceptionReporter subclass to customize the\ntraceback text sent in the email body. You provide a string import path to\nthe class you wish to use, like this:
'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'class': 'django.utils.log.AdminEmailHandler',\n 'include_html': True,\n 'reporter_class': 'somepackage.error_reporter.CustomErrorReporter'\n }\n},\nEnvia emails para os usuários administradores. Para customizar esse comportamento, você pode fazer uma subclasse de AdminEmailHandler e sobrescrever esse método.
Django provides some log filters in addition to those provided by the Python\nlogging module.
\nEsse filter aceita uma função de callback (que deve aceitar um único argumento, o registro a ser logado), e chama essa função para cada registro que passa pelo filter. A manipulação desse registro não será continuada caso a função de callback retorne False.
\nPor exemplo, para filtrar para fora exceções do tipo UnreadablePostError (levantadas quando o usuário cancela um upload) de emails destinadoas a administradores, você teria que criar uma função de filtro:
from django.http import UnreadablePostError\n\ndef skip_unreadable_post(record):\n if record.exc_info:\n exc_type, exc_value = record.exc_info[:2]\n if isinstance(exc_value, UnreadablePostError):\n return False\n return True\nand then add it to your logging config:
\n'filters': {\n 'skip_unreadable_posts': {\n '()': 'django.utils.log.CallbackFilter',\n 'callback': skip_unreadable_post,\n }\n},\n'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'filters': ['skip_unreadable_posts'],\n 'class': 'django.utils.log.AdminEmailHandler'\n }\n},\nEsse filtro irá passar adiante registros de logs somente quando settings.DEBUG for False.
\nThis filter is used as follows in the default LOGGING\nconfiguration to ensure that the AdminEmailHandler only sends\nerror emails to admins when DEBUG is False:
'filters': {\n 'require_debug_false': {\n '()': 'django.utils.log.RequireDebugFalse',\n }\n},\n'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'filters': ['require_debug_false'],\n 'class': 'django.utils.log.AdminEmailHandler'\n }\n},\nEsse filtro é similar a RequireDebugFalse, exceto pelo fato de que os registros são passados adiante somente quando DEBUG é True.
Por padrão, o Django configura o log da seguinte forma:
\nQuando DEBUG é True:
The django logger sends messages in the django hierarchy (except\ndjango.server) at the INFO level or higher to the console.
Quando DEBUG é False:
The django logger sends messages in the django hierarchy (except\ndjango.server) with ERROR or CRITICAL level to\nAdminEmailHandler.
Independentemente do valor de DEBUG:
The django.server logger sends messages at the INFO level\nor higher to the console.
All loggers except django.server propagate logging to their\nparents, up to the root django logger. The console and mail_admins\nhandlers are attached to the root logger to provide the behavior described\nabove.
See also Configuring logging to learn how you can\ncomplement or replace this default logging configuration defined in\ndjango/utils/log.py.
\n