tracely-sdk 0.1.0__tar.gz

tracely_sdk-0.1.0/.github/release.yml

@@ -0,0 +1,34 @@
+changelog:
+  exclude:
+    labels:
+      - skip-changelog
+      - dependencies
+    authors:
+      - dependabot
+      - github-actions
+
+  categories:
+    - title: "New Features"
+      labels:
+        - feature
+        - enhancement
+    - title: "Bug Fixes"
+      labels:
+        - bug
+        - fix
+    - title: "Instrumentation"
+      labels:
+        - instrumentation
+        - fastapi
+        - flask
+        - django
+    - title: "Performance"
+      labels:
+        - performance
+    - title: "Documentation"
+      labels:
+        - documentation
+        - docs
+    - title: "Other Changes"
+      labels:
+        - "*"

tracely_sdk-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests
+        run: python -m pytest tests/ -v --tb=short

tracely_sdk-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,95 @@
+name: Release to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  test:
+    name: Run tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests
+        run: python -m pytest tests/ -v --tb=short
+
+  build:
+    name: Build package
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: python -m pip install --upgrade pip build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  attach-assets:
+    name: Attach build artifacts to release
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Upload assets to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/tracely-sdk
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

tracely_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2026 Charles Dzadu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tracely_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: tracely-sdk
+Version: 0.1.0
+Summary: Lightweight observability SDK for Python web frameworks. Auto-instruments FastAPI, Flask, and Django with real-time tracing via OTLP/HTTP.
+Project-URL: Homepage, https://tracely.sh
+Project-URL: Documentation, https://docs.tracely.sh
+Project-URL: Repository, https://github.com/TracelyOrg/tracely-sdk
+Project-URL: Issues, https://github.com/TracelyOrg/tracely-sdk/issues
+Author-email: Charles Dzadu <contact@tracely.sh>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: apm,django,fastapi,flask,monitoring,observability,opentelemetry,tracing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Monitoring
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: opentelemetry-proto>=1.20
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# tracely-sdk
+
+Lightweight observability SDK for Python web frameworks. Auto-instruments **FastAPI**, **Flask**, and **Django** with real-time distributed tracing via OTLP/HTTP.
+
+[![PyPI version](https://img.shields.io/pypi/v/tracely-sdk.svg)](https://pypi.org/project/tracely-sdk/)
+[![Python](https://img.shields.io/pypi/pyversions/tracely-sdk.svg)](https://pypi.org/project/tracely-sdk/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- **Zero-config auto-instrumentation** -- detects FastAPI, Flask, and Django automatically
+- **Real-time pending spans** -- see requests the moment they start, not just when they finish
+- **Full request/response capture** -- headers, body, query params with smart redaction
+- **OTLP/HTTP protobuf export** -- standard OpenTelemetry wire format
+- **Batch export with backoff** -- 1s flush interval, exponential retry on failure
+- **Fail-silent design** -- SDK never crashes or degrades your application
+- **Minimal dependencies** -- only `httpx` and `opentelemetry-proto`
+
+## Installation
+
+```bash
+pip install tracely-sdk
+```
+
+## Quick Start
+
+### FastAPI
+
+```python
+import tracely
+from tracely.instrumentation.fastapi_inst import TracelyASGIMiddleware
+
+tracely.init(api_key="trly_your_key_here")
+
+from fastapi import FastAPI
+app = FastAPI()
+app.add_middleware(TracelyASGIMiddleware)
+
+@app.get("/")
+async def root():
+    return {"status": "ok"}
+```
+
+### Flask
+
+```python
+import tracely
+from tracely.instrumentation.flask_inst import FlaskInstrumentor
+
+tracely.init(api_key="trly_your_key_here")
+
+from flask import Flask
+app = Flask(__name__)
+app.wsgi_app = FlaskInstrumentor.wrap_app(app.wsgi_app)
+
+@app.route("/")
+def root():
+    return {"status": "ok"}
+```
+
+### Django
+
+Add the middleware to your `MIDDLEWARE` setting:
+
+```python
+# settings.py
+MIDDLEWARE = [
+    "tracely.instrumentation.django_inst.TracelyDjangoMiddleware",
+    # ... other middleware
+]
+```
+
+Then initialize in your app startup (e.g., `AppConfig.ready()`):
+
+```python
+import tracely
+tracely.init(api_key="trly_your_key_here")
+```
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `TRACELY_API_KEY` | API key for authentication | _(required)_ |
+| `TRACELY_ENDPOINT` | Ingestion API endpoint | `https://i.tracely.sh` |
+| `ENVIRONMENT` | Deployment environment (e.g., `production`) | `None` |
+| `TRACELY_REDACT_FIELDS` | Comma-separated header/field names to redact | `None` |
+
+### Programmatic Init
+
+```python
+import tracely
+
+tracely.init(
+    api_key="trly_your_key_here",
+    environment="production",
+    service_name="my-api",
+    service_version="1.0.0",
+)
+```
+
+## Custom Spans
+
+Create manual spans for custom operations:
+
+```python
+import tracely
+
+with tracely.span("db-query", kind="CLIENT") as s:
+    s.set_attribute("db.system", "postgres")
+    s.set_attribute("db.statement", "SELECT * FROM users")
+    result = db.execute("SELECT * FROM users")
+```
+
+## Span Events (Structured Logging)
+
+Attach structured log events to the active span:
+
+```python
+import tracely
+
+with tracely.span("process-order") as s:
+    tracely.info("Order received", order_id="123")
+    # ... process
+    tracely.debug("Validation passed")
+    tracely.warning("Inventory low", sku="WIDGET-42")
+```
+
+## Graceful Shutdown
+
+Flush buffered spans before exit:
+
+```python
+import tracely
+
+tracely.init(api_key="trly_your_key_here")
+# ... application runs ...
+tracely.shutdown()  # flushes remaining spans
+```
+
+## How It Works
+
+```
+Your App
+  |
+  v
+Middleware (FastAPI/Flask/Django)
+  |-- on_start --> SpanProcessor --> SpanBuffer (pending_span)
+  |-- on_end ----> SpanProcessor --> SpanBuffer (final span)
+                                        |
+                                        v
+                                  BatchSpanExporter (1s interval / 50 span threshold)
+                                        |
+                                        v
+                                  OTLP Protobuf Serialization
+                                        |
+                                        v
+                                  HttpTransport --> TRACELY API
+                                  (retry with exponential backoff)
+```
+
+## Documentation
+
+Full docs at [docs.tracely.sh](https://docs.tracely.sh)
+
+## License
+
+MIT

tracely_sdk-0.1.0/README.md

@@ -0,0 +1,170 @@
+# tracely-sdk
+
+Lightweight observability SDK for Python web frameworks. Auto-instruments **FastAPI**, **Flask**, and **Django** with real-time distributed tracing via OTLP/HTTP.
+
+[![PyPI version](https://img.shields.io/pypi/v/tracely-sdk.svg)](https://pypi.org/project/tracely-sdk/)
+[![Python](https://img.shields.io/pypi/pyversions/tracely-sdk.svg)](https://pypi.org/project/tracely-sdk/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- **Zero-config auto-instrumentation** -- detects FastAPI, Flask, and Django automatically
+- **Real-time pending spans** -- see requests the moment they start, not just when they finish
+- **Full request/response capture** -- headers, body, query params with smart redaction
+- **OTLP/HTTP protobuf export** -- standard OpenTelemetry wire format
+- **Batch export with backoff** -- 1s flush interval, exponential retry on failure
+- **Fail-silent design** -- SDK never crashes or degrades your application
+- **Minimal dependencies** -- only `httpx` and `opentelemetry-proto`
+
+## Installation
+
+```bash
+pip install tracely-sdk
+```
+
+## Quick Start
+
+### FastAPI
+
+```python
+import tracely
+from tracely.instrumentation.fastapi_inst import TracelyASGIMiddleware
+
+tracely.init(api_key="trly_your_key_here")
+
+from fastapi import FastAPI
+app = FastAPI()
+app.add_middleware(TracelyASGIMiddleware)
+
+@app.get("/")
+async def root():
+    return {"status": "ok"}
+```
+
+### Flask
+
+```python
+import tracely
+from tracely.instrumentation.flask_inst import FlaskInstrumentor
+
+tracely.init(api_key="trly_your_key_here")
+
+from flask import Flask
+app = Flask(__name__)
+app.wsgi_app = FlaskInstrumentor.wrap_app(app.wsgi_app)
+
+@app.route("/")
+def root():
+    return {"status": "ok"}
+```
+
+### Django
+
+Add the middleware to your `MIDDLEWARE` setting:
+
+```python
+# settings.py
+MIDDLEWARE = [
+    "tracely.instrumentation.django_inst.TracelyDjangoMiddleware",
+    # ... other middleware
+]
+```
+
+Then initialize in your app startup (e.g., `AppConfig.ready()`):
+
+```python
+import tracely
+tracely.init(api_key="trly_your_key_here")
+```
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `TRACELY_API_KEY` | API key for authentication | _(required)_ |
+| `TRACELY_ENDPOINT` | Ingestion API endpoint | `https://i.tracely.sh` |
+| `ENVIRONMENT` | Deployment environment (e.g., `production`) | `None` |
+| `TRACELY_REDACT_FIELDS` | Comma-separated header/field names to redact | `None` |
+
+### Programmatic Init
+
+```python
+import tracely
+
+tracely.init(
+    api_key="trly_your_key_here",
+    environment="production",
+    service_name="my-api",
+    service_version="1.0.0",
+)
+```
+
+## Custom Spans
+
+Create manual spans for custom operations:
+
+```python
+import tracely
+
+with tracely.span("db-query", kind="CLIENT") as s:
+    s.set_attribute("db.system", "postgres")
+    s.set_attribute("db.statement", "SELECT * FROM users")
+    result = db.execute("SELECT * FROM users")
+```
+
+## Span Events (Structured Logging)
+
+Attach structured log events to the active span:
+
+```python
+import tracely
+
+with tracely.span("process-order") as s:
+    tracely.info("Order received", order_id="123")
+    # ... process
+    tracely.debug("Validation passed")
+    tracely.warning("Inventory low", sku="WIDGET-42")
+```
+
+## Graceful Shutdown
+
+Flush buffered spans before exit:
+
+```python
+import tracely
+
+tracely.init(api_key="trly_your_key_here")
+# ... application runs ...
+tracely.shutdown()  # flushes remaining spans
+```
+
+## How It Works
+
+```
+Your App
+  |
+  v
+Middleware (FastAPI/Flask/Django)
+  |-- on_start --> SpanProcessor --> SpanBuffer (pending_span)
+  |-- on_end ----> SpanProcessor --> SpanBuffer (final span)
+                                        |
+                                        v
+                                  BatchSpanExporter (1s interval / 50 span threshold)
+                                        |
+                                        v
+                                  OTLP Protobuf Serialization
+                                        |
+                                        v
+                                  HttpTransport --> TRACELY API
+                                  (retry with exponential backoff)
+```
+
+## Documentation
+
+Full docs at [docs.tracely.sh](https://docs.tracely.sh)
+
+## License
+
+MIT

tracely_sdk-0.1.0/RELEASE_NOTES.md

@@ -0,0 +1,55 @@
+# v0.1.0
+
+First public release of the TRACELY SDK -- lightweight observability for Python web frameworks.
+
+## Highlights
+
+Zero-config auto-instrumentation for **FastAPI**, **Flask**, and **Django** with real-time distributed tracing. The SDK captures full request/response data, exports via OTLP/HTTP protobuf, and never crashes your application.
+
+## Features
+
+### Core SDK
+- **Zero-config initialization** -- `tracely.init(api_key="...")` reads from env vars or explicit params by @charlesdzadu
+- **Framework auto-detection** -- automatically detects FastAPI, Flask, and Django at import time by @charlesdzadu
+- **Graceful shutdown** -- `tracely.shutdown()` flushes all buffered spans before exit by @charlesdzadu
+
+### Auto-Instrumentation
+- **FastAPI ASGI middleware** -- `TracelyASGIMiddleware` wraps async apps with full request/response capture by @charlesdzadu
+- **Flask WSGI middleware** -- `TracelyWSGIMiddleware` wraps sync WSGI apps with request/response capture by @charlesdzadu
+- **Django middleware** -- `TracelyDjangoMiddleware` follows Django middleware protocol by @charlesdzadu
+- **HTTPX client instrumentation** -- traces outbound HTTP calls as child spans by @charlesdzadu
+- **Database API instrumentation** -- traces DB queries via Python DB-API 2.0 by @charlesdzadu
+
+### Tracing & Spans
+- **Span creation with trace hierarchy** -- root and child spans with automatic parent propagation by @charlesdzadu
+- **Custom spans API** -- `tracely.span("name")` context manager for manual instrumentation by @charlesdzadu
+- **Pending span pattern** -- spans exported immediately on start (`pending_span`) for real-time dashboard visibility by @charlesdzadu
+- **Span events / structured logging** -- `tracely.info()`, `tracely.debug()`, `tracely.warning()`, `tracely.error()` by @charlesdzadu
+
+### Data Capture & Privacy
+- **Full request/response data capture** -- headers, body, query params, status codes by @charlesdzadu
+- **Smart data redaction** -- auto-redacts Authorization, Cookie, passwords, tokens, API keys by @charlesdzadu
+- **Custom redaction fields** -- `TRACELY_REDACT_FIELDS` env var for additional sensitive fields by @charlesdzadu
+- **Binary body detection** -- replaces binary content with `[binary]` placeholder by @charlesdzadu
+
+### Transport & Export
+- **OTLP/HTTP protobuf export** -- standard OpenTelemetry wire format via `opentelemetry-proto` by @charlesdzadu
+- **Batch span exporter** -- background daemon thread with 1s flush interval or 50-span threshold by @charlesdzadu
+- **Exponential backoff retry** -- 1s, 2s, 4s, max 30s on transport failure by @charlesdzadu
+- **Buffer limit** -- 1000 span cap, drops oldest when full by @charlesdzadu
+- **Fail-silent design** -- all SDK operations catch errors silently, host app never affected by @charlesdzadu
+
+## Dependencies
+
+- `httpx>=0.27`
+- `opentelemetry-proto>=1.20`
+- Python 3.10+
+
+## Contributors
+
+@charlesdzadu
+
+## Assets
+
+- `tracely_sdk-0.1.0-py3-none-any.whl`
+- `tracely_sdk-0.1.0.tar.gz`

tracely_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "tracely-sdk"
+version = "0.1.0"
+description = "Lightweight observability SDK for Python web frameworks. Auto-instruments FastAPI, Flask, and Django with real-time tracing via OTLP/HTTP."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    {name = "Charles Dzadu", email = "contact@tracely.sh"},
+]
+keywords = ["observability", "tracing", "opentelemetry", "fastapi", "flask", "django", "monitoring", "apm"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: System :: Monitoring",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Framework :: FastAPI",
+    "Framework :: Flask",
+    "Framework :: Django",
+    "Typing :: Typed",
+]
+dependencies = [
+    "opentelemetry-proto>=1.20",
+    "httpx>=0.27",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+    "respx>=0.21",
+]
+
+[project.urls]
+Homepage = "https://tracely.sh"
+Documentation = "https://docs.tracely.sh"
+Repository = "https://github.com/TracelyOrg/tracely-sdk"
+Issues = "https://github.com/TracelyOrg/tracely-sdk/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/tracely"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

tracely_sdk-0.1.0/src/tracely/__init__.py

@@ -0,0 +1,11 @@
+"""TRACELY SDK - Lightweight observability for Python web frameworks."""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+from tracely.sdk import init, shutdown
+from tracely.tracing import span
+from tracely.logging_api import debug, info, warning, error
+
+__all__ = ["init", "shutdown", "span", "debug", "info", "warning", "error", "__version__"]