witdem-analytics 0.1.0__tar.gz

witdem_analytics-0.1.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.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

witdem_analytics-0.1.0/PKG-INFO

@@ -0,0 +1,287 @@
+Metadata-Version: 2.5
+Name: witdem-analytics
+Version: 0.1.0
+Summary: Runtime analytics for agent applications using OpenTelemetry, with optional business semantics through the Witdem SDK.
+License-File: 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
+Requires-Python: <3.14,>=3.10
+Requires-Dist: cryptography<51,>=50
+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">
+
+<img src="docs/assets/witdem-banner.png" alt="Witdem AI — Understand how your AI system actually behaves" width="100%">
+
+# 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.
+
+[![Tests](https://github.com/ebrahimisoheil/witdem-oss/actions/workflows/test.yml/badge.svg)](https://github.com/ebrahimisoheil/witdem-oss/actions/workflows/test.yml)
+[![SDK on PyPI](https://img.shields.io/pypi/v/witdem-sdk?label=witdem-sdk)](https://pypi.org/project/witdem-sdk/)
+[![Analytics on PyPI](https://img.shields.io/pypi/v/witdem-analytics?label=witdem-analytics)](https://pypi.org/project/witdem-analytics/)
+[![npm](https://img.shields.io/npm/v/witdem?label=npx%20witdem)](https://www.npmjs.com/package/witdem)
+[![Python](https://img.shields.io/badge/Python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://github.com/ebrahimisoheil/witdem-oss/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+[Get started](docs/getting-started.md) · [YAML contracts](docs/contract-tutorial.md) · [Frameworks](#integration-status) · [Providers](docs/providers.md) · [Contributing](CONTRIBUTING.md) · [Security](SECURITY.md)
+
+</div>
+
+## See Witdem in action
+
+From one-line setup and two-line instrumentation to a measured run, its
+execution graph, business outcome, cost, and contract evidence.
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/ebrahimisoheil/witdem-oss@37e335d/docs/assets/witdem-demo.mp4">
+    <img src="docs/assets/witdem-demo-poster.jpg" alt="Watch the Witdem installation and analysis walkthrough" width="100%">
+  </a>
+  <br>
+  <a href="https://cdn.jsdelivr.net/gh/ebrahimisoheil/witdem-oss@37e335d/docs/assets/witdem-demo.mp4"><strong>▶ Watch the 1:48 installation-to-analysis walkthrough</strong></a>
+</p>
+
+## First run
+
+Choose one backend launcher. Applications use `witdem-sdk` with either path.
+
+Docker-managed (requires Docker Compose):
+
+```bash
+npx -y witdem@latest up
+```
+
+Native Python (requires Python and [pipx](https://pipx.pypa.io/)):
+
+```bash
+pipx install witdem-analytics
+witdem up
+```
+
+Both start the receiver, ELT worker, and dashboard, wait for health, open
+`http://localhost:8501`, and preserve data across `down` and upgrades. Their
+lifecycle vocabulary is the same:
+
+```bash
+npx -y witdem@latest status       # Docker path
+witdem status                     # pipx path
+npx -y witdem@latest logs receiver
+witdem down
+```
+
+Check releases and compatibility without changing packages or data:
+
+```bash
+npx -y witdem@latest update --check
+witdem update --check
+```
+
+See the [upgrade guide](docs/upgrade.md) for exact NPX, pipx, and SDK commands.
+
+Add the SDK to an existing Haystack 3 project:
+
+```bash
+python -m pip install "witdem-sdk[haystack]"
+export WITDEM_ENDPOINT=http://localhost:4318
+```
+
+From the application project, create the YAML contract and then edit it to
+describe that application's result:
+
+```bash
+witdem-sdk init --runtime haystack
+```
+
+This creates `.witdem/witdem.yaml`. It does not inspect or rewrite application
+code, and it will not replace an existing contract unless `--force` is used.
+
+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**.
+
+## 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 |
+
+Witdem also normalizes retrieval, reranking, search, embeddings, OCR, tools, evaluations, image, audio, video, and extension operations without inferring vendors. See [AI operations and evaluations](docs/ai-operations.md).
+
+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
+
+NPX is the Docker-managed path; pipx is a genuinely native, Node-free and
+Docker-free path. The npm package never runs a `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@latest status
+curl http://localhost:4318/readiness
+curl http://localhost:8501/health
+```
+
+See [Operations](docs/operations.md) for lifecycle, ports, logs, data,
+backup/recovery, and [Development](docs/development.md) only when contributing
+to Witdem itself.
+
+## 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)
+- [Workflow definitions, compilation, and replay](docs/workflow-replay.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)
+- [CLI reference](docs/cli-reference.md)
+- [Upgrade and compatibility](docs/upgrade.md)
+- [Architecture and data flow](docs/architecture.md)
+- [Release notes](docs/changelog.md)
+- [Performance and lifecycle implementation report](docs/implementation-report.md)
+- [Development and contributing](docs/development.md)
+
+## Community
+
+Witdem is built in the open. Bug reports, integration examples, documentation
+improvements, and focused code contributions are welcome.
+
+- Read [Contributing](CONTRIBUTING.md) before opening a pull request.
+- Participate under the [Code of Conduct](CODE_OF_CONDUCT.md).
+- Report vulnerabilities privately according to the [Security policy](SECURITY.md).
+
+## License
+
+Witdem is licensed under the [Apache License 2.0](LICENSE).
+
+## 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.