Skip to content

Commit bcccf7d

Browse files
committed
Better logging docs
1 parent 4c1819c commit bcccf7d

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

src/ibex_bluesky_core/log.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,18 @@ def file_handler() -> TimedRotatingFileHandler:
4141

4242

4343
def setup_logging() -> None:
44-
"""Set up logging with a default configuration."""
44+
r"""Set up logging with a default configuration.
45+
46+
The default configuration is to log to ::
47+
48+
c:\instrument\var\logs\bluesky
49+
50+
This location can be overridden using the ``IBEX_BLUESKY_CORE_LOGS`` environment variable.
51+
52+
Loggers listened-to by default include the loggers for this library, as well as
53+
the loggers for :py:obj:`bluesky` and :py:obj:`ophyd_async`. The severities of those
54+
loggers are set to ``INFO`` by default.
55+
"""
4556
# Create the log directory if it doesn't already exist
4657
try:
4758
os.makedirs(log_location, exist_ok=True)

0 commit comments

Comments
 (0)