witdem-analytics 0.2.0__tar.gz

witdem_analytics-0.2.0/.dockerignore

@@ -0,0 +1,16 @@
+.git
+.venv
+**/.venv
+**/__pycache__
+**/.pytest_cache
+**/.ruff_cache
+**/.mypy_cache
+web/node_modules
+web/*.tsbuildinfo
+dist
+**/dist
+data
+examples
+tests
+witdem-sdk
+.DS_Store

witdem_analytics-0.2.0/.env.example

@@ -0,0 +1,18 @@
+# Copy this file to .env for local development. Example folders may also
+# contain their own .env files; keep real credentials out of version control.
+OPENAI_API_KEY=
+ANTHROPIC_API_KEY=
+GOOGLE_API_KEY=
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AZURE_API_KEY=
+OLLAMA_HOST=http://localhost:11434
+WITDEM_ENDPOINT=http://localhost:4318
+
+# Optional authenticated remote profile. Leave unset for trusted localhost.
+WITDEM_API_KEY=
+WITDEM_INGEST_HOST=
+WITDEM_DASHBOARD_HOSTNAME=
+WITDEM_TLS_EMAIL=
+WITDEM_DASHBOARD_USER=
+WITDEM_DASHBOARD_PASSWORD_HASH=

witdem_analytics-0.2.0/.gitattributes

@@ -0,0 +1 @@
+*.duckdb filter=lfs diff=lfs merge=lfs -text

witdem_analytics-0.2.0/.github/workflows/pricing-catalog.yml

@@ -0,0 +1,46 @@
+name: Refresh pricing catalog
+
+on:
+  schedule:
+    - cron: "17 6 * * 1"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+concurrency:
+  group: pricing-catalog-refresh
+  cancel-in-progress: true
+
+jobs:
+  refresh:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+      - run: uv sync --all-groups
+      - run: uv run python -m witdem.pricing.update
+      - run: uv run pytest -q tests/test_pricing_catalog.py tests/test_pricing_update.py
+      - name: Open or update the review pull request
+        env:
+          GH_TOKEN: ${{ github.token }}
+          BRANCH: automation/pricing-catalog
+        run: |
+          if git diff --quiet -- src/witdem/pricing/catalog.yaml; then
+            echo "Pricing catalog is already current."
+            exit 0
+          fi
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git checkout -B "$BRANCH"
+          git add src/witdem/pricing/catalog.yaml
+          git commit -m "chore: refresh pricing catalog"
+          git push --force origin "$BRANCH"
+          test "$(gh pr list --head "$BRANCH" --state open --json number --jq length)" != "0" || gh pr create \
+            --base main \
+            --head "$BRANCH" \
+            --title "chore: refresh pricing catalog" \
+            --body "Automated weekly pricing snapshot refresh. Review every changed rate against the official source URL stored on the catalog entry before merging."

witdem_analytics-0.2.0/.github/workflows/release-analytics.yml

