Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
73007fe900 | ||
|
|
33d61633af | ||
|
|
871471dd58 | ||
|
|
54151b9835 |
@@ -13,7 +13,7 @@ and emit; their records flow into the handlers `log_setup` wired.
|
|||||||
## Install
|
## Install
|
||||||
|
|
||||||
```
|
```
|
||||||
log_setup @ git+ssh://git@git.rethinkstudios.io/rethink-public/log_setup.git@v0.1.0
|
log_setup @ git+ssh://git@git.rethinkstudios.io/rethink-public/log_setup.git@v0.3.0
|
||||||
```
|
```
|
||||||
|
|
||||||
No dependencies — stdlib only.
|
No dependencies — stdlib only.
|
||||||
@@ -52,24 +52,98 @@ emits; the records land in the configured root.
|
|||||||
- **console=True** (off by default) also logs to stdout in the same format — opt in when
|
- **console=True** (off by default) also logs to stdout in the same format — opt in when
|
||||||
you want live terminal output alongside the file.
|
you want live terminal output alongside the file.
|
||||||
|
|
||||||
|
## Output format (`output=`)
|
||||||
|
|
||||||
|
Two formats, two needs. Default is `"text"`; the live-file name is the same either way
|
||||||
|
(`run.log`, never auto-renamed), so a service can switch text↔json without breaking the
|
||||||
|
Promtail glob, bind-mount path, or your `tail` command.
|
||||||
|
|
||||||
|
- **`output="text"`** (default) — human-readable
|
||||||
|
`2026-06-27 19:55:05 | module.name | INFO | message`, **local time**. The
|
||||||
|
single-machine `tail -f` path. `fmt`/`datefmt` override it. Unchanged from v0.1.x.
|
||||||
|
- **`output="json"`** — structured **one JSON object per line** (JSON Lines) for the
|
||||||
|
Grafana/Loki pipeline (Promtail → Loki → Grafana); Loki parses JSON fields into labels
|
||||||
|
natively, no regex.
|
||||||
|
|
||||||
|
```python
|
||||||
|
setup_logging(name="run", output="json")
|
||||||
|
logging.getLogger("bot.core").info("ready", extra={"monitor": "heartbeat"})
|
||||||
|
# -> {"time": "2026-06-28T14:03:11Z", "level": "INFO", "module": "bot.core",
|
||||||
|
# "message": "ready", "monitor": "heartbeat"}
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Fields:** `time`, `level`, `module`, `message` always; any `extra={...}` keys land
|
||||||
|
as **top-level** fields (stamp `monitor`/`service`/request-id for Loki labels — the lib
|
||||||
|
stays domain-agnostic); error records carry the traceback in `exc_info` (never dropped).
|
||||||
|
- **Time is UTC ISO-8601 with a `Z`** (`2026-06-28T14:03:11Z`), not local. json is the
|
||||||
|
aggregation path — logs from many servers/containers sort unambiguously only in UTC;
|
||||||
|
Grafana converts to local for display. (Text mode stays local — that's a human on one
|
||||||
|
box.)
|
||||||
|
- Both file and console use the chosen format. `fmt`/`datefmt` apply to text only (json
|
||||||
|
builds fields, not a format string). An unknown `output` falls back to text + warns,
|
||||||
|
never crashes. **Zero new deps** — stdlib `json` only.
|
||||||
|
|
||||||
## Signature
|
## Signature
|
||||||
|
|
||||||
```python
|
```python
|
||||||
setup_logging(
|
setup_logging(
|
||||||
name="run", # base -> run.log (the live file at cwd)
|
name="run", # base -> run.log (the live file at cwd)
|
||||||
log_dir="logs", # rotated/compressed copies live here (created if absent)
|
log_dir="logs", # rotated/compressed copies live here (created if absent)
|
||||||
level="INFO", # root level (str name or logging constant)
|
level="INFO", # root level everything inherits (str name or logging constant)
|
||||||
|
module_levels=None, # {logger_name: level} per-logger overrides (exact name match)
|
||||||
rotate="daily", # "daily" | "size" | "on_start" | None
|
rotate="daily", # "daily" | "size" | "on_start" | None
|
||||||
backup_count=14, # rotated files to keep (older auto-deleted)
|
backup_count=14, # rotated files to keep (older auto-deleted)
|
||||||
max_bytes=10_000_000, # only for rotate="size"
|
max_bytes=10_000_000, # only for rotate="size"
|
||||||
compress=True, # gzip rolled files
|
compress=True, # gzip rolled files
|
||||||
console=False, # also log to stdout (off by default; opt in)
|
console=False, # also log to stdout (off by default; opt in)
|
||||||
queue=False, # route through a background QueueListener (async-friendly)
|
queue=False, # route through a background QueueListener (async-friendly)
|
||||||
fmt=None, # override the format string
|
output="text", # "text" (human, local time) | "json" (structured, UTC)
|
||||||
datefmt=None, # override the date format
|
fmt=None, # override the text format string (text mode only)
|
||||||
|
datefmt=None, # override the text date format (text mode only)
|
||||||
) -> logging.Logger # returns the configured root logger
|
) -> logging.Logger # returns the configured root logger
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Quieting noisy dependencies (`module_levels`)
|
||||||
|
|
||||||
|
`level` is the **root default** — every logger inherits it. `module_levels` is an
|
||||||
|
optional `{logger_name: level}` map of **per-logger overrides** applied at setup, the
|
||||||
|
standard "turn down the chatty dependency while my own code stays at INFO" case:
|
||||||
|
|
||||||
|
```python
|
||||||
|
setup_logging(
|
||||||
|
name="run",
|
||||||
|
level="INFO", # our code logs at INFO
|
||||||
|
module_levels={
|
||||||
|
"motor": "WARNING", # quiet the driver
|
||||||
|
"pymongo": "WARNING",
|
||||||
|
"aiohttp": "WARNING", # also quiets aiohttp.client / aiohttp.access (hierarchy)
|
||||||
|
},
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Exact-name match — names are NOT discovered.** It calls
|
||||||
|
`logging.getLogger(name).setLevel(level)` for exactly the name you give. There's no
|
||||||
|
smart find of noisy modules; you name the loggers. A typo (`"moter"`) silently
|
||||||
|
configures a logger nothing uses — no error, no effect. Get the names right.
|
||||||
|
- **Hierarchy applies** (the one "smart" part, and it's just stdlib): naming a **parent**
|
||||||
|
quiets its whole subtree. `"aiohttp"` also quiets `aiohttp.client`, `aiohttp.access`,
|
||||||
|
etc. — the way to catch sub-loggers without listing each.
|
||||||
|
- **str or int** per entry (`"WARNING"` or `logging.WARNING`) — same normalization as the
|
||||||
|
root `level`.
|
||||||
|
- **Never crashes:** a bad level for one entry is **skipped with a warning**; the other
|
||||||
|
entries and the rest of setup still apply. Consistent with the never-crash-over-logging
|
||||||
|
rule.
|
||||||
|
- `None`/`{}` (default) → no overrides; existing callers are unaffected.
|
||||||
|
|
||||||
|
Common noisy library logger names: `motor`, `pymongo`, `aiohttp` (parent quiets
|
||||||
|
`aiohttp.client`/`aiohttp.access`), `discord` / `discord.*`, `asyncio`, `urllib3`. Check
|
||||||
|
a lib's *actual* logger name — some log under a name different from their package.
|
||||||
|
|
||||||
|
This already works without the lib (`logging.getLogger("motor").setLevel(WARNING)` after
|
||||||
|
setup does the same via stdlib hierarchy). The param's value is ergonomic: it keeps the
|
||||||
|
overrides in the **one** `setup_logging` call at the entry point instead of scattering
|
||||||
|
`setLevel` calls afterward — which is the whole point of `log_setup`.
|
||||||
|
|
||||||
## Async-friendly (`queue=True`)
|
## Async-friendly (`queue=True`)
|
||||||
|
|
||||||
For async-heavy apps, `queue=True` routes records through a stdlib `QueueHandler` to a
|
For async-heavy apps, `queue=True` routes records through a stdlib `QueueHandler` to a
|
||||||
@@ -97,8 +171,9 @@ handlers. Getting files to a backend is a separate concern (e.g. Promtail tails
|
|||||||
backend can change without touching any app, and the consistent format here is what
|
backend can change without touching any app, and the consistent format here is what
|
||||||
makes downstream parsing and alerting easy.
|
makes downstream parsing and alerting easy.
|
||||||
|
|
||||||
Also out of v0.1.0 (possible later additions): structured/JSON logging, color
|
Structured/JSON output is **in** as of v0.2.0 (`output="json"`) — text and json only.
|
||||||
formatting, per-logger filters, remote handlers.
|
Still deliberately out: logfmt or other formats, a format DSL, per-handler formats,
|
||||||
|
color formatting, per-logger filters, remote handlers.
|
||||||
|
|
||||||
## Versioning
|
## Versioning
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "log_setup"
|
name = "log_setup"
|
||||||
version = "0.1.1"
|
version = "0.3.0"
|
||||||
description = "stdlib app-entry-point logging setup: live run.log, rotation, gzip, retention, consistent format"
|
description = "stdlib app-entry-point logging setup: live run.log, rotation, gzip, retention, consistent format"
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
dependencies = []
|
dependencies = []
|
||||||
|
|||||||
@@ -19,4 +19,4 @@ from .setup import setup_logging
|
|||||||
|
|
||||||
__all__ = ["setup_logging"]
|
__all__ = ["setup_logging"]
|
||||||
|
|
||||||
__version__ = "0.1.1"
|
__version__ = "0.3.0"
|
||||||
|
|||||||
@@ -1,15 +1,67 @@
|
|||||||
"""default log format + datefmt for the app-wide setup.
|
"""log formats for the app-wide setup: human-readable text + structured JSON lines.
|
||||||
|
|
||||||
one format for v0.1.0, used on both console and file. `%(name)s` is the getLogger
|
two output formats, two proven needs. `text` (default) is the human `tail -f` format
|
||||||
name the emitting module used, so each library/module shows in the line.
|
(`time | module | level | message`, local time). `json` is the Grafana/Loki path —
|
||||||
|
one JSON object per line (JSON Lines), fields parsed into labels natively, UTC
|
||||||
|
timestamps so logs aggregated from many machines/containers sort unambiguously.
|
||||||
|
`%(name)s` is the getLogger name the emitting module used, so each module shows.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
import datetime
|
||||||
|
import json
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
DEFAULT_FORMAT = "%(asctime)s | %(name)s | %(levelname)s | %(message)s"
|
DEFAULT_FORMAT = "%(asctime)s | %(name)s | %(levelname)s | %(message)s"
|
||||||
DEFAULT_DATEFMT = "%Y-%m-%d %H:%M:%S"
|
DEFAULT_DATEFMT = "%Y-%m-%d %H:%M:%S"
|
||||||
|
|
||||||
|
_RESERVED = frozenset(vars(logging.makeLogRecord({})).keys()) | {"message", "asctime"}
|
||||||
|
|
||||||
def build_formatter(fmt=None, datefmt=None) -> logging.Formatter:
|
|
||||||
"""build a logging.Formatter from overrides, falling back to the defaults"""
|
class JsonLinesFormatter(logging.Formatter):
|
||||||
|
"""format each record as a single-line JSON object (JSON Lines / .jsonl)
|
||||||
|
|
||||||
|
emits at minimum time/level/module/message. time is UTC ISO-8601 with a `Z`
|
||||||
|
suffix (e.g. 2026-06-28T14:03:11Z) so logs aggregated across machines and
|
||||||
|
containers sort unambiguously — Grafana converts to local for display. any
|
||||||
|
field passed via logging `extra={...}` lands as a top-level JSON field, which
|
||||||
|
is how a caller stamps monitor/service/request-id for Loki labels without the
|
||||||
|
lib knowing those domain concepts. a traceback (exc_info) is rendered into an
|
||||||
|
`exc_info` string field rather than dropped.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def format(self, record: logging.LogRecord) -> str:
|
||||||
|
when = datetime.datetime.fromtimestamp(record.created, datetime.timezone.utc)
|
||||||
|
payload = {
|
||||||
|
"time": when.strftime("%Y-%m-%dT%H:%M:%SZ"),
|
||||||
|
"level": record.levelname,
|
||||||
|
"module": record.name,
|
||||||
|
"message": record.getMessage(),
|
||||||
|
}
|
||||||
|
for key, value in record.__dict__.items():
|
||||||
|
if key not in _RESERVED and not key.startswith("_"):
|
||||||
|
payload[key] = value
|
||||||
|
if record.exc_info:
|
||||||
|
payload["exc_info"] = self.formatException(record.exc_info)
|
||||||
|
elif record.exc_text:
|
||||||
|
payload["exc_info"] = record.exc_text
|
||||||
|
if record.stack_info:
|
||||||
|
payload["stack_info"] = self.formatStack(record.stack_info)
|
||||||
|
return json.dumps(payload, default=str)
|
||||||
|
|
||||||
|
|
||||||
|
def build_formatter(output: str = "text", fmt=None, datefmt=None) -> logging.Formatter:
|
||||||
|
"""build the formatter for the chosen output format
|
||||||
|
|
||||||
|
`output="text"` (default) returns the human-readable text formatter, honoring
|
||||||
|
the raw `fmt`/`datefmt` format-string overrides. `output="json"` returns the
|
||||||
|
structured `JsonLinesFormatter` (which ignores `fmt`/`datefmt` — it builds
|
||||||
|
fields, not a format string). an unrecognized `output` falls back to text and
|
||||||
|
warns, never raising — a bad format arg must not take the app down.
|
||||||
|
"""
|
||||||
|
if output == "json":
|
||||||
|
return JsonLinesFormatter()
|
||||||
|
if output != "text":
|
||||||
|
logging.getLogger(__name__).warning(
|
||||||
|
"log_setup: unknown output %r; falling back to 'text'", output
|
||||||
|
)
|
||||||
return logging.Formatter(fmt or DEFAULT_FORMAT, datefmt or DEFAULT_DATEFMT)
|
return logging.Formatter(fmt or DEFAULT_FORMAT, datefmt or DEFAULT_DATEFMT)
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import gzip
|
|||||||
import os
|
import os
|
||||||
import shutil
|
import shutil
|
||||||
import time
|
import time
|
||||||
from typing import Callable, Tuple
|
from typing import Callable, Optional, Tuple
|
||||||
|
|
||||||
|
|
||||||
def make_namer(log_dir: str, compress: bool) -> Callable[[str], str]:
|
def make_namer(log_dir: str, compress: bool) -> Callable[[str], str]:
|
||||||
@@ -26,8 +26,18 @@ def make_namer(log_dir: str, compress: bool) -> Callable[[str], str]:
|
|||||||
return namer
|
return namer
|
||||||
|
|
||||||
|
|
||||||
def make_rotator(compress: bool) -> Callable[[str, str], None]:
|
def make_rotator(
|
||||||
"""rotator: move (or gzip) the source live file to the destination rolled path"""
|
compress: bool, log_dir: Optional[str] = None,
|
||||||
|
prune_stem: Optional[str] = None, backup_count: int = 0,
|
||||||
|
) -> Callable[[str, str], None]:
|
||||||
|
"""rotator: move (or gzip) the source live file to the destination rolled path
|
||||||
|
|
||||||
|
prunes `log_dir` to `backup_count` newest rolled files after each roll when
|
||||||
|
`log_dir`/`prune_stem` are given. the stdlib handler's own retention
|
||||||
|
(`getFilesToDelete`) only scans the live file's directory, so it never sees the
|
||||||
|
rolled files we redirect into `log_dir` — pruning here is what actually bounds
|
||||||
|
retention for the daily and size rolling modes.
|
||||||
|
"""
|
||||||
def rotator(source: str, dest: str) -> None:
|
def rotator(source: str, dest: str) -> None:
|
||||||
if not os.path.exists(source):
|
if not os.path.exists(source):
|
||||||
return
|
return
|
||||||
@@ -37,6 +47,8 @@ def make_rotator(compress: bool) -> Callable[[str, str], None]:
|
|||||||
os.remove(source)
|
os.remove(source)
|
||||||
else:
|
else:
|
||||||
os.replace(source, dest)
|
os.replace(source, dest)
|
||||||
|
if log_dir is not None and prune_stem is not None:
|
||||||
|
prune(log_dir, prune_stem, backup_count)
|
||||||
return rotator
|
return rotator
|
||||||
|
|
||||||
|
|
||||||
@@ -93,10 +105,17 @@ def _safe_mtime(path: str) -> float:
|
|||||||
return 0.0
|
return 0.0
|
||||||
|
|
||||||
|
|
||||||
def attach_rolling(handler, log_dir: str, compress: bool) -> Tuple[Callable, Callable]:
|
def attach_rolling(
|
||||||
"""wire the custom namer + rotator onto a rotating handler; return them"""
|
handler, log_dir: str, compress: bool,
|
||||||
|
prune_stem: Optional[str] = None, backup_count: int = 0,
|
||||||
|
) -> Tuple[Callable, Callable]:
|
||||||
|
"""wire the custom namer + rotator onto a rotating handler; return them
|
||||||
|
|
||||||
|
pass `prune_stem`/`backup_count` so the rotator prunes `log_dir` after each roll
|
||||||
|
(the handler's own retention can't see the redirected rolled files).
|
||||||
|
"""
|
||||||
namer = make_namer(log_dir, compress)
|
namer = make_namer(log_dir, compress)
|
||||||
rotator = make_rotator(compress)
|
rotator = make_rotator(compress, log_dir, prune_stem, backup_count)
|
||||||
handler.namer = namer
|
handler.namer = namer
|
||||||
handler.rotator = rotator
|
handler.rotator = rotator
|
||||||
return namer, rotator
|
return namer, rotator
|
||||||
|
|||||||
+59
-7
@@ -13,7 +13,7 @@ import logging
|
|||||||
import logging.handlers
|
import logging.handlers
|
||||||
import os
|
import os
|
||||||
import queue
|
import queue
|
||||||
from typing import Optional, Union
|
from typing import Dict, Optional, Union
|
||||||
|
|
||||||
from .formats import build_formatter
|
from .formats import build_formatter
|
||||||
from .rotation import attach_rolling, prune, rotate_on_start
|
from .rotation import attach_rolling, prune, rotate_on_start
|
||||||
@@ -36,6 +36,41 @@ def _level_value(level: Union[int, str]) -> int:
|
|||||||
return resolved if isinstance(resolved, int) else logging.INFO
|
return resolved if isinstance(resolved, int) else logging.INFO
|
||||||
|
|
||||||
|
|
||||||
|
def _strict_level_value(level: Union[int, str]) -> Optional[int]:
|
||||||
|
"""coerce a level name or int to a logging level int, or None if invalid
|
||||||
|
|
||||||
|
unlike `_level_value` (which falls back to INFO for the root `level`), this reports
|
||||||
|
an invalid value as None so the per-module path can skip + warn rather than silently
|
||||||
|
apply INFO to a logger the caller named with a typo'd level
|
||||||
|
"""
|
||||||
|
if isinstance(level, bool):
|
||||||
|
return None
|
||||||
|
if isinstance(level, int):
|
||||||
|
return level
|
||||||
|
if not isinstance(level, str):
|
||||||
|
return None
|
||||||
|
resolved = logging.getLevelName(level.upper())
|
||||||
|
return resolved if isinstance(resolved, int) else None
|
||||||
|
|
||||||
|
|
||||||
|
def _apply_module_levels(module_levels: Optional[Dict[str, Union[int, str]]]) -> None:
|
||||||
|
"""set per-logger level overrides by exact logger name, never crashing
|
||||||
|
|
||||||
|
each name->level entry calls `logging.getLogger(name).setLevel(<level>)`. names are
|
||||||
|
matched exactly (no discovery); stdlib hierarchy still applies, so a parent name
|
||||||
|
quiets its whole subtree. a bad level for one entry is skipped with a warning so the
|
||||||
|
other entries and the rest of setup still proceed.
|
||||||
|
"""
|
||||||
|
if not module_levels:
|
||||||
|
return
|
||||||
|
for mod_name, raw_level in module_levels.items():
|
||||||
|
value = _strict_level_value(raw_level)
|
||||||
|
if value is None:
|
||||||
|
log.warning("log_setup: invalid level %r for logger %r; skipping", raw_level, mod_name)
|
||||||
|
continue
|
||||||
|
logging.getLogger(mod_name).setLevel(value)
|
||||||
|
|
||||||
|
|
||||||
def _clear_owned(root: logging.Logger) -> None:
|
def _clear_owned(root: logging.Logger) -> None:
|
||||||
"""remove only the handlers this lib previously added; leave app handlers alone"""
|
"""remove only the handlers this lib previously added; leave app handlers alone"""
|
||||||
global _listener
|
global _listener
|
||||||
@@ -66,12 +101,12 @@ def _file_handler(
|
|||||||
handler = logging.handlers.RotatingFileHandler(
|
handler = logging.handlers.RotatingFileHandler(
|
||||||
live_path, maxBytes=max_bytes, backupCount=backup_count, encoding="utf-8",
|
live_path, maxBytes=max_bytes, backupCount=backup_count, encoding="utf-8",
|
||||||
)
|
)
|
||||||
attach_rolling(handler, log_dir, compress)
|
attach_rolling(handler, log_dir, compress, prune_stem=name, backup_count=backup_count)
|
||||||
elif rotate == "daily":
|
elif rotate == "daily":
|
||||||
handler = logging.handlers.TimedRotatingFileHandler(
|
handler = logging.handlers.TimedRotatingFileHandler(
|
||||||
live_path, when="midnight", backupCount=backup_count, encoding="utf-8",
|
live_path, when="midnight", backupCount=backup_count, encoding="utf-8",
|
||||||
)
|
)
|
||||||
attach_rolling(handler, log_dir, compress)
|
attach_rolling(handler, log_dir, compress, prune_stem=name, backup_count=backup_count)
|
||||||
else:
|
else:
|
||||||
if rotate == "on_start":
|
if rotate == "on_start":
|
||||||
rotate_on_start(live_path, log_dir, compress)
|
rotate_on_start(live_path, log_dir, compress)
|
||||||
@@ -84,32 +119,49 @@ def setup_logging(
|
|||||||
name: str = "run",
|
name: str = "run",
|
||||||
log_dir: str = "logs",
|
log_dir: str = "logs",
|
||||||
level: Union[int, str] = "INFO",
|
level: Union[int, str] = "INFO",
|
||||||
|
module_levels: Optional[Dict[str, Union[int, str]]] = None,
|
||||||
rotate: Optional[str] = "daily",
|
rotate: Optional[str] = "daily",
|
||||||
backup_count: int = 14,
|
backup_count: int = 14,
|
||||||
max_bytes: int = 10_000_000,
|
max_bytes: int = 10_000_000,
|
||||||
compress: bool = True,
|
compress: bool = True,
|
||||||
console: bool = False,
|
console: bool = False,
|
||||||
queue: bool = False,
|
queue: bool = False,
|
||||||
|
output: str = "text",
|
||||||
fmt: Optional[str] = None,
|
fmt: Optional[str] = None,
|
||||||
datefmt: Optional[str] = None,
|
datefmt: Optional[str] = None,
|
||||||
) -> logging.Logger:
|
) -> logging.Logger:
|
||||||
"""configure the root logger for the whole process and return it
|
"""configure the root logger for the whole process and return it
|
||||||
|
|
||||||
`name` -> <name>.log live file at cwd; rolled/compressed copies go to `log_dir`.
|
`name` -> <name>.log live file at cwd; rolled/compressed copies go to `log_dir`.
|
||||||
|
`level` is the root default every logger inherits. `module_levels` is an optional
|
||||||
|
map of exact logger name -> level applied after the root is set, the ergonomic way
|
||||||
|
to quiet noisy dependencies (e.g. {"motor": "WARNING", "aiohttp": "WARNING"}) from
|
||||||
|
the one setup call instead of scattering `getLogger(...).setLevel(...)` afterwards —
|
||||||
|
it's stdlib hierarchy under the hood, not new capability. names match EXACTLY (no
|
||||||
|
discovery: a typo'd name silently configures an unused logger), but stdlib hierarchy
|
||||||
|
applies, so naming a parent ("aiohttp") quiets its whole subtree (aiohttp.client,
|
||||||
|
aiohttp.access, ...). each entry accepts a str or int level; a bad value for one
|
||||||
|
entry is skipped with a warning and never aborts the others or the setup.
|
||||||
`rotate` is "daily" (default), "size", "on_start", or None. `console=True` adds a
|
`rotate` is "daily" (default), "size", "on_start", or None. `console=True` adds a
|
||||||
stdout handler (off by default — the file is the output). `queue=True` routes records
|
stdout handler (off by default — the file is the output). `queue=True` routes records
|
||||||
through a background QueueListener so file I/O never blocks the caller (the listener
|
through a background QueueListener so file I/O never blocks the caller (the listener
|
||||||
is stopped at exit). idempotent: a repeat call clears only the handlers this function
|
is stopped at exit). `output` is "text" (default, human `time | module | level |
|
||||||
added. never raises over logging — an unwritable `log_dir` falls back to console-only
|
message`, local time) or "json" (structured one-JSON-object-per-line for the
|
||||||
with a warning even when `console` is off, so output is never silently lost.
|
Grafana/Loki path, UTC timestamps, `extra=` fields surfaced as top-level keys); both
|
||||||
|
file and console use the chosen format and the live-file name is the same regardless.
|
||||||
|
the raw `fmt`/`datefmt` overrides apply to text output only. idempotent: a repeat call
|
||||||
|
clears only the handlers this function added. never raises over logging — an
|
||||||
|
unwritable `log_dir` falls back to console-only with a warning even when `console` is
|
||||||
|
off, so output is never silently lost; an unknown `output` falls back to text.
|
||||||
"""
|
"""
|
||||||
global _listener
|
global _listener
|
||||||
|
|
||||||
root = logging.getLogger()
|
root = logging.getLogger()
|
||||||
root.setLevel(_level_value(level))
|
root.setLevel(_level_value(level))
|
||||||
|
_apply_module_levels(module_levels)
|
||||||
_clear_owned(root)
|
_clear_owned(root)
|
||||||
|
|
||||||
formatter = build_formatter(fmt, datefmt)
|
formatter = build_formatter(output, fmt, datefmt)
|
||||||
live_path = f"{name}.log"
|
live_path = f"{name}.log"
|
||||||
|
|
||||||
handlers = []
|
handlers = []
|
||||||
|
|||||||
Reference in New Issue
Block a user