sysnet-audit 0.2.0

Sdilena knihovna pro auditni logovani v SYSNET mikrosluzbach

sysnet-audit

Sdílená Python knihovna pro auditní logování napříč FastAPI mikroslužbami SYSNET s.r.o.

Distribuční název: sysnet-audit
Import path: audit_lib
Repozitář: github.com/SYSNET-CZ/audit

---

Instalace

# Základní (bez Kafka)
pip install git+ssh://[e-mail]/SYSNET-CZ/audit.git@v0.2.0

# S Kafka backbendem (Topologie B)
pip install "git+ssh://[e-mail]/SYSNET-CZ/audit.git@v0.2.0#egg=sysnet-audit[kafka]"

V pyproject.toml konzumující mikroslužby:

[project]
dependencies = [
    "sysnet-audit @ git+ssh://[e-mail]/SYSNET-CZ/audit.git@v0.2.0",
]

---

Quick start

from contextlib import asynccontextmanager
from fastapi import FastAPI, Depends
from audit_lib import (
    init_audit, get_audit_backend, get_audit_logger,
    AuditLogger, AuditActor, AuditResource, AuditSettings,
)

@asynccontextmanager
async def lifespan(app: FastAPI):
    client = await init_audit(AuditSettings())
    yield
    await get_audit_backend().aclose()
    if client is not None:
        await client.aclose()

app = FastAPI(lifespan=lifespan)

@app.delete("/users/{user_id}")
async def delete_user(
    user_id: str,
    audit: AuditLogger = Depends(get_audit_logger),
):
    await audit.log(
        actor=AuditActor(sub="user-uuid"),
        action="user.delete",
        resource=AuditResource(type="user", id=user_id),
    )

---

Proměnné prostředí

Proměnná	Výchozí	Popis
AUDIT_SERVICE_NAME	— (povinné)	Identifikace mikroslužby
AUDIT_MONGO_URI	mongodb://localhost:27017	Connection string auditní MongoDB
AUDIT_MONGO_DB	audit	Název auditní databáze
AUDIT_ENABLED	true	false = NullBackend, žádné I/O
AUDIT_KAFKA_BOOTSTRAP_SERVERS	— (nepovinné)	Aktivuje dual-write Topologii B
AUDIT_KAFKA_TOPIC	audit-events	Název Kafka topicu

---

Dokumentace

Dokument	Určení	Obsah
Manažerský přehled	Management	Proč knihovna vznikla, byznys hodnota, architektonická rozhodnutí
Uživatelská dokumentace	Vývojáři mikroslužeb	Instalace, konfigurace, FastAPI integrace, datové modely, testování
Technická dokumentace	Přispěvatelé, architekti	Architektura, závislostní graf, exception kontrakt, Topologie B, testy
Auditní databáze	DevOps, architekti	Proč samostatná DB, RBAC, doporučené indexy, TTL
Roadmap	Všichni	Stav verzí, plánované funkce
Quick Reference	Vývojáři	Vzory konfigurace, lifespan, záznam události, vlastní backend
sysnet-audit-dokumentace.docx	Všichni	Kompletní dokumentace v jednom souboru (Word)

---

Vývoj

git clone [e-mail]:SYSNET-CZ/audit.git
cd audit
pip install -e ".[dev,kafka]"
pytest

Licence

Proprietary — SYSNET s.r.o.