@@ -0,0 +1,32 @@
+name: Release witdem-analytics
+
+on:
+  workflow_dispatch:
+  push:
+    tags: ["analytics-v*"]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install build twine
+      - run: python -m pip install -e . pytest
+      - run: python -m pytest -q tests/test_protocol_compatibility.py
+      - run: python -m build
+      - run: python -m twine check dist/*
+      - name: Smoke-test built wheel
+        run: |
+          python -m venv /tmp/witdem-wheel
+          /tmp/witdem-wheel/bin/pip install dist/*.whl
+          /tmp/witdem-wheel/bin/witdem version
+          /tmp/witdem-wheel/bin/witdem doctor --port 14318 --dashboard-port 18501
+      - uses: pypa/gh-action-pypi-publish@release/v1

witdem_analytics-0.2.0/.github/workflows/release-container.yml

@@ -0,0 +1,86 @@
+name: Release container and npm launcher
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Released witdem-analytics version
+        required: true
+        type: string
+
+permissions:
+  contents: read
+  packages: write
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Verify release versions agree
+        env:
+          RELEASE_VERSION: ${{ inputs.version }}
+        run: |
+          python - <<'PY'
+          import json
+          import os
+          import pathlib
+          import tomllib
+
+          root = pathlib.Path(".")
+          python_version = tomllib.loads((root / "pyproject.toml").read_text())["project"]["version"]
+          npm_version = json.loads((root / "npm/package.json").read_text())["version"]
+          expected = os.environ["RELEASE_VERSION"]
+          assert python_version == expected, (python_version, expected)
+          assert npm_version == expected, (npm_version, expected)
+          PY
+      - uses: docker/setup-qemu-action@v3
+      - uses: docker/setup-buildx-action@v3
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: Dockerfile.witdem
+          platforms: linux/amd64,linux/arm64
+          push: true
+          sbom: true
+          provenance: mode=max
+          tags: |
+            ghcr.io/${{ github.repository_owner }}/witdem-analytics:${{ inputs.version }}
+            ghcr.io/${{ github.repository_owner }}/witdem-analytics:sha-${{ github.sha }}
+      - name: Compose smoke test published image
+        env:
+          WITDEM_ANALYTICS_IMAGE: ghcr.io/${{ github.repository_owner }}/witdem-analytics:${{ inputs.version }}
+        run: |
+          docker compose pull witdem elt-worker dashboard
+          docker compose up -d --no-build
+          for attempt in $(seq 1 30); do
+            curl -fsS http://localhost:4318/readiness && curl -fsS http://localhost:8501/health && exit 0
+            sleep 2
+          done
+          docker compose logs
+          exit 1
+      - uses: actions/setup-node@v6
+        with:
+          node-version: "24"
+          registry-url: https://registry.npmjs.org
+          package-manager-cache: false
+      - name: Test npm launcher
+        working-directory: npm
+        run: |
+          npm ci --ignore-scripts
+          npm run check
+          npm test
+          npm pack --dry-run
+      - name: Confirm the matching public image is pullable
+        run: |
+          docker logout ghcr.io
+          docker manifest inspect ghcr.io/${{ github.repository_owner }}/witdem-analytics:${{ inputs.version }} >/dev/null
+      - name: Publish npm launcher
+        working-directory: npm
+        run: npm publish --access public

witdem_analytics-0.2.0/.github/workflows/release-sdk.yml

@@ -0,0 +1,41 @@
+name: Release witdem-sdk
+
+on:
+  workflow_dispatch:
+  push:
+    tags: ["sdk-v*"]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    defaults:
+      run:
+        working-directory: witdem-sdk
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install build twine
+      - run: python -m build
+      - run: python -m twine check dist/*
+      - name: Smoke-test built wheel
+        run: |
+          python -m venv /tmp/witdem-sdk-wheel
+          /tmp/witdem-sdk-wheel/bin/pip install dist/*.whl
+          /tmp/witdem-sdk-wheel/bin/python - <<'PY'
+          import json
+          from pathlib import Path
+          import witdem_sdk
+          metadata = json.loads(Path('../compatibility.json').read_text())
+          assert witdem_sdk.__version__
+          assert witdem_sdk.SEMANTIC_RECORD_PROTOCOL_VERSION == metadata['semantic_record_protocol']
+          PY
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: witdem-sdk/dist

witdem_analytics-0.2.0/.github/workflows/test.yml

@@ -0,0 +1,105 @@
+name: Test
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  npm-launcher:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: npm
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: npm
+          cache-dependency-path: npm/package-lock.json
+      - run: npm ci --ignore-scripts
+      - run: npm run check
+      - run: npm test
+      - run: npm pack --dry-run
+      - name: Validate the packaged Compose definition
+        env:
+          WITDEM_IMAGE: ghcr.io/ebrahimisoheil/witdem-analytics:0.2.0
+          WITDEM_RECEIVER_PORT: "4318"
+          WITDEM_DASHBOARD_PORT: "8501"
+        run: docker compose --file compose.yaml config --quiet
+
+  packages:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python }}
+      - run: uv sync --all-groups
+      - run: uv run pytest -q
+      - run: uv run ruff check src tests
+      - run: uv run mypy src
+      - run: uv sync --project witdem-sdk --all-groups
+      - run: uv run pytest -q
+        working-directory: witdem-sdk
+      - run: uv run ruff check src tests
+        working-directory: witdem-sdk
+      - run: uv run mypy src
+        working-directory: witdem-sdk
+
+  product-factory:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: examples/product-factory
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+      - run: uv sync --all-groups --all-extras
+      - name: Install analytics package used by internal experiment tests
+        run: uv pip install --python .venv/bin/python -e ../..
+      - run: uv run pytest -q
+      - run: uv run ruff check src tests
+      - run: uv run mypy src
+
+  sdk-extras:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        extra: [anthropic, openai, langchain, langgraph, haystack, all]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+      - run: uv venv /tmp/witdem-extra
+      - run: uv pip install --python /tmp/witdem-extra/bin/python "./witdem-sdk[${{ matrix.extra }}]"
+      - name: Import selected integration
+        run: |
+          case "${{ matrix.extra }}" in
+            openai) module=openai_agents ;;
+            all) module=anthropic ;;
+            *) module="${{ matrix.extra }}" ;;
+          esac
+          /tmp/witdem-extra/bin/python -c "import witdem_sdk; import witdem_sdk.integrations.${module}"
+
+  sdk-integrations:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: witdem-sdk
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+      - run: uv sync --all-groups --all-extras
+      - run: uv run pytest -q tests/test_optional_integrations.py

witdem_analytics-0.2.0/.gitignore

@@ -0,0 +1,27 @@
+__pycache__/
+*.pyc
+.venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+*.duckdb
+/data/backups/
+.env
+.DS_Store
+!data/synthetic-ui-v2/
+!data/synthetic-ui-v2/**
+!data/synthetic-ui-v2/analytics.duckdb
+data/live/
+.claude/
+data/**/.DS_Store
+
+# Dashboard contributor build artifacts
+web/node_modules/
+web/*.tsbuildinfo
+web/vite.config.js
+web/vite.config.d.ts
+web/tailwind.config.js
+web/tailwind.config.d.ts
+
+# Locally generated live-matrix reports
+examples/product-factory/reports/

witdem_analytics-0.2.0/Dockerfile.witdem

@@ -0,0 +1,27 @@
+FROM node:22-slim AS dashboard-build
+
+WORKDIR /build/web
+COPY web/package.json web/package-lock.json ./
+RUN npm ci
+COPY web ./
+RUN npm run build
+
+FROM python:3.12-slim
+
+WORKDIR /app
+
+ARG WITDEM_ANALYTICS_REQUIREMENT=.
+
+COPY pyproject.toml ./
+COPY README.md ./README.md
+COPY src ./src
+COPY --from=dashboard-build /build/src/witdem/dashboard/static ./src/witdem/dashboard/static
+
+RUN pip install --no-cache-dir "${WITDEM_ANALYTICS_REQUIREMENT}"
+
+EXPOSE 4318
+
+HEALTHCHECK --interval=30s --timeout=3s --start-period=5s \
+  CMD python -c "import urllib.request as u; u.urlopen('http://localhost:4318/health', timeout=2)" || exit 1
+
+CMD ["witdem", "serve", "--host", "0.0.0.0", "--port", "4318"]

witdem_analytics-0.2.0/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.5
+Name: witdem-analytics
+Version: 0.2.0
+Summary: Runtime analytics for agent applications using OpenTelemetry, with optional business semantics through the Witdem SDK.
+Requires-Python: >=3.10
+Requires-Dist: duckdb<2,>=1.2
+Requires-Dist: duckle==0.5.11
+Requires-Dist: fastapi<1,>=0.115
+Requires-Dist: filelock<4,>=3.16
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: opentelemetry-api<2,>=1.27
+Requires-Dist: opentelemetry-exporter-otlp-proto-http<2,>=1.27
+Requires-Dist: opentelemetry-proto<2,>=1.27
+Requires-Dist: opentelemetry-sdk<2,>=1.27
+Requires-Dist: platformdirs<5,>=4.3
+Requires-Dist: pydantic<3,>=2.10
+Requires-Dist: pyyaml<7,>=6.0
+Requires-Dist: uvicorn[standard]<1,>=0.34
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# Witdem
+
+**Analytics for AI agents and multi-step AI applications.**
+
+Tracing tells you what executed. Witdem connects those executions to application outcomes: which paths ran, what they cost, where they failed, and whether they achieved the product goal you defined.
+
+[Get started](docs/getting-started.md) · [YAML contracts](docs/contract-tutorial.md) · [Haystack](docs/integrations/haystack.md) · [Frameworks](#integration-status) · [Providers](docs/providers.md) · [Troubleshooting](docs/troubleshooting.md)
+
+</div>
+
+## First run
+
+Start the local receiver, ELT worker, and dashboard:
+
+```bash
+npx -y witdem@0.2.0 up
+```
+
+That pulls the version-matched container, starts all three services, waits for
+them to become healthy, and opens `http://localhost:8501`. Docker with Compose
+is the only prerequisite. Data persists across `down` and package upgrades.
+
+```bash
+npx -y witdem@0.2.0 status
+npx -y witdem@0.2.0 logs
+npx -y witdem@0.2.0 down
+```
+
+Add the SDK to an existing Haystack 3 project from the checkout:
+
+```bash
+python -m pip install -e "/path/to/Witdem-Analytics/witdem-sdk[haystack]"
+export WITDEM_ENDPOINT=http://localhost:4318
+```
+
+Wrap the pipeline once. Its existing `run`, `run_async`, and `run_async_generator` calls stay unchanged:
+
+```python
+from witdem_sdk.integrations.haystack import instrument
+
+pipeline = instrument(build_pipeline())
+result = pipeline.run(data)
+```
+
+Add `.witdem/witdem.yaml` to describe what a useful result means:
+
+```yaml
+version: 1
+service:
+  name: support-agent
+  runtime: haystack
+telemetry:
+  capture_content: false
+contracts:
+  - name: answer
+    mode: expression
+    artifact:
+      name: Support answer
+      valid:
+        non_empty: $.answer
+    decision:
+      name: Result validity
+      expected: true
+      observed: $.witdem.artifact_valid
+    product_goal:
+      name: Useful answer returned
+      achieved: $.witdem.artifact_valid
+```
+
+Run the application normally. The execution and its business result appear at **http://localhost:8501**.
+
+> `witdem-sdk` 0.2.0 is not yet published to the package index. The source-checkout command above is the verified installation path for this release. Publishing the package is the remaining installation launch blocker.
+
+## What you get
+
+- Actual execution paths, branches, loops, retries, tools, model calls, and failures
+- Per-run latency, token usage, and cost when provider/model/usage evidence is sufficient
+- Application outcomes and product-goal success defined by your application
+- Provider and model comparisons using attributable time, usage, cost, and quality
+- Workflow/path analytics and run-linked issue investigation
+- Local DuckDB storage and a self-hosted dashboard; prompt and response capture is off by default
+
+Witdem does not infer business success from a completed LLM call. Framework instrumentation records what happened technically; `.witdem/witdem.yaml` explains what the final result means.
+
+## Integration status
+
+Statuses reflect current implementation and test evidence, not roadmap intent.
+
+| Integration | Status | Verified surface |
+| --- | --- | --- |
+| [Haystack 3](docs/integrations/haystack.md) | **Stable** | Pipelines, agents, components, provider calls, loops, parallel branches, `run`, `run_async`, async generators |
+| [LangGraph](docs/integrations/langgraph.md) | **Beta** | Compiled graphs, nodes, tools, models, errors, sync/async invocation and streaming |
+| [LangChain](docs/integrations/langchain.md) | **Beta** | Runnables, chains, chat/LLM calls, tools, retrievers, sync/async invocation and streaming |
+| [Native Python](docs/integrations/native-python.md) | **Supported** | Execution, operation, model, tool, decision, evaluation, outcome, and metric primitives |
+| [OpenAI Agents](docs/integrations/openai-agents.md) | **Beta** | Native trace processor, agents, generations, tools, handoffs, sync/async workloads |
+| [Anthropic Messages and Claude Agent SDK](docs/integrations/anthropic.md) | **Beta** | Messages calls, usage, tool-use IDs, multi-turn workloads, Claude Agent message streams |
+| [Hugging Face smolagents](docs/integrations/smolagents.md) | **Beta** | Official OpenInference agent, step, model, and tool spans; sync and streaming execution |
+| [LiteLLM](docs/integrations/litellm.md) | **Beta** | SDK callback and proxy OTLP paths, provider/model usage, reported cost, failures, routing metadata |
+| [OpenRouter](docs/providers/openrouter.md) | **Beta** | OpenAI-compatible sync/async and streaming calls, selected provider, route attempts, authoritative cost |
+| Generic provider calls | **Experimental** | Sync/async callable wrapper with explicit provider/model and observed result metadata |
+| Standard OTLP/HTTP | **Supported** | Generic OpenTelemetry, OTel GenAI, and OpenInference evidence |
+
+See [`compatibility.json`](compatibility.json) for machine-readable version constraints and [Providers](docs/providers.md) for the difference between native, framework-observed, and generic support.
+
+## Providers
+
+Witdem currently has verified paths for:
+
+- [OpenAI](docs/providers/openai.md) and [Azure OpenAI](docs/providers/azure-openai.md)
+- [Anthropic](docs/providers/anthropic.md), including Claude Agent SDK telemetry
+- [DeepSeek](docs/providers/deepseek.md)
+- [Mistral](docs/providers/mistral.md)
+- [Amazon Bedrock](docs/providers/bedrock.md)
+- [Google Vertex AI](docs/providers/vertex-ai.md)
+- [Ollama](docs/providers/ollama.md)
+- [Cohere](docs/providers/cohere.md) (structurally tested, not live-validated)
+- [OpenRouter](docs/providers/openrouter.md), including selected upstream provider and fallback metadata
+- Hugging Face inference through [smolagents](docs/integrations/smolagents.md) or [LiteLLM](docs/integrations/litellm.md)
+
+OpenAI and Anthropic have dedicated SDK integrations. Haystack observes the generator actually used at each model boundary. The remaining provider examples use standard GenAI OpenTelemetry attributes or `witdem_sdk.integrations.generic`; this is explicit in every provider guide.
+
+Cost is not assumed from a provider name. Witdem uses provider-reported money when present, or the versioned server catalog when provider, model, and token usage match a catalog entry. Unknown prices remain **Not measured** with a diagnostic reason.
+
+## Parallel and asynchronous execution
+
+When sibling spans overlap, Witdem preserves the observed fan-out and fan-in rather than flattening them into a false sequence:
+
+```text
+             ┌─ semantic retriever ─┐
+execution ───┤                      ├─ answer
+             └─ keyword retriever ──┘
+```
+
+The runnable [Haystack parallel pipeline](examples/haystack/pipeline/README.md) demonstrates this with two concurrent retrievers and an OpenAI answer component.
+
+## Self-hosting
+
+The npm launcher is the recommended local backend path. It is deliberately a
+small, dependency-free Docker launcher rather than a second implementation of
+Witdem. It never runs an npm `postinstall` script.
+
+| Service | Address | Purpose |
+| --- | --- | --- |
+| Dashboard | `http://localhost:8501` | Overview, runs, compare, workflows, and issues |
+| Receiver | `http://localhost:4318` | OTLP/HTTP and SDK record ingestion |
+| ELT worker | internal | Duckle transformation into dashboard-ready DuckDB tables |
+
+```bash
+npx -y witdem@0.2.0 status
+curl http://localhost:4318/readiness
+curl http://localhost:8501/health
+```
+
+For source development, clone the repository and run `docker compose up -d`.
+See [Running Witdem with npx](docs/npm-launcher.md) for ports, lifecycle, image
+pinning, and troubleshooting.
+
+The Python-only development path is also available:
+
+```bash
+uv sync
+uv run witdem dev --open
+```
+
+## Documentation
+
+- [Getting started](docs/getting-started.md)
+- [Running Witdem with npx](docs/npm-launcher.md)
+- [Concepts: tracing and business meaning](docs/concepts.md)
+- [Tutorial: defining a YAML contract](docs/contract-tutorial.md)
+- [YAML configuration](docs/configuration.md)
+- [Haystack](docs/integrations/haystack.md)
+- [LangGraph](docs/integrations/langgraph.md)
+- [LangChain](docs/integrations/langchain.md)
+- [Native/custom Python](docs/integrations/native-python.md)
+- [OpenAI Agents](docs/integrations/openai-agents.md)
+- [Anthropic and Claude Agent](docs/integrations/anthropic.md)
+- [Provider support](docs/providers.md)
+- [Pricing catalog and automated refresh](docs/pricing.md)
+- [Dashboard](docs/dashboard.md)
+- [Troubleshooting](docs/troubleshooting.md)
+- [Examples](docs/examples.md)
+- [Operations](docs/operations.md)
+- [Development and contributing](docs/development.md)
+
+## Built with
+
+<table>
+  <tr>
+    <td align="center" width="33%"><img src="docs/assets/duckdb.svg" alt="DuckDB" width="180"><br>Local analytics storage</td>
+    <td align="center" width="33%"><img src="docs/assets/duckle.png" alt="Duckle" width="105"><br>Raw-to-serving transformation</td>
+    <td align="center" width="33%"><img src="docs/assets/tanstack.svg" alt="TanStack" width="180"><br>Dashboard routing, queries, and tables</td>
+  </tr>
+</table>
+
+Witdem is independent of these projects. Their names and unmodified marks identify the technologies used and do not imply endorsement.