Onde está um exemplo completo de logging.config.dictConfig?

133

Eu gostaria de usar o dictConfig , mas a documentação é um pouco abstrata. Onde posso encontrar um exemplo concreto, copiar + colar do dicionário usado dictConfig?

David Wolever
fonte

Respostas:

201

Que tal aqui!

LOGGING_CONFIG = { 
    'version': 1,
    'disable_existing_loggers': True,
    'formatters': { 
        'standard': { 
            'format': '%(asctime)s [%(levelname)s] %(name)s: %(message)s'
        },
    },
    'handlers': { 
        'default': { 
            'level': 'INFO',
            'formatter': 'standard',
            'class': 'logging.StreamHandler',
            'stream': 'ext://sys.stdout',  # Default is stderr
        },
    },
    'loggers': { 
        '': {  # root logger
            'handlers': ['default'],
            'level': 'WARNING',
            'propagate': False
        },
        'my.packg': { 
            'handlers': ['default'],
            'level': 'INFO',
            'propagate': False
        },
        '__main__': {  # if __name__ == '__main__'
            'handlers': ['default'],
            'level': 'DEBUG',
            'propagate': False
        },
    } 
}

Uso:

# Run once at startup:
logging.config.dictConfig(LOGGING_CONFIG)

# Include in each module:
log = logging.getLogger(__name__)
log.debug("Logging is configured.")

Caso você veja muitos logs de pacotes de terceiros, execute esta configuração usando logging.config.dictConfig(LOGGING_CONFIG) antes importar os pacotes de terceiros.

Referência: https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema

Dave
fonte
11
Há um local alternativo para especificar o rootcriador de logs: no nível superior do dicionário. É descrito nos documentos , tem preferência sobre ['loggers']['']quando ambos estão presentes, mas na minha opinião, ['loggers']['']é mais lógico. Veja também a discussão aqui
Antony Hatchkins
2
Todos esses trechos YAML concisos e bonitos nos documentos python logging.config simplesmente não podem ser lidos diretamente. Vadio.
21718 JimB
Isso não é específico do django? E se eu estiver usando uma estrutura diferente (Flask, Bottle, etc), ou mesmo não trabalhando em um aplicativo Web?
Adam Parkin
Parece uma trapaça 'disable_existing_loggers': False, pois talvez você não esteja configurando todo o pano, mas talvez reutilizando algo que já está lá. Se você configurá-lo para Trueisso, parece que não recebo nenhuma saída.
Nick T
Oi @ Dave, como posso usar uma classe personalizada em formatpartir formatters?
Rafa Acioly
40

A resposta aceita é legal! Mas e se alguém pudesse começar com algo menos complexo? O módulo de registro é algo muito poderoso e a documentação é um pouco impressionante, especialmente para iniciantes. Mas, para o começo, você não precisa configurar formatadores e manipuladores. Você pode adicioná-lo quando descobrir o que deseja.

Por exemplo:

import logging.config

DEFAULT_LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'loggers': {
        '': {
            'level': 'INFO',
        },
        'another.module': {
            'level': 'DEBUG',
        },
    }
}

logging.config.dictConfig(DEFAULT_LOGGING)

