Где полный пример logging.config.dictConfig?

133

Я бы хотел использовать dictConfig , но документация немного абстрактна. Где я могу найти конкретный пример словаря с возможностью копирования и вставки dictConfig?

Дэвид Волевер
источник

Ответы:

202

Как насчет здесь!

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
        },
    } 
}

Использование:

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

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

Если вы видите слишком много журналов из сторонних пакетов, обязательно запустите эту конфигурацию, используя logging.config.dictConfig(LOGGING_CONFIG) перед импортом сторонних пакетов.

Ссылка: https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema

Дейв
источник
11
Есть альтернативное место для указания rootрегистратора: на верхнем уровне словаря. Он описан в документации , имеет преимущество перед тем, ['loggers']['']когда присутствуют оба, но, на мой взгляд, ['loggers']['']более логичен. См. Также обсуждение здесь
Энтони Хэтчкинс
2
Все эти краткие и красивые фрагменты YAML в документации python logging.config просто невозможно прочитать напрямую. Облом.
JimB
Разве это не специфично для джанго? Что делать, если я использую другой фреймворк (Flask, Bottle и т. Д.) Или даже не работаю над веб-приложением?
Адам Паркин
Это похоже на чит, так 'disable_existing_loggers': Falseкак тогда вы, возможно, не настраиваете его целиком, но, возможно, повторно используете что-то, что уже есть ... Если вы установите его, Trueто я, похоже, не получу никакого вывода.
Nick T
Привет, @Dave, как я могу использовать собственный класс formatиз formatters?
Рафа Ачиоли
40

Принятый ответ хорош! Но что, если бы можно было начать с чего-то менее сложного? Модуль ведения журнала - очень мощная вещь, а документация немного сложна, особенно для новичков. Но для начала вам не нужно настраивать форматеры и обработчики. Вы можете добавить его, когда выясните, чего хотите.

Например:

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
источник
Это более актуальный / полезный пример, по крайней мере, в моем случае. Это был финал, logging.info('Hello, log')который заставил меня задуматься. Путаница в документации заключается в том, что с dictConfig нам больше не нужно выполнять getLoggerкакие-либо из этих действий.
Майк Уильямсон
@theotheo Можете ли вы объяснить пустой ключ '': { 'level': 'INFO'...и почему он не работает без него (например, при изменении пустого значения на допустимое значение, такое какstandard
user9074332 01
1
@MikeWilliamson: Однако может быть полезно по-прежнему звонить, getLogger()если вам нужно несколько регистраторов с разными именами. Каждый из этих регистраторов наследует конфигурацию от корневого регистратора.
Elias Strehle
3
@MikeWilliamson getLoggerвсегда необязателен. При использовании logging.info()метода напрямую используется корневой регистратор, в то время как у getLogger()вас могут быть разные регистраторы с разными именами и уровнями.
sox с Моникой
8

Пример с обработчиком потока, обработчиком файла, обработчиком вращающегося файла и обработчиком 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': 'monitoring@domain.com',
            'toaddrs': ['dev@domain.com', 'qa@domain.com'],
            '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)
Йогеш Ядав
источник
4

Я нашел конфигурацию по умолчанию для Django v1.11.15 ниже, надеюсь, это поможет

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,
        },
    }
}
天才 小飞 猫
источник
4
Этот пример хорош, но я думаю, чтобы выделиться за рамки принятого ответа, некоторые пояснения помогут.
Майк Уильямсон
-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
источник