logging の StreamHandler におけるsetLevelの役割

Question

print関数から脱却すべくloggingの勉強を始めました。

色々なサイトを読んでいると、

import logging

logging.basicConfig(level=logging.DEBUG)

などのように書いてしまうとグローバルに変更されてしまうので、
loggerを作成してそれぞれに設定していくのが良いというのをよく目にしたのでそのようにしようと考えました。

そのため以下のように書くようにしました。

from logging import getLogger, StreamHandler, DEBUG

logger = getLogger('__name__')
handler = StreamHandler()
handler.setLevel(DEBUG)
logger.addHandler(handler)

このようにして、logger.debug('debug')と入力してもdebug出力されません。

色々なサイトを見るとlogger.setLevel(DEBUG)のようにlogger自身にレベルが設定されているようです。

ここでhandlerに対してsetLevelを行うだけでは出力されない理由がよくわかりません。

StreamHandlerは標準出力についての設定ではないのでしょうか？

Answer 1

簡単に説明すると、

• Loggerのレベル：Handlerに渡すログのレベルを設定
• Handlerのレベル：出力するログのレベルを設定

ですので、いくらHandlerのレベルが問題なくても、Loggerのレベルによっては**『ログがHandlerに渡されない』**為にログ出力はされません

で、実際のLoggerに設定されているレベルを確認してみると、以下のようになってます。

from logging import getLogger, StreamHandler, DEBUG

logger = getLogger('TEST')
handler = StreamHandler()
handler.setLevel(DEBUG)
logger.addHandler(handler)

# Loggerのレベルを確認
print(logger.level)
#0 (NOTSET)

# NOTSETの場合、親のレベルに委譲するので親のLoggerのレベルを確認
print(logger.parent.level)
#30 (WARNING)

# 実際に有効なLoggerのレベルはこのAPIでも確認できる
print(logger.getEffectiveLevel())
#30 (WARNING)

# Handlerのレベルを確認
print(handler.level)
#10 (DEBUG)

logger.debug('Hello 1')
#表示しない

このようにLoggerのレベルはデフォルトにて 'NOTSET'となっておりますので、Root Level Loggerのレベルに委譲（Root Level Loggerのデフォルトの設定値'WARNING'）されます。よってDEBUG LEVELのログはそもそもHandlerに渡されませんので当然出力もしません。

ですので、出力をするには Loggerの設定を変える必要があります。

logger.setLevel(DEBUG)
print(logger.level)
#10 (DEBUG)

logger.debug('Hello 2')
#Hello 2 #（出力される）

Comments

[hi-se]

理解できました。

丁寧な説明ありがとうございます。