Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions distributed/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ def _initialize_logging_old_style(config):
"tornado": "critical",
"tornado.application": "error",
}
loggers.update(config.get("logging", {}))
base_config = _find_logging_config(config)
loggers.update(base_config.get("logging", {}))

handler = logging.StreamHandler(sys.stderr)
handler.setFormatter(
Expand All @@ -103,28 +104,43 @@ def _initialize_logging_new_style(config):
Initialize logging using logging's "Configuration dictionary schema".
(ref.: https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema)
"""
logging.config.dictConfig(config.get("logging"))
base_config = _find_logging_config(config)
logging.config.dictConfig(base_config.get("logging"))


def _initialize_logging_file_config(config):
"""
Initialize logging using logging's "Configuration file format".
(ref.: https://docs.python.org/3/howto/logging.html#configuring-logging)
"""
base_config = _find_logging_config(config)
logging.config.fileConfig(
config.get("logging-file-config"), disable_existing_loggers=False
base_config.get("logging-file-config"), disable_existing_loggers=False
)


def _find_logging_config(config):
"""
Look for the dictionary containing logging-specific configurations,
starting in the 'distributed' dictionary and then trying the top-level
"""
logging_keys = {"logging-file-config", "logging"}
if logging_keys & config.get("distributed", {}).keys():
return config["distributed"]
else:
return config


def initialize_logging(config):
if "logging-file-config" in config:
if "logging" in config:
base_config = _find_logging_config(config)
if "logging-file-config" in base_config:
if "logging" in base_config:
raise RuntimeError(
"Config options 'logging-file-config' and 'logging' are mutually exclusive."
)
_initialize_logging_file_config(config)
else:
log_config = config.get("logging", {})
log_config = base_config.get("logging", {})
if "version" in log_config:
# logging module mandates version to be an int
log_config["version"] = int(log_config["version"])
Expand Down
39 changes: 39 additions & 0 deletions distributed/tests/test_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,45 @@ def test_logging_empty_simple():
test_logging_default()


def test_logging_simple_under_distributed():
"""
Test simple ("old-style") logging configuration under the distributed key.
"""
c = {
"distributed": {
"logging": {"distributed.foo": "info", "distributed.foo.bar": "error"}
}
}
# Must test using a subprocess to avoid wrecking pre-existing configuration
with new_config_file(c):
code = """if 1:
import logging
import dask

from distributed.utils_test import captured_handler

d = logging.getLogger('distributed')
assert len(d.handlers) == 1
assert isinstance(d.handlers[0], logging.StreamHandler)
df = logging.getLogger('distributed.foo')
dfb = logging.getLogger('distributed.foo.bar')

with captured_handler(d.handlers[0]) as distributed_log:
df.info("1: info")
dfb.warning("2: warning")
dfb.error("3: error")

distributed_log = distributed_log.getvalue().splitlines()

assert distributed_log == [
"distributed.foo - INFO - 1: info",
"distributed.foo.bar - ERROR - 3: error",
], (dask.config.config, distributed_log)
"""

subprocess.check_call([sys.executable, "-c", code])


def test_logging_simple():
"""
Test simple ("old-style") logging configuration.
Expand Down