# Documentação Django 5.2.8

# Logging

Ver também

- How to configure and use logging

- Django logging reference

Python programmers will often use `print()` in their code as a quick and convenient debugging tool. Using the logging framework is only a little more effort than that, but it’s much more elegant and flexible. As well as being useful for debugging, logging can also provide you with more - and better structured - information about the state and health of your application.

## Visão Geral

Django uses and extends Python’s builtin `logging` module to perform system logging. This module is discussed in detail in Python’s own documentation; this section provides a quick overview.

### O elenco de jogadores

A configuração de logs do Python é composta por quatro partes:

- Loggers

- Manipuladores

- Filtros

- Formatadores

#### Loggers

A logger is the entry point into the logging system. Each logger is a named bucket to which messages can be written for processing.

O 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:

- `DEBUG`: 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.

Quando 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.

Se o logger determinar que a mensagem precisa ser processada, ela será passada para um Handler.

#### Manipuladores

The handler is the engine that determines what happens to each message 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.

Assim 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.

Cada 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.

#### Filtros

A filter is used to provide additional control over which log records are passed from logger to handler.

Por 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.

#### Formatadores

Ultimately, a log record needs to be rendered as text. Formatters describe the exact format of that text. A formatter usually consists of a Python formatting string containing LogRecord attributes; however, you can also write custom formatters to implement specific formatting behavior.

## Security implications

The logging system handles potentially sensitive information. For example, the log record may contain information about a web request or a stack trace, while some of the data you collect in your own loggers may also have security implications. You need to be sure you know:

- what 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 designate certain sensitive information to be filtered out of error reports – read more about how to filter error reports.

### `AdminEmailHandler`

The built-in `AdminEmailHandler` deserves a mention in the context of security. If its `include_html` option is enabled, the email message it sends will contain a full traceback, with names and values of local variables at each level of the stack, plus the values of your Django settings (in other words, the same level of detail that is exposed in a web page when `DEBUG` is `True`).

It’s generally not considered a good idea to send such potentially sensitive information over email. Consider instead using one of the many third-party services to which detailed logs can be sent to get the best of multiple worlds – the rich information of full tracebacks, clear management of who is notified and has access to the information, and so on.

## Configuring logging

A 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.

In order to configure logging, you use `LOGGING` to define a dictionary of logging settings. These settings describe the loggers, handlers, filters and formatters that you want in your logging setup, and the log levels and other properties that you want those components to 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 set to `True` (which is the `dictConfig` default if the key is missing) then all loggers from the default configuration will be disabled. Disabled loggers are not the same as removed; the logger will still exist, but will silently discard anything logged to it, not even propagating entries to a parent logger. Thus you should be very careful using `'disable_existing_loggers': True`; it’s probably not what you want. Instead, you can set `disable_existing_loggers` to `False` and redefine some or all of the default loggers; or you can set `LOGGING_CONFIG` to `None` and 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.

### Exemplos

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.

To begin, here’s a small configuration that will allow you to output all log messages to the console:

`settings.py`

    import os

    LOGGING = {
        "version": 1,
        "disable_existing_loggers": False,
        "handlers": {
            "console": {
                "class": "logging.StreamHandler",
            },
        },
        "root": {
            "handlers": ["console"],
            "level": "WARNING",
        },
    }

This configures the parent `root` logger to send messages with the `WARNING` level and higher to the console handler. By adjusting the level to `INFO` or `DEBUG` you can display more messages. This may be useful during development.

Next we can add more fine-grained logging. Here’s an example of how to make the logging system print more messages from just the django named logger:

`settings.py`

    import os

    LOGGING = {
        "version": 1,
        "disable_existing_loggers": False,
        "handlers": {
            "console": {
                "class": "logging.StreamHandler",
            },
        },
        "root": {
            "handlers": ["console"],
            "level": "WARNING",
        },
        "loggers": {
            "django": {
                "handlers": ["console"],
                "level": os.getenv("DJANGO_LOG_LEVEL", "INFO"),
                "propagate": False,
            },
        },
    }

By default, this config sends messages from the `django` logger of level `INFO` or higher to the console. This is the same level as Django’s default logging config, except that the default config only displays log records when `DEBUG=True`. Django does not log many such `INFO` level messages. With this config, however, you can also set the environment variable `DJANGO_LOG_LEVEL=DEBUG` to see all of Django’s debug logging which is very verbose as it includes all database queries.

You don’t have to log to the console. Here’s a configuration which writes all logging from the django named logger to a local file:

`settings.py`

    LOGGING = {
        "version": 1,
        "disable_existing_loggers": False,
        "handlers": {
            "file": {
                "level": "DEBUG",
                "class": "logging.FileHandler",
                "filename": "/path/to/django/debug.log",
            },
        },
        "loggers": {
            "django": {
                "handlers": ["file"],
                "level": "DEBUG",
                "propagate": True,
            },
        },
    }

Se 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:

`settings.py`

    LOGGING = {
        "version": 1,
        "disable_existing_loggers": False,
        "formatters": {
            "verbose": {
                "format": "{levelname} {asctime} {module} {process:d} {thread:d} {message}",
                "style": "{",
            },
            "simple": {
                "format": "{levelname} {message}",
                "style": "{",
            },
        },
        "filters": {
            "special": {
                "()": "project.logging.SpecialFilter",
                "foo": "bar",
            },
            "require_debug_true": {
                "()": "django.utils.log.RequireDebugTrue",
            },
        },
        "handlers": {
            "console": {
                "level": "INFO",
                "filters": ["require_debug_true"],
                "class": "logging.StreamHandler",
                "formatter": "simple",
            },
            "mail_admins": {
                "level": "ERROR",
                "class": "django.utils.log.AdminEmailHandler",
                "filters": ["special"],
            },
        },
        "loggers": {
            "django": {
                "handlers": ["console"],
                "propagate": True,
            },
            "django.request": {
                "handlers": ["mail_admins"],
                "level": "ERROR",
                "propagate": False,
            },
            "myproject.custom": {
                "handlers": ["console", "mail_admins"],
                "level": "INFO",
                "filters": ["special"],
            },
        },
    }

Essa configuração de log faz o seguinte:

- Identifica a configuração como sendo da ‘versão 1 do formato dictConfig’. Atualmente, essa é a única versão disponível.

- Define dois formatters:

  - `simple`, that outputs the log level name (e.g., `DEBUG`) and the log message.

    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:

  - `project.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:

  - `console`, a `StreamHandler`, which prints any `INFO` (or higher) message to `sys.stderr`. This handler uses the `simple` output format.

  - `mail_admins`, an `AdminEmailHandler`, which emails any `ERROR` (or higher) message to the site `ADMINS`. This handler uses the `special` filter.

- Configura três loggers:

  - `django`, 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.

### Configurações customizadas de log

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.

The `LOGGING_CONFIG` setting defines the callable that will be used to configure Django’s loggers. By default, it points at Python’s `logging.config.dictConfig()` function. However, if you want to use a different configuration process, you can use any other callable that takes a single argument. The contents of `LOGGING` will be provided as the value of that argument when logging is configured.

### Desabilitando a configuração de log

If you don’t want to configure logging at all (or you want to manually configure logging using your own approach), you can set `LOGGING_CONFIG` to `None`. This will disable the configuration 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 manually configures logging:

`settings.py`

    LOGGING_CONFIG = None

    import logging.config

    logging.config.dictConfig(...)

Note that the default configuration process only calls `LOGGING_CONFIG` once settings are fully-loaded. In contrast, manually configuring the logging in your settings file will load your logging config immediately. As such, your logging config must appear after any settings on which it depends.