ume-logging 0.0.11

Uniform JSON logging for University Medicine Essen (UME)

UME Logging (logging-ume)

Uniform JSON logging for University Medicine Essen applications.

---

Features

• JSON log output (Docker/K8s/ELK friendly)
• App/env/service/request context injection
• PII scrubbing (emails, numeric IDs, phone numbers)
• OpenTelemetry trace/span IDs in logs
• Optional log→OTel span event bridge
• FastAPI middleware for request/response logging
• Compatible with Python 3.9+

---

📦 Installation

pip install logging-ume
# Optional extras:
pip install "logging-ume[fastapi]"   # FastAPI request logging middleware
pip install "logging-ume[otel]"      # OpenTelemetry tracing + span events

---

🚀 Quickstart

import logging
from umelogging import log_configure

log_configure("INFO", app="dicom2fhir", env="prod", service="mapping")
log = logging.getLogger(__name__)

log.info("Starting dicom-to-fhir mapping job.")

Example Output (JSON):

{
  "time": "2025-08-12T12:01:23.456Z",
  "level": "INFO",
  "logger": "myapp",
  "message": "Starting dicom-to-fhir mapping job.",
  "org": "UME",
  "app": "dicom2fhir",
  "env": "prod",
  "service": "mapping"
}

---

⚙️ Environment Variables

Variable	Description	Default
UME_LOG_LEVEL	Logging level	INFO
UME_APP	App name
UME_ENV	Environment (prod, dev, test)	prod
UME_SERVICE	Service name
UME_COMPONENT	Component/module name
UME_USER_HASH_SALT	Salt for user ID hashing	ume
UME_OTEL_SPAN_EVENTS	Mirror logs as OTel span events	false

---

🌐 FastAPI Integration (optional)

Add request/response logging to your FastAPI app:

from fastapi import FastAPI
from umelogging.fastapi.middleware import UMELoggingMiddleware

app = FastAPI()
app.add_middleware(UMELoggingMiddleware)

This will log incoming requests and responses in JSON, including request ID, latency, status, and correlation information.

---

📈 OpenTelemetry Integration (optional)

Enable OpenTelemetry tracing and span events in your logs:

from umelogging import log_configure

log_configure(
    "INFO",
    app="myapp",
    env="prod",
    otel_enable=True,  # Enable OpenTelemetry
    otel_exporter="otlp",  # or "console"
)

Configure via environment variables:

Variable	Description	Example
UMELOG_OTEL_ENABLE	Enable OTel tracing/log bridge	true
UMELOG_OTEL_EXPORTER	OTel exporter ("otlp", "console")	otlp
OTEL_EXPORTER_OTLP_ENDPOINT	OTel collector endpoint	http://otel:4317

See OpenTelemetry Docs for advanced setup.

---

📄 License

MIT License.
Copyright © University Medicine Essen ZIT / IKIM.