Python Logging - 禁用导入模块的日志记录

问题是不带参数调用 getLogger 会返回 root 记录器，因此当您将级别设置为 logging.DEBUG 时，您也在为使用该记录器的其他模块设置级别。

您可以通过简单地不使用根记录器来解决这个问题。为此，只需将名称作为参数传递，例如模块的名称：

logger = logging.getLogger('my_module_name')
# as before

这将创建一个新的记录器，因此它不会无意中更改其他模块的日志记录级别。

显然，您必须使用 logger.debug 而不是 logging.debug，因为后者是调用根记录器的 debug 方法的便捷函数。

Advanced Logging Tutorial 中提到了这一点。它还允许您以简单的方式知道哪个模块触发了日志消息。

---

不确定这是否适合发布，但我被困了很长时间并想帮助任何有同样问题的人，因为我在其他任何地方都没有找到它！

尽管遵循了 logging advanced tutorial 和 troubleshooting 中非常简单的文档，但我还是从 matplotlib 获取调试日志。我在一个文件的 main() 中启动我的记录器并导入一个函数以从另一个文件（我已导入 matplotlib）创建一个绘图。

对我有用的是在导入 matplotlib 之前设置它的级别，而不是像我在主文件中的其他模块那样设置它之后。这对我来说似乎违反直觉，所以如果有人了解如何为尚未导入的记录器设置配置，我很想知道它是如何工作的。谢谢！

在我的主文件中：

import logging
import requests
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logging.getLogger('requests').setLevel(logging.DEBUG)

def main():
  ...

在我的 plot.py 文件中：

import logging
logging.getLogger('matplotlib').setLevel(logging.WARNING)
import matplotlib.pyplot as plt

def generatePlot():
  ...

---

如果您要使用 python logging 包，在每个使用它的模块中定义一个记录器是一个常见的约定。

logger = logging.getLogger(__name__)

许多流行的 python 包都这样做，包括 requests。如果包使用此约定，则很容易为其启用/禁用日志记录，因为记录器名称将与包相同（或将是该记录器的子级）。您甚至可以将其记录到与其他记录器相同的文件中。

logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

requests_logger = logging.getLogger('requests')
requests_logger.setLevel(logging.DEBUG)

handler = logging.StreamHandler()
handler.setLevel(logging.DEBUG)
logger.addHandler(handler)
requests_logger.addHandler(handler)

---

这将禁用所有现有记录器，例如由导入模块创建的记录器，同时仍使用根记录器（并且无需加载外部文件）。

import logging.config
logging.config.dictConfig({
    'version': 1,
    'disable_existing_loggers': True,
})

请注意，您需要先导入所有不想记录的模块！否则，这些将不会被视为“现有记录器”。然后它将禁用这些模块中的所有记录器。这可能会导致您也错过重要的错误！

有关使用相关配置选项的更详细示例，请参阅 https://gist.github.com/st4lk/6287746，here 是使用 YAML 和 coloredlog 库进行配置的（部分工作）示例。

---

@Bakuriu 非常优雅地解释了该功能。相反，您可以使用 getLogger() 方法来检索和重新配置/禁用不需要的记录器。

我还想添加 logging.fileConfig() 方法接受一个名为 disable_existing_loggers 的参数，它将禁用以前定义的任何记录器（即，在导入的模块中）。

---

你可以使用类似的东西：

logging.getLogger("imported_module").setLevel(logging.WARNING)
logging.getLogger("my_own_logger_name").setLevel(logging.DEBUG)

这会将我自己的模块的日志级别设置为 DEBUG，同时防止导入的模块使用相同的级别。

注意："imported_module" 可以替换为 imported_module.__name__（不带引号），如果您愿意，"my_own_logger_name" 可以替换为 __name__。

---

在此线程和其他论坛中尝试了各种答案后，我发现这种方法可以有效地使其他模块的记录器静音。这是受到以下链接的启发：

https://kmasif.com/2019-11-12-ignore-logging-from-imported-module/

import logging
# Initialize your own logger
logger = logging.getLogger('<module name>')
logger.setLevel(logging.DEBUG)

# Silence other loggers
for log_name, log_obj in logging.Logger.manager.loggerDict.items():
     if log_name != '<module name>':
          log_obj.disabled = True

请注意，您可能希望在导入其他模块后执行此操作。但是，我发现这是禁用其他模块记录器的一种方便快捷的方法。

---

我有同样的问题。我有一个 logging_config.py 文件，我将它导入到所有其他 py 文件中。在 logging_config.py 文件中，我将 root logger 日志记录级别设置为 ERROR（默认情况下是警告）：

logging.basicConfig(
    handlers=[
        RotatingFileHandler('logs.log',maxBytes=1000, backupCount=2),
        logging.StreamHandler(), #print to console
    ],
    level=logging.ERROR
)

在其他模块中，我导入 logging_config.py 并声明一个新记录器并将其级别设置为调试：

log = logging.getLogger(__name__)
log.setLevel(logging.DEBUG)

这样，我在我的 py 文件中登录的所有内容都会被记录，但不会记录由导入的模块（如 urllib、request、boto3 等）在调试和信息级别记录的内容。如果这些导入模块中有一些错误，那么它会被记录下来，因为我将根记录器级别设置为错误。

---

只需执行以下操作即可解决问题：

logging.config.dictConfig({'disable_existing_loggers': True,})

注意：无论您将这一行放在哪里，请确保项目中所有位置的所有导入都在该文件本身内完成。 :)

---

要考虑的另一件事是 Logger 类的 propagate 属性。

例如，用于处理soap调用的py-suds库，甚至放到ERROR

logging.getLogger('suds.client').setLevel(logging.ERROR)
logging.getLogger('suds.transport').setLevel(logging.ERROR)
logging.getLogger('suds.xsdschema').setLevel(logging.ERROR)
logging.getLogger('suds.wsdl').setLevel(logging.ERROR)

记录有关名为 sxbasics.py 的模块的日志创建大量日志

https://i.stack.imgur.com/CoLUb.png

那是因为日志的传播默认为 True，设置为 False，相反，我恢复了 514MB 的日志。

import logging
logging.getLogger("suds").propagate = False
logging.getLogger('suds.client').setLevel(logging.ERROR)
logging.getLogger('suds.transport').setLevel(logging.ERROR)
logging.getLogger('suds.xsdschema').setLevel(logging.ERROR)
logging.getLogger('suds.wsdl').setLevel(logging.ERROR)

---

受 @brendan's answer 的启发，我创建了一个简单的 logger_blocklist，我可以在其中添加我想要提高级别的所有记录器。因此，我能够一次将它们全部静音：

import logging

logging.basicConfig(level=logging.DEBUG)

logger_blocklist = [
    "fiona",
    "rasterio",
    "matplotlib",
    "PIL",
]

for module in logger_blocklist:
    logging.getLogger(module).setLevel(logging.WARNING)

您可以从 format="%(name)s" 参数中找到记录器的名称，该参数也包含在 logging.basicConfig() 中，例如：DEBUG:matplotlib.font_manager:findfont: score(FontEntry(fname='/usr/share/fonts/truetype/ubuntu/Ubuntu-R.ttf', name='Ubuntu', style='normal', variant='normal', weight=400, stretch='normal', size='scalable')) = 10.05。

在这种情况下，您希望将记录器 matplotlib 添加到您的阻止列表中。

与 @Finn's answer 不同，它没有必要放在 main() 之外，等等。

---