omnixys-observability 2.0.4__tar.gz

omnixys_observability-2.0.4/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

omnixys_observability-2.0.4/.github/workflows/ci.yaml

@@ -0,0 +1,101 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  PYTHON_VERSION: "3.14"
+  PACKAGE:  ${{ vars.PACKAGE }}
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Lint (ruff)
+        run: uv run ruff check src/
+
+      - name: Typecheck (mypy)
+        run: uv run mypy src/ || true
+
+      - name: Test (pytest)
+        run: uv run pytest
+
+  release:
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+    outputs:
+      released: ${{ steps.semantic.outputs.released }}
+      version: ${{ steps.semantic.outputs.version }}
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+
+      - name: Install semantic-release
+        run: |
+          npm install -g semantic-release
+          npm install -g @semantic-release/changelog
+          npm install -g @semantic-release/exec
+          npm install -g @semantic-release/git
+          npm install -g @semantic-release/github
+          npm install -g conventional-changelog-conventionalcommits
+
+      - name: Semantic Release
+        id: semantic
+        run: |
+          OUTPUT=$(npx semantic-release --no-ci 2>&1 || true)
+          echo "$OUTPUT"
+
+          if echo "$OUTPUT" | grep -q "Published"; then
+            echo "released=true" >> $GITHUB_OUTPUT
+          else
+            echo "released=false" >> $GITHUB_OUTPUT
+          fi
+
+          VERSION=$(grep -oP '__version__\s*=\s*"\K[^"]+' src/${PACKAGE}/__init__.py)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: release
+    if: needs.release.outputs.released == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish dist/*
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

omnixys_observability-2.0.4/.gitignore

@@ -0,0 +1,2 @@
+__pycache__/
+*.pyc

omnixys_observability-2.0.4/CHANGELOG.md

@@ -0,0 +1,42 @@
+## [2.0.4](https://github.com/omnixys/observability-python/compare/v2.0.3...v2.0.4) (2026-07-22)
+
+
+### Bug Fixes
+
+* **publish:** add uv build before uv publish ([d5aa1fa](https://github.com/omnixys/observability-python/commit/d5aa1fa58a97432ebd70926451eb74a6916333ee))
+
+## [2.0.3](https://github.com/omnixys/observability-python/compare/v2.0.2...v2.0.3) (2026-07-22)
+
+
+### Bug Fixes
+
+* **publish:** replace gh release upload with uv publish to PyPI ([420ef67](https://github.com/omnixys/observability-python/commit/420ef6724596d9fb311e7af3c1a0d17d7b151d2a))
+
+## [2.0.2](https://github.com/omnixys/observability-python/compare/v2.0.1...v2.0.2) (2026-07-22)
+
+
+### Bug Fixes
+
+* **release:** add @semantic-release/exec to update __version__ in __init__.py ([969ed6f](https://github.com/omnixys/observability-python/commit/969ed6f6b6725cd611b6f73aad36242d24c6b97c))
+
+## [2.0.1](https://github.com/omnixys/observability-python/compare/v2.0.0...v2.0.1) (2026-07-22)
+
+
+### Bug Fixes
+
+* **cicd:** use version comparison for release detection ([eab84dd](https://github.com/omnixys/observability-python/commit/eab84ddbc0ff4a8563537204fdcba19058b8b7af))
+
+# [2.0.0](https://github.com/omnixys/observability-python/compare/v1.1.1...v2.0.0) (2026-07-22)
+
+# Changelog
+
+All notable changes in this project will be documented in this file.
+
+
+## [1.1.1](https://github.com/omnixys/observability-python/compare/v1.1.0...v1.1.1) (2026-07-22)
+
+## [1.0.2](https://github.com/omnixys/observability-python/compare/v1.0.1...v1.0.2) (2026-07-22)
+
+## [1.0.1](https://github.com/omnixys/observability-python/compare/v1.0.0...v1.0.1) (2026-07-15)
+
+## 1.0.0 (2026-07-15)

omnixys_observability-2.0.4/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: omnixys-observability
+Version: 2.0.4
+Summary: Omnixys shared observability package (OTel tracing, structured logging, Prometheus metrics)
+Project-URL: Homepage, https://github.com/omnixys/omnixys
+Project-URL: Repository, https://github.com/omnixys/omnixys
+Author-email: Omnixys Team <team@omnixys.com>
+License: GPL-3.0-or-later
+Keywords: logging,metrics,observability,omnixys,opentelemetry,tracing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: opentelemetry-api>=1.42.1
+Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.42.1
+Requires-Dist: opentelemetry-instrumentation-asgi>=0.63b1
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.63b1
+Requires-Dist: opentelemetry-instrumentation-httpx>=0.63b1
+Requires-Dist: opentelemetry-instrumentation-logging>=0.63b1
+Requires-Dist: opentelemetry-instrumentation-sqlalchemy>=0.63b1
+Requires-Dist: opentelemetry-instrumentation>=0.63b1
+Requires-Dist: opentelemetry-sdk>=1.42.1
+Requires-Dist: prometheus-client>=0.25.0
+Requires-Dist: structlog>=26.1.0
+Description-Content-Type: text/markdown
+
+# omnixys-observability
+
+Omnixys shared observability package with OpenTelemetry tracing, structured logging, and Prometheus metrics.
+
+## Installation
+
+```bash
+pip install omnixys-observability
+```
+
+## Features
+
+- OpenTelemetry distributed tracing
+- Structured logging with structlog
+- Prometheus metrics collection
+- FastAPI instrumentation
+- Request context propagation
+
+## Usage
+
+```python
+from observability import configure_logging, configure_tracing, instrument_fastapi
+```
+
+## License
+
+GPL-3.0-or-later

omnixys_observability-2.0.4/README.md

@@ -0,0 +1,27 @@
+# omnixys-observability
+
+Omnixys shared observability package with OpenTelemetry tracing, structured logging, and Prometheus metrics.
+
+## Installation
+
+```bash
+pip install omnixys-observability
+```
+
+## Features
+
+- OpenTelemetry distributed tracing
+- Structured logging with structlog
+- Prometheus metrics collection
+- FastAPI instrumentation
+- Request context propagation
+
+## Usage
+
+```python
+from observability import configure_logging, configure_tracing, instrument_fastapi
+```
+
+## License
+
+GPL-3.0-or-later

omnixys_observability-2.0.4/pyproject.toml

@@ -0,0 +1,76 @@
+[project]
+name = "omnixys-observability"
+dynamic = ["version"]
+description = "Omnixys shared observability package (OTel tracing, structured logging, Prometheus metrics)"
+readme = "README.md"
+license = { text = "GPL-3.0-or-later" }
+requires-python = ">=3.14"
+authors = [{ name = "Omnixys Team", email = "team@omnixys.com" }]
+keywords = ["omnixys", "observability", "opentelemetry", "tracing", "metrics", "logging"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+    "Programming Language :: Python :: 3.14",
+    "Typing :: Typed",
+]
+dependencies = [
+    "fastapi>=0.115.0",
+    "httpx>=0.28.0",
+    "structlog>=26.1.0",
+    "prometheus-client>=0.25.0",
+    "opentelemetry-api>=1.42.1",
+    "opentelemetry-sdk>=1.42.1",
+    "opentelemetry-exporter-otlp-proto-http>=1.42.1",
+    "opentelemetry-instrumentation>=0.63b1",
+    "opentelemetry-instrumentation-fastapi>=0.63b1",
+    "opentelemetry-instrumentation-sqlalchemy>=0.63b1",
+    "opentelemetry-instrumentation-logging>=0.63b1",
+    "opentelemetry-instrumentation-httpx>=0.63b1",
+    "opentelemetry-instrumentation-asgi>=0.63b1",
+]
+
+[project.urls]
+Homepage = "https://github.com/omnixys/omnixys"
+Repository = "https://github.com/omnixys/omnixys"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/observability/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/observability"]
+
+[dependency-groups]
+dev = [
+    "mypy>=2.3.0",
+    "ruff>=0.15.21",
+    "pytest>=9.1.0",
+    "pytest-asyncio>=0.26.0",
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py314"
+
+[tool.ruff.lint]
+select = ["ALL"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    "ANN101", "ANN401", "S101",
+    "T20", "FBT", "D", "INP001",
+]
+"src/**" = [
+    "S104", "D", "ANN401", "ARG002",
+]
+
+[tool.mypy]
+strict = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

omnixys_observability-2.0.4/release.config.js

@@ -0,0 +1,56 @@
+/**
+ * @license GPL-3.0-or-later
+ * Copyright (C) 2025 Caleb Gyamfi
+ * Omnixys Technologies
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License for more details.
+ *
+ * For more information, visit <https://www.gnu.org/licenses/>.
+ */
+
+export default {
+  branches: ['main'],
+  tagFormat: 'v${version}',
+  plugins: [
+    ['@semantic-release/commit-analyzer', {
+      preset: 'conventionalcommits',
+      releaseRules: [
+        { type: 'breaking', release: 'major' },
+        { type: 'feat', release: 'minor' },
+        { type: 'fix', release: 'patch' },
+        { type: 'perf', release: 'patch' },
+        { type: 'refactor', release: 'patch' },
+        { type: 'revert', release: 'patch' },
+        { type: 'docs', release: false },
+        { type: 'style', release: false },
+        { type: 'test', release: false },
+        { type: 'chore', release: false },
+        { type: 'ci', release: false },
+        { type: 'build', release: false },
+      ],
+    }],
+    '@semantic-release/release-notes-generator',
+    ['@semantic-release/changelog', { changelogFile: 'CHANGELOG.md' }],
+    ['@semantic-release/exec', {
+      prepareCmd: 'sed -i "s/__version__ = \\".*\\"/__version__ = \\"${nextRelease.version}\\"/" src/observability/__init__.py',
+    }],
+    ['@semantic-release/git', {
+      assets: ['pyproject.toml', 'CHANGELOG.md', 'src/observability/__init__.py'],
+      message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
+    }],
+    ['@semantic-release/github', {
+      assets: [
+        { path: 'CHANGELOG.md', label: 'Changelog' },
+        { path: 'dist/**', label: 'Build Artifacts' },
+      ],
+    }],
+  ],
+};

