Coverage for src/copytrading_engine/diagnostics/telemetry/journal.py: 87%
61 statements
« prev ^ index » next coverage.py v7.16.2, created at 2026-11-16 16:55 +0000
« prev ^ index » next coverage.py v7.16.2, created at 2026-11-16 16:55 +0000
1"""The private diagnostics journal: one JSON object per line, kept by age and by size."""
3import logging
4import os
5import re
6import stat
7from collections.abc import Callable
8from datetime import UTC, datetime, timedelta
9from io import TextIOWrapper
10from logging.handlers import RotatingFileHandler
11from pathlib import Path
12from typing import Any
14JOURNAL_NAME = "diagnostics.jsonl"
15_ROTATIONS = 7
16_ROTATION_PATTERN = re.compile(r"diagnostics\.jsonl(\.\d+)?")
19class _PrivateRotatingFileHandler(RotatingFileHandler):
20 def __init__(self, *args: Any, on_error: Callable[[], None], **kwargs: Any) -> None: # noqa: ANN401 - forwards RotatingFileHandler's arguments
21 self._on_error = on_error
22 super().__init__(*args, **kwargs)
24 def handleError(self, record: logging.LogRecord) -> None:
25 self._on_error()
27 def _open(self) -> TextIOWrapper:
28 # A buffered text stream may retry an ENOSPC write during close and
29 # again from its finalizer, leaking a traceback after degradation.
30 raw = open(self.baseFilename, f"{self.mode}b", buffering=0)
31 stream = TextIOWrapper(raw, encoding=self.encoding, errors=self.errors, write_through=True)
32 try:
33 os.chmod(self.baseFilename, 0o600)
34 except OSError:
35 stream.close()
36 raise
37 return stream
40def journal_logger(
41 directory: Path,
42 *,
43 retention_age_days: int,
44 max_bytes: int,
45 on_error: Callable[[], None],
46) -> tuple[logging.Logger | None, OSError | None]:
47 """Open the journal; the newest file plus its rotations never exceed `max_bytes`."""
48 try:
49 directory.mkdir(parents=True, exist_ok=True, mode=0o700)
50 os.chmod(directory, 0o700)
51 prune_journal(directory, retention_age_days=retention_age_days)
52 handler = _PrivateRotatingFileHandler(
53 directory / JOURNAL_NAME,
54 maxBytes=max(1, max_bytes // (_ROTATIONS + 1)),
55 backupCount=_ROTATIONS,
56 encoding="utf-8",
57 on_error=on_error,
58 )
59 os.chmod(directory / JOURNAL_NAME, 0o600)
60 logger = logging.Logger(f"copytrading-diagnostics-{id(handler)}", logging.INFO)
61 logger.propagate = False
62 handler.setFormatter(logging.Formatter("%(message)s"))
63 logger.addHandler(handler)
64 return logger, None
65 except OSError as exc:
66 return None, exc
69def prune_journal(directory: Path, *, retention_age_days: int, now: datetime | None = None) -> int:
70 """Remove journal files last written before the retained window, by whole UTC day."""
71 if not 1 <= retention_age_days <= 3_650: 71 ↛ 72line 71 didn't jump to line 72 because the condition on line 71 was never true
72 raise ValueError("diagnostics retention age is outside the supported bounds")
73 current = (now or datetime.now(UTC)).astimezone(UTC).date()
74 oldest_retained_day = current - timedelta(days=retention_age_days)
75 deleted_bytes = 0
76 for path in directory.iterdir():
77 if not _ROTATION_PATTERN.fullmatch(path.name):
78 continue
79 try:
80 info = os.lstat(path)
81 except FileNotFoundError:
82 continue
83 if not stat.S_ISREG(info.st_mode): 83 ↛ 84line 83 didn't jump to line 84 because the condition on line 83 was never true
84 continue
85 if datetime.fromtimestamp(info.st_mtime, UTC).date() < oldest_retained_day:
86 path.unlink()
87 deleted_bytes += info.st_size
88 return deleted_bytes