Compare commits
18
Commits
v0.1.0
...
93994da9d6
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
93994da9d6 | ||
|
|
8bf1866ca2 | ||
|
|
1207c53742 | ||
|
|
b52c1d37fa | ||
|
|
6a10f3acc0 | ||
|
|
ece9a6b9ca | ||
|
|
595f0363b3 | ||
|
|
efb35195f1 | ||
|
|
fc0898d70e | ||
|
|
011588a712 | ||
|
|
ddc81dd8fe | ||
|
|
74c5a42c5a | ||
|
|
ff29e05322 | ||
|
|
73007fe900 | ||
|
|
33d61633af | ||
|
|
871471dd58 | ||
|
|
54151b9835 | ||
|
|
84e1744d6f |
+1
-1
@@ -1,5 +1,5 @@
|
||||
# claude
|
||||
CLAUDE.md
|
||||
.claude/
|
||||
|
||||
# python
|
||||
__pycache__/
|
||||
|
||||
@@ -13,11 +13,13 @@ and emit; their records flow into the handlers `log_setup` wired.
|
||||
## 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.6.0
|
||||
```
|
||||
|
||||
No dependencies — stdlib only.
|
||||
|
||||
Drop the `@v0.6.0` suffix from the line above to install the latest unpinned.
|
||||
|
||||
## Quick start
|
||||
|
||||
```python
|
||||
@@ -41,35 +43,186 @@ emits; the records land in the configured root.
|
||||
- **Format:** `2026-06-27 19:55:05 | module.name | INFO | message`. `%(name)s` is the
|
||||
`getLogger` name each module used, so you see which lib/module logged.
|
||||
- **Rotation** (`rotate=`):
|
||||
- `"daily"` (default) — rolls at midnight, dated name into `log_dir`, keeps
|
||||
`backup_count` days.
|
||||
- `"size"` — rolls at `max_bytes`, numbered backups in `log_dir`.
|
||||
- `"on_start"` — on startup, moves an existing `run.log` into `log_dir`
|
||||
(`run.<timestamp>.log[.gz]`) and starts fresh; prunes to `backup_count`.
|
||||
- `"daily"` (default) — rolls at midnight into `log_dir`, keeps `backup_count` days.
|
||||
- `"size"` — rolls at `max_bytes` into `log_dir`, keeps `backup_count`. `backup_count=0`
|
||||
means **keep no rolled history**: the live file still rolls at `max_bytes` (size is
|
||||
always bounded), each rolled file is deleted immediately after landing — it does not
|
||||
disable rotation (see **Retention** below).
|
||||
- `"on_start"` — on startup, moves an existing live file into `log_dir` and starts fresh;
|
||||
prunes to `backup_count`.
|
||||
- `None` — single file, no rotation.
|
||||
- **compress=True** (default) gzips each rolled file (`run.log.2026-06-27.gz`).
|
||||
- **Retention** = `backup_count` (default 14) for every mode.
|
||||
- **Historic files are named off the project** — see below. Every rolled file is
|
||||
`<project>.<timestamp>.log[.gz]`; the live file keeps its own name.
|
||||
- **compress=True** (default) gzips each rolled file.
|
||||
- **Retention** = `backup_count` (default 14) for every mode — unless tiered retention is
|
||||
enabled (below). For `rotate="size"`, `backup_count=0` is "keep none" (not "disable
|
||||
rotation") — see the `size` bullet above and the note at the bottom of this section.
|
||||
- **console=True** (off by default) also logs to stdout in the same format — opt in when
|
||||
you want live terminal output alongside the file.
|
||||
|
||||
The `name` you pass is normalized so it produces exactly one `.log`: `name="latest"` and
|
||||
`name="latest.log"` both yield the live file `latest.log` (never `latest.log.log`).
|
||||
|
||||
## Historic files are named off the project (`history_name`)
|
||||
|
||||
The **live** file keeps its defined `name` (`latest.log`). The **historic** (rolled/gz)
|
||||
files are named off the **project namespace** — by default the current directory's basename
|
||||
— so you can tell at a glance which service a log came from:
|
||||
|
||||
```python
|
||||
# app run from bestbuy/run.py , with name="latest":
|
||||
setup_logging(name="latest", rotate="daily")
|
||||
# logs/
|
||||
# latest.log <- live (the tail -f target)
|
||||
# bestbuy.2026-07-01_02-00-00.log <- historic, named off the project dir
|
||||
# bestbuy.2026-06-30_02-00-00.log.gz
|
||||
```
|
||||
|
||||
- **Default** = `os.path.basename(os.getcwd())` (the project directory). Zero config.
|
||||
- Override with **`history_name="foo"`** → historic files become `foo.<timestamp>.log[.gz]`.
|
||||
- This changed in **v0.5.0**: historic files used to reuse the live `name`. To keep the old
|
||||
behavior, pass `history_name=name`.
|
||||
- Retention (tier counts / `backup_count`) is unchanged — it's just keyed to the project
|
||||
stem now.
|
||||
|
||||
## Tiered retention (`keep_uncompressed` / `keep_compressed`)
|
||||
|
||||
The default is a flat `backup_count`: every rolled file is gzipped on roll and the oldest
|
||||
are deleted past the count. If instead you want the recent logs **uncompressed** (read them
|
||||
without `zcat`) and older ones **gzipped**, pass the two tier knobs:
|
||||
|
||||
```python
|
||||
# app run from bestbuy/run.py , with name="latest":
|
||||
setup_logging(
|
||||
name="latest",
|
||||
rotate="on_start", # works for on_start, daily, and size
|
||||
keep_uncompressed=3, # newest 3 rolled logs kept PLAIN
|
||||
keep_compressed=7, # next 7 kept GZIPPED; total retained = 10
|
||||
)
|
||||
```
|
||||
|
||||
Result — the live file stays at its stable path in cwd; `log_dir` (default `logs/`) holds
|
||||
the tiered historic files, named off the project stem (newest → oldest):
|
||||
|
||||
```
|
||||
./latest.log <- live (stable, tail -f, in cwd)
|
||||
logs/
|
||||
bestbuy.<t1>.log bestbuy.<t2>.log bestbuy.<t3>.log <- 3 newest: plain
|
||||
bestbuy.<t4>.log.gz ... bestbuy.<t10>.log.gz <- next 7: gzipped
|
||||
(anything past 10 deleted)
|
||||
```
|
||||
|
||||
- Each restart (`on_start`) or roll (`daily`/`size`) moves the live file into `log_dir`,
|
||||
then re-tiers: newest `keep_uncompressed` stay plain, the next `keep_compressed` are
|
||||
gzipped in place, the rest deleted. Total kept = `keep_uncompressed + keep_compressed`.
|
||||
- **Opt-in by presence** — pass either knob to enable tiering. Pass **neither** and
|
||||
rotation behaves exactly as before (`backup_count` + gzip-on-roll), so existing callers
|
||||
are unaffected.
|
||||
- In tiered mode `backup_count` and the gzip-on-roll behavior of `compress` are **ignored**
|
||||
— the tier counts bound retention instead.
|
||||
- `keep_uncompressed=0` → everything gzipped; `keep_compressed=0` → only the plain tier.
|
||||
Retention is count-based (not time-based).
|
||||
|
||||
## 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", "ts": 1782151391, "level": "INFO",
|
||||
# "module": "bot.core", "message": "ready", "monitor": "heartbeat"}
|
||||
```
|
||||
|
||||
- **Fields:** `time`, `ts`, `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.)
|
||||
- **`ts` (added v0.6.0)** is the same instant as a unix epoch integer
|
||||
(`int(record.created)`, second resolution) alongside `time` — for a consumer that wants
|
||||
a sortable number instead of parsing the ISO string. Additive: existing `time` is
|
||||
unchanged, and a consumer that ignores unknown JSON keys is unaffected.
|
||||
- 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
|
||||
|
||||
```python
|
||||
setup_logging(
|
||||
name="run", # base -> run.log (the live file at cwd)
|
||||
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
|
||||
backup_count=14, # rotated files to keep (older auto-deleted)
|
||||
history_name=None, # stem for rolled/historic files; None -> cwd basename (project)
|
||||
backup_count=14, # rotated files to keep (flat retention; ignored if tiered)
|
||||
keep_uncompressed=None, # tiered: newest N rolled logs kept PLAIN (opt-in)
|
||||
keep_compressed=None, # tiered: next M rolled logs kept GZIPPED (opt-in)
|
||||
max_bytes=10_000_000, # only for rotate="size"
|
||||
compress=True, # gzip rolled files
|
||||
console=False, # also log to stdout (off by default; opt in)
|
||||
queue=False, # route through a background QueueListener (async-friendly)
|
||||
fmt=None, # override the format string
|
||||
datefmt=None, # override the date format
|
||||
output="text", # "text" (human, local time) | "json" (structured, UTC)
|
||||
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
|
||||
```
|
||||
|
||||
## 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`)
|
||||
|
||||
For async-heavy apps, `queue=True` routes records through a stdlib `QueueHandler` to a
|
||||
@@ -87,6 +240,32 @@ setup_logging(name="run", queue=True)
|
||||
duplicate lines) and leaves handlers your app added itself alone.
|
||||
- **Never crashes the app over logging:** if `log_dir` isn't writable, it falls back to
|
||||
console-only with a warning instead of raising.
|
||||
- **`rotate="size"` always bounds the live file (v0.5.1+).** Previously, `backup_count=0`
|
||||
with `rotate="size"` silently disabled rotation entirely (the live file grew forever,
|
||||
ignoring `max_bytes`). As of v0.5.1, the live file always rolls at `max_bytes`
|
||||
regardless of `backup_count`; `backup_count=0` means "keep zero rolled files" (each roll
|
||||
is deleted right after it lands) rather than "never roll." `backup_count>=1` behaves as
|
||||
documented (keeps that many rolled files). This does not change `"daily"`/`"on_start"`,
|
||||
where `backup_count=0` still means "roll, but don't prune the rolled files" (unbounded
|
||||
`log_dir` growth) — that is a separate, pre-existing knob, not this fix's scope.
|
||||
- **Gzip writes are crash-safe (v0.5.1+).** `_gzip_file` now writes to a `.tmp` sibling and
|
||||
atomically `os.replace`s it onto the final `.gz` path, so a crash/OOM/power-loss mid-write
|
||||
can never leave a truncated `.gz` at the path retention logic trusts. Tiered retention's
|
||||
plain/gz dedupe additionally verifies a `.gz` decompresses cleanly before deleting its
|
||||
plain twin — a corrupt `.gz` (from before this fix, or an external cause) is never
|
||||
preferred over an intact plain copy; the plain is kept and the `.gz` gets rewritten
|
||||
cleanly on the next retier pass instead of being deleted.
|
||||
- **Setup-time warnings reach the log file (v0.6.0+).** Previously, a warning raised
|
||||
during `setup_logging` itself (an invalid `module_levels` entry, a handler failing to
|
||||
close on re-setup, an unknown `rotate` value) was emitted *before* any handler was
|
||||
attached, so it only reached stderr via logging's `lastResort` fallback and never
|
||||
`run.log`. As of v0.6.0 these are buffered and flushed once the handlers are attached,
|
||||
so they land in the configured log like any other record.
|
||||
- **JSON output gained a `ts` field (v0.6.0, additive).** Alongside the existing `time`
|
||||
(UTC ISO-8601, unchanged), each JSON line now also carries `ts`: the same instant as a
|
||||
unix epoch integer (`int(record.created)`, second resolution) — for a consumer that
|
||||
wants a sortable number instead of parsing the ISO string. Purely additive: `time` is
|
||||
byte-for-byte unchanged, and a consumer that ignores unknown JSON keys is unaffected.
|
||||
|
||||
## Scope — what this is NOT
|
||||
|
||||
@@ -97,9 +276,10 @@ 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
|
||||
makes downstream parsing and alerting easy.
|
||||
|
||||
Also out of v0.1.0 (possible later additions): structured/JSON logging, color
|
||||
formatting, per-logger filters, remote handlers.
|
||||
Structured/JSON output is **in** as of v0.2.0 (`output="json"`) — text and json only.
|
||||
Still deliberately out: logfmt or other formats, a format DSL, per-handler formats,
|
||||
color formatting, per-logger filters, remote handlers.
|
||||
|
||||
## Versioning
|
||||
|
||||
Tagged `vX.Y.Z`. Pin the tag.
|
||||
Releases are tagged `vX.Y.Z`. The install line above pins a release; drop the `@vX.Y.Z` suffix to install the latest unpinned. Pin deliberately for reproducible installs.
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "log_setup"
|
||||
version = "0.1.0"
|
||||
version = "0.6.0"
|
||||
description = "stdlib app-entry-point logging setup: live run.log, rotation, gzip, retention, consistent format"
|
||||
requires-python = ">=3.10"
|
||||
dependencies = []
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
"""log_setup — app-entry-point logging configuration (sync, stdlib only).
|
||||
|
||||
call once at an application's entry point to configure the whole process: a live
|
||||
run.log, rotation (daily/size/on_start), gzip of rolled files, retention, console
|
||||
output, and a consistent `time | module | level | message` format.
|
||||
run.log, rotation (daily/size/on_start), gzip of rolled files, retention, optional
|
||||
console output, and a consistent `time | module | level | message` format.
|
||||
|
||||
from log_setup import setup_logging
|
||||
|
||||
setup_logging(name="run", level="INFO") # daily rotation, logs/ dir, gzip
|
||||
log = logging.getLogger(__name__)
|
||||
log.info("up") # -> run.log + console
|
||||
log.info("up") # -> run.log (add console=True for stdout too)
|
||||
|
||||
reusable libraries do NOT call this — they only `logging.getLogger(__name__)` and
|
||||
emit; the application owns this setup. shipping logs to a backend is out of scope
|
||||
@@ -19,4 +19,4 @@ from .setup import setup_logging
|
||||
|
||||
__all__ = ["setup_logging"]
|
||||
|
||||
__version__ = "0.1.0"
|
||||
__version__ = "0.6.0"
|
||||
|
||||
@@ -1,15 +1,79 @@
|
||||
"""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
|
||||
name the emitting module used, so each library/module shows in the line.
|
||||
two output formats, two proven needs. `text` (default) is the human `tail -f` format
|
||||
(`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
|
||||
|
||||
DEFAULT_FORMAT = "%(asctime)s | %(name)s | %(levelname)s | %(message)s"
|
||||
DEFAULT_DATEFMT = "%Y-%m-%d %H:%M:%S"
|
||||
|
||||
_RESERVED = frozenset(vars(logging.makeLogRecord({})).keys()) | {"message", "asctime"}
|
||||
# this formatter's own canonical output keys — stdlib's LogRecord rejects `extra` keys
|
||||
# colliding with real attribute names (e.g. `module`), but `time`/`level`/`ts` are NOT
|
||||
# LogRecord attrs, so a caller's extra={"time":...}/{"ts":...} would otherwise overwrite
|
||||
# the UTC timestamp / epoch. guard them explicitly
|
||||
_OUTPUT_KEYS = frozenset({"time", "ts", "level", "module", "message"})
|
||||
|
||||
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/ts/level/module/message. `time` is UTC ISO-8601 with a `Z`
|
||||
suffix (e.g. 2026-06-28T14:03:11Z); `ts` (added v0.6.0) is the same instant as a
|
||||
unix epoch int (`int(record.created)`, second resolution) for a consumer that wants
|
||||
a sortable number instead of parsing the ISO string — both sort unambiguously
|
||||
across machines/containers; Grafana converts to local for display. any field
|
||||
passed via logging `extra={...}` lands as a top-level JSON field (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"),
|
||||
"ts": int(record.created),
|
||||
"level": record.levelname,
|
||||
"module": record.name,
|
||||
"message": record.getMessage(),
|
||||
}
|
||||
for key, value in record.__dict__.items():
|
||||
if key not in _RESERVED and key not in _OUTPUT_KEYS and not key.startswith("_"):
|
||||
payload[key] = value
|
||||
if record.exc_info:
|
||||
# cache the rendered traceback on the record (as stdlib Formatter does) so a
|
||||
# second handler/format() of the same record doesn't re-render it
|
||||
if not record.exc_text:
|
||||
record.exc_text = self.formatException(record.exc_info)
|
||||
payload["exc_info"] = record.exc_text
|
||||
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)
|
||||
|
||||
+331
-31
@@ -1,23 +1,111 @@
|
||||
"""custom namer/rotator + on-start rotation + retention pruning (stdlib only).
|
||||
|
||||
the stdlib rotating handlers roll a file next to the live file; these helpers
|
||||
override the namer/rotator so rolled files land in `log_dir` and are gzipped when
|
||||
asked, keep the live file at its stable path, and handle the on-start and prune
|
||||
paths the handlers don't manage themselves.
|
||||
the stdlib rotating handlers roll a file next to the live file; these helpers override
|
||||
the namer/rotator so rolled files land in `log_dir` and are gzipped when asked, keep
|
||||
the live file at its stable path, and handle the on-start and prune paths the handlers
|
||||
don't manage themselves.
|
||||
|
||||
gzip writes are crash-safe: `_gzip_file` writes to a `.tmp` sibling and atomically
|
||||
`os.replace`s it onto the final `.gz` path, so a crash/OOM/power-loss mid-write never
|
||||
leaves a truncated `.gz` where retention would trust it. `retier`'s plain/gz dedupe
|
||||
additionally verifies a `.gz` decompresses cleanly (`_gz_intact`) before removing its
|
||||
plain twin, so a corrupt `.gz` is never preferred over an intact plain copy.
|
||||
"""
|
||||
|
||||
import gzip
|
||||
import os
|
||||
import shutil
|
||||
import time
|
||||
from typing import Callable, Tuple
|
||||
from typing import Callable, Optional, Tuple
|
||||
|
||||
|
||||
def _move(source: str, dest: str) -> None:
|
||||
"""rename source to dest, falling back to copy+unlink across filesystems
|
||||
|
||||
os.replace is atomic but raises OSError(EXDEV) across filesystems — the container
|
||||
bind-mount / separate-logs-volume case this lib targets. falls back to shutil.move
|
||||
(copy+unlink) so the roll still lands instead of failing rotation silently.
|
||||
|
||||
precondition: `dest` is a free, non-directory path (every call site generates a
|
||||
unique timestamped/dated dest) — not safe for arbitrary dests that may already
|
||||
exist as a directory.
|
||||
"""
|
||||
try:
|
||||
os.replace(source, dest)
|
||||
except OSError:
|
||||
shutil.move(source, dest)
|
||||
|
||||
|
||||
def _free_dest(dest: str) -> str:
|
||||
"""return `dest`, or a `.N`-suffixed variant if it (or its .gz twin) already exists
|
||||
|
||||
used by the tiered rotator so a second roll landing on the same dated/stamped name
|
||||
(two daily rolls in one day) doesn't clobber the earlier file. checks both the plain
|
||||
and .gz forms of each candidate.
|
||||
"""
|
||||
if not os.path.exists(dest) and not os.path.exists(dest + ".gz"):
|
||||
return dest
|
||||
counter = 1
|
||||
while True:
|
||||
candidate = f"{dest}.{counter}"
|
||||
if not os.path.exists(candidate) and not os.path.exists(candidate + ".gz"):
|
||||
return candidate
|
||||
counter += 1
|
||||
|
||||
|
||||
def _gzip_file(source: str, dest: str) -> None:
|
||||
"""gzip source into dest then remove source (the rolled-file compression idiom)
|
||||
|
||||
writes to `dest + ".tmp"` and atomically `os.replace`s it onto `dest` once
|
||||
complete, so a crash/OOM/power-loss mid-write never leaves a truncated `.gz` at
|
||||
`dest` — the partial write stays quarantined in `.tmp` and source is untouched
|
||||
(safe to retry).
|
||||
|
||||
the source mtime is carried onto dest so a file keeps its tier position when it
|
||||
crosses the plain->gz boundary — retier ranks by mtime, and a fresh write would
|
||||
otherwise make a just-compressed file look newest and reshuffle tiers.
|
||||
"""
|
||||
mtime = _safe_mtime(source)
|
||||
tmp_dest = dest + ".tmp"
|
||||
try:
|
||||
with open(source, "rb") as src, gzip.open(tmp_dest, "wb") as dst:
|
||||
shutil.copyfileobj(src, dst)
|
||||
except BaseException:
|
||||
try:
|
||||
os.remove(tmp_dest)
|
||||
except OSError:
|
||||
pass
|
||||
raise
|
||||
os.replace(tmp_dest, dest)
|
||||
os.remove(source)
|
||||
try:
|
||||
os.utime(dest, (mtime, mtime))
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def _gz_intact(path: str) -> bool:
|
||||
"""return True if the gzip file at path decompresses cleanly end to end
|
||||
|
||||
belt-and-suspenders check before a dedupe site removes a plain twin in favor of its
|
||||
.gz — a truncated/corrupt .gz must never be trusted over an intact plain copy. reads
|
||||
the whole stream (gzip.open only validates end-of-stream on a full read); any
|
||||
failure is treated as "not intact" so the caller keeps the plain source.
|
||||
"""
|
||||
try:
|
||||
with gzip.open(path, "rb") as handle:
|
||||
while handle.read(1 << 20):
|
||||
pass
|
||||
return True
|
||||
except Exception:
|
||||
return False
|
||||
|
||||
|
||||
def make_namer(log_dir: str, compress: bool) -> Callable[[str], str]:
|
||||
"""namer: redirect a rolled filename into log_dir, adding .gz when compressing
|
||||
|
||||
the handler hands us the default rolled path (next to the live file); we keep its
|
||||
basename but place it under log_dir, and append .gz so the gzipped name matches.
|
||||
keeps the handler's default rolled basename but places it under log_dir, appending
|
||||
.gz so the gzipped name matches.
|
||||
"""
|
||||
def namer(default_name: str) -> str:
|
||||
base = os.path.basename(default_name)
|
||||
@@ -26,48 +114,239 @@ def make_namer(log_dir: str, compress: bool) -> Callable[[str], str]:
|
||||
return namer
|
||||
|
||||
|
||||
def make_rotator(compress: bool) -> Callable[[str, str], None]:
|
||||
"""rotator: move (or gzip) the source live file to the destination rolled path"""
|
||||
def make_history_namer(
|
||||
stem: str, log_dir: str, compress: bool = False, plain: bool = False,
|
||||
clock=time.localtime,
|
||||
) -> Callable[[str], str]:
|
||||
"""namer minting historic rolled files `<stem>.<Y-m-d_H-M-S>.log[.gz]` in log_dir
|
||||
|
||||
used by size and daily (and their tiered variants). `stem` is the HISTORY stem (the
|
||||
project namespace), independent of the live file's name. FOOTGUN: prune/retier must
|
||||
glob this same stem or nothing matches and retention silently never fires.
|
||||
|
||||
ignores the stdlib handler's own rolled name (`.N` for size, `.log.<date>` for
|
||||
daily) in favor of a uniform timestamped name so all modes converge on one shape
|
||||
retier can rank/tier. `plain=True` (tiered mode) always lands `.log`, letting retier
|
||||
decide compression; same-second collisions disambiguate with a counter, checking
|
||||
both .log and .log.gz forms.
|
||||
"""
|
||||
def namer(default_name: str) -> str:
|
||||
stamp = time.strftime("%Y-%m-%d_%H-%M-%S", clock())
|
||||
base = os.path.join(log_dir, f"{stem}.{stamp}")
|
||||
candidate = base
|
||||
counter = 1
|
||||
while os.path.exists(candidate + ".log") or os.path.exists(candidate + ".log.gz"):
|
||||
candidate = f"{base}.{counter}"
|
||||
counter += 1
|
||||
suffix = ".log.gz" if (compress and not plain) else ".log"
|
||||
return candidate + suffix
|
||||
return namer
|
||||
|
||||
|
||||
def make_rotator(
|
||||
compress: bool, log_dir: Optional[str] = None,
|
||||
prune_stem: Optional[str] = None, backup_count: int = 0,
|
||||
keep_uncompressed: Optional[int] = None, keep_compressed: Optional[int] = None,
|
||||
) -> Callable[[str, str], None]:
|
||||
"""rotator: move (or gzip) the source live file to the destination rolled path
|
||||
|
||||
legacy mode (default): gzip on roll when `compress`, then prune `log_dir` to
|
||||
`backup_count` newest rolled files — the stdlib handler's own retention only scans
|
||||
the live file's directory, so it never sees files redirected into `log_dir`; pruning
|
||||
here is what bounds retention for daily/size. FOOTGUN: `backup_count <= 0` means
|
||||
"keep no rolled history", but `prune()` itself no-ops at `<= 0` (its own sentinel for
|
||||
"don't touch history") — so a zero-retention roll is deleted by the rotator directly
|
||||
right after landing, rather than relying on prune to do it.
|
||||
|
||||
tiered mode (when `keep_uncompressed`/`keep_compressed` are given): land the rolled
|
||||
file PLAIN and re-tier `log_dir` — newest `keep_uncompressed` stay uncompressed, next
|
||||
`keep_compressed` gzipped, rest deleted. `compress`/`backup_count` are ignored.
|
||||
"""
|
||||
tiered = keep_uncompressed is not None or keep_compressed is not None
|
||||
|
||||
def rotator(source: str, dest: str) -> None:
|
||||
if not os.path.exists(source):
|
||||
return
|
||||
if tiered:
|
||||
# dest carries the namer's .gz suffix in compress mode; strip it so the roll
|
||||
# lands plain and retier decides its tier. disambiguate a dest that already
|
||||
# exists (a second same-interval daily roll reuses the same dated name) with
|
||||
# a counter, checking both .log and .log.gz forms.
|
||||
plain_dest = _free_dest(dest[:-3] if dest.endswith(".gz") else dest)
|
||||
_move(source, plain_dest)
|
||||
if log_dir is not None and prune_stem is not None:
|
||||
retier(log_dir, prune_stem, keep_uncompressed or 0, keep_compressed or 0)
|
||||
return
|
||||
if compress:
|
||||
with open(source, "rb") as src, gzip.open(dest, "wb") as dst:
|
||||
shutil.copyfileobj(src, dst)
|
||||
os.remove(source)
|
||||
_gzip_file(source, dest)
|
||||
else:
|
||||
os.replace(source, dest)
|
||||
_move(source, dest)
|
||||
if backup_count <= 0:
|
||||
try:
|
||||
os.remove(dest)
|
||||
except OSError:
|
||||
pass
|
||||
elif log_dir is not None and prune_stem is not None:
|
||||
prune(log_dir, prune_stem, backup_count)
|
||||
return rotator
|
||||
|
||||
|
||||
def rotate_on_start(live_path: str, log_dir: str, compress: bool, clock=time.localtime) -> None:
|
||||
def rotate_on_start(
|
||||
live_path: str, log_dir: str, compress: bool, clock=time.localtime,
|
||||
keep_uncompressed: Optional[int] = None, keep_compressed: Optional[int] = None,
|
||||
history_stem: Optional[str] = None,
|
||||
) -> None:
|
||||
"""move an existing live file into log_dir with a timestamp, gzipped if asked
|
||||
|
||||
named off `history_stem` (the project namespace) when given, so historic files
|
||||
carry the project name independent of the live file's stem; falls back to the live
|
||||
file's own stem when history_stem is None/empty.
|
||||
|
||||
no-op if the live file doesn't exist. used by rotate="on_start" before the fresh
|
||||
handler opens a new live file. the timestamp form is run.<%Y-%m-%d_%H-%M-%S>.log.
|
||||
handler opens a new live file. timestamp form is run.<%Y-%m-%d_%H-%M-%S>.log.
|
||||
|
||||
tiered mode (`keep_uncompressed`/`keep_compressed` given): the rolled file always
|
||||
lands PLAIN (so it can occupy the newest uncompressed tier) and `retier` decides
|
||||
compression/deletion across the whole stem — `compress` is ignored here.
|
||||
"""
|
||||
if not os.path.exists(live_path):
|
||||
return
|
||||
stem = os.path.splitext(os.path.basename(live_path))[0]
|
||||
tiered = keep_uncompressed is not None or keep_compressed is not None
|
||||
live_stem = os.path.splitext(os.path.basename(live_path))[0]
|
||||
stem = os.path.basename(history_stem) if history_stem else live_stem
|
||||
stamp = time.strftime("%Y-%m-%d_%H-%M-%S", clock())
|
||||
dest = os.path.join(log_dir, f"{stem}.{stamp}.log")
|
||||
if compress:
|
||||
dest += ".gz"
|
||||
with open(live_path, "rb") as src, gzip.open(dest, "wb") as dst:
|
||||
shutil.copyfileobj(src, dst)
|
||||
os.remove(live_path)
|
||||
suffix = ".log.gz" if (compress and not tiered) else ".log"
|
||||
|
||||
# the 1-second stamp resolution means two starts in the same second collide;
|
||||
# disambiguate with a counter so a rapid crash-restart loop doesn't lose the
|
||||
# earlier roll. check BOTH .log and .log.gz forms: in tiered mode an earlier
|
||||
# same-stamp roll may already be compressed, and reusing its bare stem would
|
||||
# create a second file for the same logical roll and break the tier counts
|
||||
def _taken(path: str) -> bool:
|
||||
base = path[:-3] if path.endswith(".gz") else path
|
||||
return os.path.exists(base) or os.path.exists(base + ".gz")
|
||||
|
||||
dest = os.path.join(log_dir, f"{stem}.{stamp}{suffix}")
|
||||
counter = 1
|
||||
while _taken(dest):
|
||||
dest = os.path.join(log_dir, f"{stem}.{stamp}.{counter}{suffix}")
|
||||
counter += 1
|
||||
if compress and not tiered:
|
||||
_gzip_file(live_path, dest)
|
||||
else:
|
||||
os.replace(live_path, dest)
|
||||
_move(live_path, dest)
|
||||
if tiered:
|
||||
retier(log_dir, stem, keep_uncompressed or 0, keep_compressed or 0)
|
||||
|
||||
|
||||
def retier(log_dir: str, stem: str, keep_uncompressed: int, keep_compressed: int) -> None:
|
||||
"""re-tier rolled files for stem: newest plain, next gzipped, rest deleted
|
||||
|
||||
newest-first by mtime: the first `keep_uncompressed` stay uncompressed, the next
|
||||
`keep_compressed` are gzipped in place, everything beyond
|
||||
keep_uncompressed+keep_compressed is deleted. the live <stem>.log is never touched.
|
||||
fail-soft per file (skip on OSError) so retention never crashes setup.
|
||||
|
||||
FOOTGUN: `stem` is reduced to its basename to match how rolled files land in
|
||||
log_dir (namer/rotate_on_start basename them) — a `name` containing a directory
|
||||
(e.g. "sub/run") must be matched by "run." here or nothing matches and retention
|
||||
silently never fires (unbounded pileup).
|
||||
|
||||
ordering is by mtime, then by the roll counter parsed from the name, so a
|
||||
same-second burst (tied mtimes, counter-disambiguated stamps like run.<t>.log /
|
||||
run.<t>.1.log) still tiers newest-first rather than falling back to listdir order.
|
||||
"""
|
||||
stem = os.path.basename(stem)
|
||||
try:
|
||||
names = [
|
||||
name for name in os.listdir(log_dir)
|
||||
if name.startswith(f"{stem}.") and name != f"{stem}.log"
|
||||
]
|
||||
except OSError:
|
||||
return
|
||||
entries = [os.path.join(log_dir, name) for name in names]
|
||||
# dedupe plain/gz twins FIRST (a crash between _gzip_file's write and its os.remove
|
||||
# can leave <x>.log beside <x>.log.gz) so the phantom twin never occupies a
|
||||
# retention slot and evicts a distinct older roll — but ONLY once the .gz is
|
||||
# verified to decompress cleanly (_gz_intact): a pre-existing corrupt .gz must never
|
||||
# win over an intact plain copy, which would delete the only good copy.
|
||||
present = set(entries)
|
||||
kept = []
|
||||
for p in entries:
|
||||
if not p.endswith(".gz") and (p + ".gz") in present:
|
||||
if _gz_intact(p + ".gz"):
|
||||
try:
|
||||
os.remove(p)
|
||||
except OSError:
|
||||
kept.append(p) # couldn't remove — keep it in the accounting
|
||||
continue
|
||||
# .gz twin is corrupt — keep the intact plain untouched; a later retier
|
||||
# retries the compress once it's re-gzipped cleanly
|
||||
kept.append(p)
|
||||
files = [(p, _safe_mtime(p), _roll_counter(p)) for p in kept if os.path.isfile(p)]
|
||||
# newest-first: higher mtime first, tied second broken by higher roll counter (later)
|
||||
files.sort(key=lambda t: (t[1], t[2]), reverse=True)
|
||||
|
||||
keep = keep_uncompressed + keep_compressed
|
||||
for index, (path, _, _) in enumerate(files):
|
||||
if index >= keep:
|
||||
try:
|
||||
os.remove(path)
|
||||
except OSError:
|
||||
pass
|
||||
elif index >= keep_uncompressed and not path.endswith(".gz"):
|
||||
dest = path + ".gz"
|
||||
if os.path.exists(dest):
|
||||
# a crash between _gzip_file's write and its os.remove can leave a plain
|
||||
# source beside a fresh .gz — drop the redundant plain twin, but ONLY
|
||||
# once the .gz is verified intact (a corrupt .gz must never win)
|
||||
if _gz_intact(dest):
|
||||
try:
|
||||
os.remove(path)
|
||||
except OSError:
|
||||
pass
|
||||
continue
|
||||
# .gz is corrupt — fall through and re-gzip the plain over the bad dest
|
||||
# (atomic write replaces it only once a valid archive exists)
|
||||
try:
|
||||
_gzip_file(path, dest)
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def _roll_counter(path: str) -> int:
|
||||
"""parse the same-second disambiguation counter out of a rolled filename
|
||||
|
||||
only the on_start / size-namer shape carries a counter: `<stem>.<stamp>[.<counter>].log`
|
||||
(optionally `.gz`), where a colliding same-second roll gets `.1`, `.2`, ... and a higher
|
||||
counter is the later (newer) roll. the first roll of a second has no counter (0).
|
||||
|
||||
daily's dated names (`<stem>.log.<Y-m-d>`) do NOT end in `.log` and are second+-granular
|
||||
(distinct mtimes), so they never need the counter tie-break — return 0 for them rather
|
||||
than misparsing the trailing date component as a counter.
|
||||
"""
|
||||
base = path[:-3] if path.endswith(".gz") else path
|
||||
if not base.endswith(".log"):
|
||||
return 0
|
||||
base = base[:-4]
|
||||
tail = base.rsplit(".", 1)[-1]
|
||||
return int(tail) if tail.isdigit() else 0
|
||||
|
||||
|
||||
def prune(log_dir: str, stem: str, backup_count: int) -> None:
|
||||
"""keep only the newest `backup_count` rolled files for a given stem in log_dir
|
||||
|
||||
matches files beginning with `<stem>.` (e.g. run.*), sorted by mtime, deleting the
|
||||
matches files beginning with `<stem>.` (e.g. run.*), sorted newest-first by mtime
|
||||
then roll counter (mirrors retier's ordering — see _roll_counter), deleting the
|
||||
oldest beyond the count. used for on_start, which the handlers don't auto-prune.
|
||||
|
||||
FOOTGUN: `stem` is reduced to its basename so a `name` containing a directory (e.g.
|
||||
"sub/run") still matches the basenamed rolled files in log_dir — else nothing
|
||||
matches and old files pile up forever.
|
||||
"""
|
||||
if backup_count <= 0:
|
||||
return
|
||||
stem = os.path.basename(stem)
|
||||
try:
|
||||
entries = [
|
||||
os.path.join(log_dir, name)
|
||||
@@ -76,9 +355,9 @@ def prune(log_dir: str, stem: str, backup_count: int) -> None:
|
||||
]
|
||||
except OSError:
|
||||
return
|
||||
files = [(p, _safe_mtime(p)) for p in entries if os.path.isfile(p)]
|
||||
files.sort(key=lambda pair: pair[1], reverse=True)
|
||||
for path, _ in files[backup_count:]:
|
||||
files = [(p, _safe_mtime(p), _roll_counter(p)) for p in entries if os.path.isfile(p)]
|
||||
files.sort(key=lambda t: (t[1], t[2]), reverse=True)
|
||||
for path, _, _ in files[backup_count:]:
|
||||
try:
|
||||
os.remove(path)
|
||||
except OSError:
|
||||
@@ -93,10 +372,31 @@ def _safe_mtime(path: str) -> float:
|
||||
return 0.0
|
||||
|
||||
|
||||
def attach_rolling(handler, log_dir: str, compress: bool) -> Tuple[Callable, Callable]:
|
||||
"""wire the custom namer + rotator onto a rotating handler; return them"""
|
||||
namer = make_namer(log_dir, compress)
|
||||
rotator = make_rotator(compress)
|
||||
def attach_rolling(
|
||||
handler, log_dir: str, compress: bool,
|
||||
prune_stem: Optional[str] = None, backup_count: int = 0,
|
||||
keep_uncompressed: Optional[int] = None, keep_compressed: Optional[int] = None,
|
||||
tiered: bool = False,
|
||||
) -> Tuple[Callable, Callable]:
|
||||
"""wire the custom namer + rotator onto a rotating handler; return them
|
||||
|
||||
rolled files are named off `prune_stem` (the HISTORY stem — the project namespace),
|
||||
independent of the live file name, via make_history_namer: `<stem>.<stamp>.log[.gz]`
|
||||
uniform across size and daily — replacing the stdlib handler's own rolled-name
|
||||
scheme (`.N` for size, `.log.<date>` for daily), which can't inject a project stem
|
||||
and (for size) can't be managed once files are redirected into log_dir.
|
||||
|
||||
pass `prune_stem`/`backup_count` so the rotator prunes `log_dir` after each roll
|
||||
(the handler's own retention can't see the redirected files). pass
|
||||
`keep_uncompressed`/`keep_compressed` for tiered retention instead (see
|
||||
make_rotator); `tiered=True` lands rolls plain (retier compresses).
|
||||
"""
|
||||
namer = make_history_namer(
|
||||
os.path.basename(prune_stem or ""), log_dir, compress, plain=tiered,
|
||||
)
|
||||
rotator = make_rotator(
|
||||
compress, log_dir, prune_stem, backup_count, keep_uncompressed, keep_compressed,
|
||||
)
|
||||
handler.namer = namer
|
||||
handler.rotator = rotator
|
||||
return namer, rotator
|
||||
|
||||
+238
-33
@@ -2,18 +2,24 @@
|
||||
|
||||
`setup_logging` configures the root logger once for the whole process: a live
|
||||
run.log at a stable path, rotation (daily/size/on_start/none) into a logs/ dir, gzip
|
||||
of rolled files, retention, console output, and a consistent format. it is called by
|
||||
the APPLICATION, not by reusable libraries (those stay emit-only). it is idempotent
|
||||
(no duplicate handlers on repeat calls), never crashes the app over logging, and can
|
||||
of rolled files, retention, console output, and a consistent format. called by the
|
||||
APPLICATION, not by reusable libraries (those stay emit-only). idempotent (no
|
||||
duplicate handlers on repeat calls), never crashes the app over logging, and can
|
||||
route through a background queue so an async event loop doesn't block on file I/O.
|
||||
|
||||
`rotate="size"` always bounds the live file: the roll fires at `max_bytes` regardless
|
||||
of `backup_count`, including `backup_count=0` (means "keep zero rolled files", not
|
||||
"never roll" — each roll is deleted right after landing).
|
||||
"""
|
||||
|
||||
import atexit
|
||||
import logging
|
||||
import logging.handlers
|
||||
import os
|
||||
import queue
|
||||
from typing import Optional, Union
|
||||
import queue as _queue
|
||||
import sys
|
||||
import traceback
|
||||
from typing import Dict, Optional, Union
|
||||
|
||||
from .formats import build_formatter
|
||||
from .rotation import attach_rolling, prune, rotate_on_start
|
||||
@@ -22,20 +28,95 @@ log = logging.getLogger(__name__)
|
||||
|
||||
_MARKER = "_log_setup_owned"
|
||||
_listener = None
|
||||
_atexit_registered = False
|
||||
|
||||
|
||||
def _exc_text() -> str:
|
||||
"""render sys.exc_info() as text, for capturing a traceback into a buffered warning
|
||||
|
||||
(log.warning(..., exc_info=True) only works logged live from the except block; setup
|
||||
warnings are deferred, see _flush_warnings, so render eagerly instead)
|
||||
"""
|
||||
return "".join(traceback.format_exception(*sys.exc_info())).strip()
|
||||
|
||||
|
||||
def _flush_warnings(warnings: list) -> None:
|
||||
"""emit buffered setup-time warnings now that handlers are attached
|
||||
|
||||
setup-time warnings fire before this call's handlers exist, so logging them
|
||||
immediately would only reach stderr (logging's lastResort) and never the file being
|
||||
configured — buffer, then flush once attached so they land like any other record
|
||||
"""
|
||||
for message, *args in warnings:
|
||||
log.warning(message, *args)
|
||||
|
||||
|
||||
def _level_value(level: Union[int, str]) -> int:
|
||||
"""coerce a level name or int to a logging level int (defaults to INFO)"""
|
||||
if isinstance(level, bool):
|
||||
# bool is an int subclass (True==1, below DEBUG) but is never a real level —
|
||||
# reject it consistently with the per-module path rather than set level 1
|
||||
return logging.INFO
|
||||
if isinstance(level, int):
|
||||
return level
|
||||
return logging.getLevelName(str(level).upper()) if isinstance(level, str) else logging.INFO
|
||||
if not isinstance(level, str):
|
||||
return logging.INFO
|
||||
resolved = logging.getLevelName(level.upper())
|
||||
# getLevelName returns the string "Level XXX" for an unknown name, which
|
||||
# setLevel then rejects — never crash the app over a bad level, fall back to INFO
|
||||
return resolved if isinstance(resolved, int) else logging.INFO
|
||||
|
||||
|
||||
def _clear_owned(root: logging.Logger) -> None:
|
||||
"""remove only the handlers this lib previously added; leave app handlers alone"""
|
||||
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` (falls back to INFO for the root `level`), reports invalid as
|
||||
None so the per-module path can skip + warn instead of silently applying INFO
|
||||
"""
|
||||
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]]], warnings: list) -> None:
|
||||
"""set per-logger level overrides by exact logger name, never crashing
|
||||
|
||||
names match exactly (no discovery); stdlib hierarchy still applies, so a parent name
|
||||
quiets its whole subtree. a bad level is skipped, its warning appended to `warnings`
|
||||
(no handlers exist yet — see _flush_warnings) rather than emitted directly
|
||||
"""
|
||||
if not module_levels:
|
||||
return
|
||||
for mod_name, raw_level in module_levels.items():
|
||||
value = _strict_level_value(raw_level)
|
||||
if value is None:
|
||||
warnings.append(("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, warnings: list) -> None:
|
||||
"""remove only the handlers this lib previously added; leave app handlers alone
|
||||
|
||||
close failures are appended to `warnings`, not logged directly — no handlers exist
|
||||
yet at this point in setup (see _flush_warnings)
|
||||
"""
|
||||
global _listener
|
||||
if _listener is not None:
|
||||
_listener.stop()
|
||||
# listener owns the real file/console handlers (only QueueHandler is root-
|
||||
# attached + marked); stopping it doesn't close them, so close here rather than
|
||||
# rely on GC finalizers across a re-setup
|
||||
for wrapped in getattr(_listener, "handlers", ()):
|
||||
try:
|
||||
wrapped.close()
|
||||
except Exception:
|
||||
warnings.append(("log_setup: failed to close queued handler %r: %s", wrapped, _exc_text()))
|
||||
_listener = None
|
||||
for handler in list(root.handlers):
|
||||
if getattr(handler, _MARKER, False):
|
||||
@@ -43,7 +124,9 @@ def _clear_owned(root: logging.Logger) -> None:
|
||||
try:
|
||||
handler.close()
|
||||
except Exception:
|
||||
pass
|
||||
warnings.append(
|
||||
("log_setup: failed to close handler %r during re-setup: %s", handler, _exc_text())
|
||||
)
|
||||
|
||||
|
||||
def _tag(handler: logging.Handler) -> logging.Handler:
|
||||
@@ -52,25 +135,89 @@ def _tag(handler: logging.Handler) -> logging.Handler:
|
||||
return handler
|
||||
|
||||
|
||||
def _normalize_name(name: str) -> str:
|
||||
"""strip one trailing '.log' (case-insensitive) so the stem is extension-free
|
||||
|
||||
`name` is allowed to be passed with or without the extension — "latest" and
|
||||
"latest.log" both yield stem "latest" (live file latest.log), never latest.log.log.
|
||||
only one level is stripped: "app.log.log" -> "app.log" so a legit ".log" inside a
|
||||
name survives.
|
||||
"""
|
||||
if name.lower().endswith(".log"):
|
||||
return name[:-4]
|
||||
return name
|
||||
|
||||
|
||||
def _history_stem() -> str:
|
||||
"""the project namespace for historic files: the cwd basename
|
||||
|
||||
a service run from bestbuy/ gives historic files bestbuy.<stamp>.log[.gz]. falls back
|
||||
to an empty string only for a degenerate cwd (e.g. "/"), which the caller resolves to
|
||||
the live stem.
|
||||
"""
|
||||
try:
|
||||
return os.path.basename(os.getcwd().rstrip(os.sep))
|
||||
except OSError:
|
||||
return ""
|
||||
|
||||
|
||||
def _file_handler(
|
||||
name: str, live_path: str, log_dir: str, rotate: Optional[str],
|
||||
name: str, history_stem: str, live_path: str, log_dir: str, rotate: Optional[str],
|
||||
backup_count: int, max_bytes: int, compress: bool,
|
||||
keep_uncompressed: Optional[int], keep_compressed: Optional[int], warnings: list,
|
||||
) -> logging.Handler:
|
||||
"""build the configured file handler with custom rolling into log_dir"""
|
||||
"""build the configured file handler with custom rolling into log_dir
|
||||
|
||||
`name` is the LIVE stem (drives live_path); `history_stem` is the PROJECT stem that
|
||||
rolled/historic files are named off + the retention glob keys on — decoupled: the
|
||||
live file keeps its defined name, historic files carry the project namespace. an
|
||||
unknown `rotate` is appended to `warnings` rather than logged directly (see
|
||||
_flush_warnings — no handlers exist yet at this point).
|
||||
"""
|
||||
tiered = keep_uncompressed is not None or keep_compressed is not None
|
||||
if rotate == "size":
|
||||
# stdlib doRollover no-ops at backupCount==0, and its numbered .1/.2 shift can't
|
||||
# manage files redirected into log_dir — force nonzero so the roll always fires,
|
||||
# and let attach_rolling's namer + retier/prune bound retention instead. the
|
||||
# REAL backup_count (maybe 0) still flows to attach_rolling below: make_rotator
|
||||
# treats <=0 there as "keep no rolled history" and deletes each roll right after
|
||||
# landing, rather than passing 0 to prune() (whose own <=0 is a "leave history
|
||||
# alone" no-op — that mismatch is what silently disabled rotation before)
|
||||
size_backup = max(backup_count, 1)
|
||||
handler = logging.handlers.RotatingFileHandler(
|
||||
live_path, maxBytes=max_bytes, backupCount=backup_count, encoding="utf-8",
|
||||
live_path, maxBytes=max_bytes, backupCount=size_backup, encoding="utf-8",
|
||||
)
|
||||
attach_rolling(
|
||||
handler, log_dir, compress, prune_stem=history_stem, backup_count=backup_count,
|
||||
keep_uncompressed=keep_uncompressed, keep_compressed=keep_compressed,
|
||||
tiered=tiered,
|
||||
)
|
||||
attach_rolling(handler, log_dir, compress)
|
||||
elif rotate == "daily":
|
||||
handler = logging.handlers.TimedRotatingFileHandler(
|
||||
live_path, when="midnight", backupCount=backup_count, encoding="utf-8",
|
||||
)
|
||||
attach_rolling(handler, log_dir, compress)
|
||||
attach_rolling(
|
||||
handler, log_dir, compress, prune_stem=history_stem, backup_count=backup_count,
|
||||
keep_uncompressed=keep_uncompressed, keep_compressed=keep_compressed,
|
||||
tiered=tiered,
|
||||
)
|
||||
else:
|
||||
if rotate == "on_start":
|
||||
rotate_on_start(live_path, log_dir, compress)
|
||||
prune(log_dir, name, backup_count)
|
||||
if tiered:
|
||||
rotate_on_start(
|
||||
live_path, log_dir, compress, history_stem=history_stem,
|
||||
keep_uncompressed=keep_uncompressed, keep_compressed=keep_compressed,
|
||||
)
|
||||
else:
|
||||
rotate_on_start(live_path, log_dir, compress, history_stem=history_stem)
|
||||
prune(log_dir, history_stem, backup_count)
|
||||
elif rotate is not None:
|
||||
# a typo'd value (e.g. "hourly") would otherwise silently fall through to a
|
||||
# non-rotating FileHandler and grow forever — warn instead of degrade silently
|
||||
warnings.append((
|
||||
"log_setup: unknown rotate %r; expected 'daily'/'size'/'on_start'/None — "
|
||||
"no rotation applied (single growing file)", rotate,
|
||||
))
|
||||
handler = logging.FileHandler(live_path, encoding="utf-8")
|
||||
return handler
|
||||
|
||||
@@ -79,33 +226,80 @@ def setup_logging(
|
||||
name: str = "run",
|
||||
log_dir: str = "logs",
|
||||
level: Union[int, str] = "INFO",
|
||||
module_levels: Optional[Dict[str, Union[int, str]]] = None,
|
||||
rotate: Optional[str] = "daily",
|
||||
history_name: Optional[str] = None,
|
||||
backup_count: int = 14,
|
||||
keep_uncompressed: Optional[int] = None,
|
||||
keep_compressed: Optional[int] = None,
|
||||
max_bytes: int = 10_000_000,
|
||||
compress: bool = True,
|
||||
console: bool = False,
|
||||
queue: bool = False,
|
||||
output: str = "text",
|
||||
fmt: Optional[str] = None,
|
||||
datefmt: Optional[str] = None,
|
||||
) -> logging.Logger:
|
||||
"""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`.
|
||||
`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
|
||||
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
|
||||
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.
|
||||
`name` -> <name>.log live file at cwd; rolled/compressed copies go to `log_dir`. a
|
||||
trailing ".log" in `name` is stripped so "latest" and "latest.log" both produce
|
||||
latest.log (never latest.log.log).
|
||||
|
||||
`history_name` names the rolled/historic files (`<history_name>.<timestamp>.log[.gz]`),
|
||||
independent of the live file: defaults to the PROJECT namespace = the cwd basename
|
||||
(run from bestbuy/ -> historic files bestbuy.<stamp>...), settable explicitly. the
|
||||
live file always keeps `name`; only historic files carry the project name.
|
||||
|
||||
`keep_uncompressed`/`keep_compressed` (default None) enable TIERED retention: when
|
||||
either is given, rolled files are kept as the newest `keep_uncompressed` uncompressed
|
||||
+ the next `keep_compressed` gzipped, rest deleted (total retained = sum). applies to
|
||||
"on_start", "daily", and "size". `backup_count` and gzip-on-roll `compress` are
|
||||
IGNORED in tiered mode. pass NEITHER knob and rotation behaves exactly as before.
|
||||
|
||||
`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"}) from the one setup call
|
||||
instead of scattering `getLogger(...).setLevel(...)` afterwards (stdlib hierarchy
|
||||
under the hood, not new capability). names match EXACTLY (no discovery: a typo'd
|
||||
name silently configures an unused logger), but hierarchy applies, so naming a
|
||||
parent ("aiohttp") quiets its whole subtree. str or int per entry; a bad value is
|
||||
skipped with a warning and never aborts the others or the setup.
|
||||
|
||||
`rotate` is "daily" (default), "size", "on_start", or None. for `rotate="size"`, the
|
||||
live file always rolls at `max_bytes` regardless of `backup_count`: `backup_count=0`
|
||||
means "keep zero rolled files" (each roll lands then is deleted immediately), NOT
|
||||
"disable rotation". `backup_count>=1` keeps that many rolled files as before.
|
||||
|
||||
`console=True` adds a 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 (stopped at exit). `output` is "text" (default, human `time |
|
||||
module | level | message`, local time) or "json" (structured JSON Lines for the
|
||||
Grafana/Loki path, UTC timestamps + a unix-epoch `ts`, `extra=` fields surfaced as
|
||||
top-level keys); file and console use the same format, live-file name unaffected.
|
||||
`fmt`/`datefmt` 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; an unknown `output` falls back to text.
|
||||
"""
|
||||
global _listener
|
||||
global _listener, _atexit_registered
|
||||
|
||||
warnings: list = []
|
||||
|
||||
root = logging.getLogger()
|
||||
root.setLevel(_level_value(level))
|
||||
_clear_owned(root)
|
||||
_apply_module_levels(module_levels, warnings)
|
||||
_clear_owned(root, warnings)
|
||||
|
||||
formatter = build_formatter(fmt, datefmt)
|
||||
live_path = f"{name}.log"
|
||||
formatter = build_formatter(output, fmt, datefmt)
|
||||
stem = _normalize_name(name)
|
||||
live_path = f"{stem}.log"
|
||||
# historic/rolled files are named off the project namespace: history_name if given,
|
||||
# else the cwd basename. normalized + basenamed like `name`; falls back to the live
|
||||
# stem for a degenerate cwd so naming/retention never break.
|
||||
history_source = history_name if history_name is not None else _history_stem()
|
||||
history_stem = os.path.basename(_normalize_name(history_source)) or stem
|
||||
|
||||
handlers = []
|
||||
|
||||
@@ -117,7 +311,10 @@ def setup_logging(
|
||||
|
||||
if file_ok:
|
||||
try:
|
||||
fh = _file_handler(name, live_path, log_dir, rotate, backup_count, max_bytes, compress)
|
||||
fh = _file_handler(
|
||||
stem, history_stem, live_path, log_dir, rotate, backup_count, max_bytes, compress,
|
||||
keep_uncompressed, keep_compressed, warnings,
|
||||
)
|
||||
fh.setFormatter(formatter)
|
||||
handlers.append(fh)
|
||||
except OSError:
|
||||
@@ -129,25 +326,33 @@ def setup_logging(
|
||||
handlers.append(sh)
|
||||
|
||||
if queue:
|
||||
record_queue: "queue.Queue" = _make_queue()
|
||||
record_queue: "_queue.Queue" = _make_queue()
|
||||
qh = _tag(logging.handlers.QueueHandler(record_queue))
|
||||
root.addHandler(qh)
|
||||
_listener = logging.handlers.QueueListener(record_queue, *handlers, respect_handler_level=True)
|
||||
_listener.start()
|
||||
atexit.register(_stop_listener)
|
||||
if not _atexit_registered:
|
||||
# register once — atexit doesn't dedupe; repeated re-setups would otherwise
|
||||
# stack identical callbacks
|
||||
atexit.register(_stop_listener)
|
||||
_atexit_registered = True
|
||||
else:
|
||||
for handler in handlers:
|
||||
root.addHandler(_tag(handler))
|
||||
|
||||
if not file_ok:
|
||||
log.warning("log_setup: log_dir %r not writable; logging to console only", log_dir)
|
||||
warnings.append(("log_setup: log_dir %r not writable; logging to console only", log_dir))
|
||||
|
||||
# flush now that handlers are attached, so setup-time warnings actually land in the
|
||||
# configured log rather than being lost to stderr before any handler existed
|
||||
_flush_warnings(warnings)
|
||||
|
||||
return root
|
||||
|
||||
|
||||
def _make_queue() -> "queue.Queue":
|
||||
def _make_queue() -> "_queue.Queue":
|
||||
"""unbounded in-memory queue for the QueueHandler -> QueueListener path"""
|
||||
return queue.Queue(-1)
|
||||
return _queue.Queue(-1)
|
||||
|
||||
|
||||
def _stop_listener() -> None:
|
||||
|
||||
Reference in New Issue
Block a user