omnixys_observability-2.0.4/src/observability/__init__.py

@@ -0,0 +1,61 @@
+from observability.logging import configure_logging, get_logger, shutdown_logging
+from observability.metrics import (
+    ObservabilityMetrics,
+    ObservabilityMiddleware,
+    auth_failures,
+    cache_hits,
+    cache_misses,
+    db_query_duration,
+    graphql_operations,
+    http_request_duration,
+    http_requests_total,
+    kafka_publish_failures,
+    kafka_publish_total,
+    outbox_failed,
+    outbox_pending,
+    outbox_processed,
+    outbox_processing_duration,
+    rate_limit_blocked,
+)
+from observability.request_context import (
+    RequestContext,
+    current_request_context,
+    reset_request_context,
+    set_request_context,
+)
+from observability.runtime import configure_observability, shutdown_observability
+from observability.tracing import configure_tracing, instrument_fastapi, shutdown_tracing, uninstrument_fastapi
+
+__version__ = "2.0.4"
+
+__all__ = [
+    "ObservabilityMetrics",
+    "ObservabilityMiddleware",
+    "RequestContext",
+    "auth_failures",
+    "cache_hits",
+    "cache_misses",
+    "configure_logging",
+    "configure_observability",
+    "configure_tracing",
+    "current_request_context",
+    "db_query_duration",
+    "get_logger",
+    "graphql_operations",
+    "http_request_duration",
+    "http_requests_total",
+    "instrument_fastapi",
+    "kafka_publish_failures",
+    "kafka_publish_total",
+    "outbox_failed",
+    "outbox_pending",
+    "outbox_processed",
+    "outbox_processing_duration",
+    "rate_limit_blocked",
+    "reset_request_context",
+    "set_request_context",
+    "shutdown_logging",
+    "shutdown_observability",
+    "shutdown_tracing",
+    "uninstrument_fastapi",
+]

