Logging: evidence без витоку даних

Module logger, configuration на entry point

import logging

logger = logging.getLogger(__name__)

def main() -> int:
    logging.basicConfig(
        level=logging.INFO,
        format="%(levelname)s %(name)s %(message)s",
    )
    return run()

Library module створює logger і не викликає basicConfig при import. Entry point або application configuration визначає handlers, level і format. Це зберігає import-safety та не дублює events через випадкові handlers.

Level — severity contract

Не логувати expected success як ERROR і не ховати data loss під INFO. Level має дозволяти monitoring rule без знання тексту кожного message.

Lazy formatting відділяє template від values

logger.info(
    "report_written records=%d rejected=%d",
    accepted_count,
    rejected_count,
)

Logging API відкладає interpolation, доки event справді потрібен. Stable event name і key=value fields легше шукати, ніж різні prose sentences. User-controlled strings не треба використовувати як format template.

Exception evidence без подвійного log

try:
    report = load_report(path)
except InputError:
    logger.exception("report_load_failed file=%s", path.name)
    raise

logger.exception додає traceback у active exception handler. Визначте ownership: або layer логить і re-raise, або caller логить; якщо кожний layer друкує той самий failure, один incident перетворюється на кілька misleading events. Public CLI message і internal traceback можуть мати різні audiences.

Redaction — до format, не після витоку

Allowlist fields кращий за спробу regex-ом знайти всі secrets. Логуйте record_id лише коли він synthetic або non-sensitive; замість email — internal correlation ID; замість full path — path.name, якщо цього достатньо. Ніколи не логувати environment dump, Authorization header, cookies, tokens або raw invalid payload.

Logs треба тестувати як contract

unittest.TestCase.assertLogs може підтвердити logger, level і message для expected warning/error. Окремий negative assertion перевіряє, що synthetic secret marker не з’явився. Не прив’язуйте test до timestamp або absolute path, якщо вони не є contract.

with self.assertLogs("app.audit", level="INFO") as captured:
    build_summary(records)

self.assertIn("records=3", captured.output[0])
self.assertNotIn("secret-marker", "\n".join(captured.output))

Практичний pipeline модуля

1. Прочитайте synthetic JSON/CSV з explicit UTF-8 і root boundary.
2. Перекладіть expected parser/I/O failures у InputError.
3. Побудуйте deterministic report без partial overwrite.
4. Додайте INFO summary та safe ERROR evidence.
5. Перевірте normal, missing, malformed, duplicate-header, invalid-type, no-leak і stable-output cases.

Методичні джерела

• Python Logging HOWTO
• Python logging documentation
• Python unittest assertLogs

Урок, сценарії, пояснення й вправи створені SEOWORK. Посилання ведуть лише на офіційну документацію Python.