logging.info('Hello, log')
theotheo
fonte
Este é o exemplo mais relevante / útil, pelo menos no meu caso. Foi a final logging.info('Hello, log')que fez as coisas clicarem para mim. A confusão na documentação é que, com o dictConfig, não precisamos mais executar getLoggernenhuma dessas ações.
Mike Williamson
@theotheo Você pode explicar a chave vazia '': { 'level': 'INFO'...e por que ele não funciona sem ele (por exemplo, ao alterar o valor em branco para um valor válido comostandard
user9074332
1
@ MikeWilliamson: No entanto, pode ser útil ligar ainda getLogger()se você quiser vários registradores com nomes diferentes. Cada um desses registradores herda a configuração do registrador raiz.
Elias Strehle 12/11/19
3
@MikeWilliamson getLoggeré sempre opcional. Ao usar o logging.info()método diretamente, o registrador raiz é usado, enquanto getLogger()você pode ter registradores diferentes, com nomes e níveis diferentes.
Sox com Monica
8

Exemplo com manipulador de fluxo, manipulador de arquivos, manipulador de arquivo rotativo e manipulador SMTP

from logging.config import dictConfig

LOGGING_CONFIG = {
    'version': 1,
    'loggers': {
        '': {  # root logger
            'level': 'NOTSET',
            'handlers': ['debug_console_handler', 'info_rotating_file_handler', 'error_file_handler', 'critical_mail_handler'],
        },
        'my.package': { 
            'level': 'WARNING',
            'propagate': False,
            'handlers': ['info_rotating_file_handler', 'error_file_handler' ],
        },
    },
    'handlers': {
        'debug_console_handler': {
            'level': 'DEBUG',
            'formatter': 'info',
            'class': 'logging.StreamHandler',
            'stream': 'ext://sys.stdout',
        },
        'info_rotating_file_handler': {
            'level': 'INFO',
            'formatter': 'info',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': 'info.log',
            'mode': 'a',
            'maxBytes': 1048576,
            'backupCount': 10
        },
        'error_file_handler': {
            'level': 'WARNING',
            'formatter': 'error',
            'class': 'logging.FileHandler',
            'filename': 'error.log',
            'mode': 'a',
        },
        'critical_mail_handler': {
            'level': 'CRITICAL',
            'formatter': 'error',
            'class': 'logging.handlers.SMTPHandler',
            'mailhost' : 'localhost',
            'fromaddr': '[email protected]',
            'toaddrs': ['[email protected]', '[email protected]'],
            'subject': 'Critical error with application name'
        }
    },
    'formatters': {
        'info': {
            'format': '%(asctime)s-%(levelname)s-%(name)s::%(module)s|%(lineno)s:: %(message)s'
        },
        'error': {
            'format': '%(asctime)s-%(levelname)s-%(name)s-%(process)d::%(module)s|%(lineno)s:: %(message)s'
        },
    },

}

dictConfig(LOGGING_CONFIG)
Yogesh Yadav
fonte
4

Encontrei a configuração padrão do Django v1.11.15 abaixo, espero que ajude

DEFAULT_LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        'require_debug_false': {
            '()': 'django.utils.log.RequireDebugFalse',
        },
        'require_debug_true': {
            '()': 'django.utils.log.RequireDebugTrue',
        },
    },
    'formatters': {
        'django.server': {
            '()': 'django.utils.log.ServerFormatter',
            'format': '[%(server_time)s] %(message)s',
        }
    },
    'handlers': {
        'console': {
            'level': 'INFO',
            'filters': ['require_debug_true'],
            'class': 'logging.StreamHandler',
        },
        'django.server': {
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'django.server',
        },
        'mail_admins': {
            'level': 'ERROR',
            'filters': ['require_debug_false'],
            'class': 'django.utils.log.AdminEmailHandler'
        }
    },
    'loggers': {
        'django': {
            'handlers': ['console', 'mail_admins'],
            'level': 'INFO',
        },
        'django.server': {
            'handlers': ['django.server'],
            'level': 'INFO',
            'propagate': False,
        },
    }
}
天才 小飞 猫
fonte
4
Este exemplo é bom, mas acho que, além da resposta aceita, algumas explicações ajudariam.
Mike Williamson
-7
#!/usr/bin/env python
# -*- coding: utf-8 -*-

import logging
import logging.handlers
from logging.config import dictConfig

logger = logging.getLogger(__name__)

DEFAULT_LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
}
def configure_logging(logfile_path):
    """
    Initialize logging defaults for Project.

    :param logfile_path: logfile used to the logfile
    :type logfile_path: string

    This function does:

    - Assign INFO and DEBUG level to logger file handler and console handler

    """
    dictConfig(DEFAULT_LOGGING)

    default_formatter = logging.Formatter(
        "[%(asctime)s] [%(levelname)s] [%(name)s] [%(funcName)s():%(lineno)s] [PID:%(process)d TID:%(thread)d] %(message)s",
        "%d/%m/%Y %H:%M:%S")

    file_handler = logging.handlers.RotatingFileHandler(logfile_path, maxBytes=10485760,backupCount=300, encoding='utf-8')
    file_handler.setLevel(logging.INFO)

    console_handler = logging.StreamHandler()
    console_handler.setLevel(logging.DEBUG)

    file_handler.setFormatter(default_formatter)
    console_handler.setFormatter(default_formatter)

    logging.root.setLevel(logging.DEBUG)
    logging.root.addHandler(file_handler)
    logging.root.addHandler(console_handler)



[31/10/2015 22:00:33] [DEBUG] [yourmodulename] [yourfunction_name():9] [PID:61314 TID:140735248744448] this is logger infomation from hello module
wcc526
fonte