omnixys_observability-2.0.4/src/observability/logging.py

@@ -0,0 +1,150 @@
+from __future__ import annotations
+
+import logging
+import os
+import re
+from typing import TYPE_CHECKING, Any
+
+import structlog
+from opentelemetry import trace
+from opentelemetry._logs import set_logger_provider
+from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
+from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
+from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
+from opentelemetry.sdk.resources import Resource
+
+from observability.request_context import current_request_context
+
+if TYPE_CHECKING:
+    from collections.abc import MutableMapping
+
+_SENSITIVE_KEY = re.compile(r"authorization|cookie|password|secret|token|api[-_]?key", re.IGNORECASE)
+
+
+def _add_context(_logger: Any, _method_name: str, event_dict: MutableMapping[str, Any]) -> MutableMapping[str, Any]:  # noqa: C901
+    if _service_name:
+        event_dict["service"] = _service_name
+    ctx = current_request_context()
+    if ctx:
+        if ctx.request_id:
+            event_dict["request_id"] = ctx.request_id
+        if ctx.correlation_id:
+            event_dict["correlation_id"] = ctx.correlation_id
+        if ctx.user_id:
+            event_dict["user_id"] = ctx.user_id
+            event_dict["actor_id"] = ctx.user_id
+        if ctx.organization_id:
+            event_dict["organization_id"] = ctx.organization_id
+        if ctx.tenant_id:
+            event_dict["tenant_id"] = ctx.tenant_id
+
+    span = trace.get_current_span()
+    span_context = span.get_span_context()
+    if span_context.is_valid:
+        event_dict["traceId"] = format(span_context.trace_id, "032x")
+        event_dict["spanId"] = format(span_context.span_id, "016x")
+    elif ctx:
+        if ctx.trace_id:
+            event_dict["traceId"] = ctx.trace_id
+        if ctx.span_id:
+            event_dict["spanId"] = ctx.span_id
+
+    return event_dict
+
+
+def _redact_sensitive(
+    _logger: Any, _method_name: str, event_dict: MutableMapping[str, Any],
+) -> MutableMapping[str, Any]:
+    return _redact_mapping(event_dict)
+
+
+def _redact_mapping(value: MutableMapping[str, Any]) -> MutableMapping[str, Any]:
+    for key, nested in tuple(value.items()):
+        if _SENSITIVE_KEY.search(key):
+            value[key] = "[REDACTED]"
+        elif isinstance(nested, dict):
+            value[key] = _redact_mapping(nested)
+        elif isinstance(nested, list):
+            value[key] = [
+                _redact_mapping(item) if isinstance(item, dict) else item for item in nested
+            ]
+    return value
+
+
+_logger_provider: LoggerProvider | None = None
+_service_name: str | None = None
+
+
+def _signal_endpoint(endpoint: str, signal: str) -> str:
+    base = endpoint.rstrip("/")
+    for suffix in ("/v1/traces", "/v1/logs"):
+        if base.endswith(suffix):
+            base = base[: -len(suffix)]
+            break
+    return f"{base}/v1/{signal}"
+
+
+def _setup_otel_logging(service_name: str, endpoint: str, environment: str) -> LoggerProvider:
+    global _logger_provider, _service_name  # noqa: PLW0603
+    resource = Resource.create(
+        {
+            "service.name": service_name,
+            "service.namespace": "omnixys",
+            "service.version": os.environ.get("OTEL_SERVICE_VERSION", "unknown"),
+            "deployment.environment.name": environment,
+        },
+    )
+
+    logger_provider = LoggerProvider(resource=resource)
+    logger_provider.add_log_record_processor(
+        BatchLogRecordProcessor(OTLPLogExporter(endpoint=_signal_endpoint(endpoint, "logs"))),
+    )
+    set_logger_provider(logger_provider)
+
+    handler = LoggingHandler(logger_provider=logger_provider)
+    handler.setLevel(logging.DEBUG)
+    logging.getLogger().addHandler(handler)
+    _logger_provider = logger_provider
+    _service_name = service_name
+    return logger_provider
+
+
+def configure_logging(
+    log_level: str = "INFO",
+    service_name: str | None = None,
+    *,
+    otlp_endpoint: str | None = None,
+    environment: str = "local",
+) -> None:
+    if service_name:
+        endpoint = otlp_endpoint or os.environ.get("OTEL_EXPORTER_OTLP_ENDPOINT", "http://localhost:4318")
+        _setup_otel_logging(service_name, endpoint, environment)
+
+    structlog.configure(
+        processors=[
+            structlog.contextvars.merge_contextvars,
+            structlog.stdlib.add_log_level,
+            _add_context,
+            _redact_sensitive,
+            structlog.processors.TimeStamper(fmt="iso", utc=True),
+            structlog.processors.JSONRenderer(),
+        ],
+        wrapper_class=structlog.stdlib.BoundLogger,
+        logger_factory=structlog.stdlib.LoggerFactory(),
+        cache_logger_on_first_use=True,
+    )
+    logging.basicConfig(
+        level=getattr(logging, log_level.upper(), logging.INFO),
+        format="%(message)s",
+    )
+
+
+def get_logger(name: str | None = None) -> Any:
+    return structlog.get_logger(name)
+
+
+def shutdown_logging() -> None:
+    global _logger_provider  # noqa: PLW0603
+    if _logger_provider is not None:
+        _logger_provider.shutdown()
+        _logger_provider = None