nilalytics 0.1.0__tar.gz

nilalytics-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,55 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "README.md"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  # Never cancel an in-progress Pages deployment — doing so corrupts the
+  # deployment state and causes "Deployment failed, try again later".
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install mkdocs-material
+      - run: mkdocs build --strict
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+    steps:
+      # GitHub Pages' deploy step occasionally returns a transient
+      # "Deployment failed, try again later". Attempt once, and if it fails,
+      # wait and retry so the run self-heals instead of alerting.
+      - id: deploy1
+        uses: actions/deploy-pages@v4
+        continue-on-error: true
+      - name: Wait before retry
+        if: steps.deploy1.outcome == 'failure'
+        run: sleep 60
+      - name: Retry deploy
+        if: steps.deploy1.outcome == 'failure'
+        uses: actions/deploy-pages@v4

nilalytics-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: publish
+
+# Publishes nilalytics to PyPI when a GitHub Release is published.
+# Uses PyPI Trusted Publishing (OIDC) — no API token is stored anywhere.
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - run: uvx twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/nilalytics/
+    permissions:
+      id-token: write # required for Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

nilalytics-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+# runtime data + artifacts (never commit)
+.venv/
+data/
+.minio-data/
+*.ducklake
+*.ducklake.wal
+__pycache__/
+*.pyc
+
+# build + docs site output
+dist/
+site/
+*.egg-info/

nilalytics-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 2026 Angelerator
+
+   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.

nilalytics-0.1.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: nilalytics
+Version: 0.1.0
+Summary: Serverless realtime analytics: OTLP events -> DuckLake on object storage (S3/GCS/R2/Azure), served over Quack.
+Project-URL: Homepage, https://angelerator.github.io/nilalytics/
+Project-URL: Documentation, https://angelerator.github.io/nilalytics/
+Project-URL: Repository, https://github.com/Angelerator/nilalytics
+Project-URL: Issues, https://github.com/Angelerator/nilalytics/issues
+Author: Angelerator
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: analytics,duckdb,ducklake,lakehouse,mobile-analytics,observability,opentelemetry,otlp,product-analytics,web-analytics
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: Log Analysis
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.11
+Requires-Dist: duckdb>=1.5.3
+Requires-Dist: pytz>=2024.1
+Requires-Dist: requests>=2.31
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# nilalytics
+
+**Serverless, self‑hosted realtime analytics for web and mobile — on your own object storage.**
+
+nilalytics collects product events, errors, and performance data over
+[OpenTelemetry](https://opentelemetry.io/) (OTLP), stores them in a
+[DuckLake](https://ducklake.select/) lakehouse on any major cloud's object
+storage, and serves sub‑second reads over DuckDB's [Quack](https://duckdb.org/docs/stable/core_extensions/quack) protocol — no warehouse, no per‑event fees, no data leaving your infrastructure.
+
+- **One SDK per platform:** Grafana Faro (web) or OpenTelemetry SDKs (mobile) → OTLP.
+- **Runs on any cloud:** S3, MinIO, Google Cloud Storage, Cloudflare R2, or Azure / ADLS Gen2.
+- **Small files solved:** DuckLake data inlining keeps streaming writes fast and cheap.
+- **Batteries included:** funnels, retention, errors, traces, metrics, cross‑device identity.
+- **Secure by default:** token‑authenticated ingest, read‑only query authz, a hardened public gateway.
+
+📖 **Full documentation:** <https://angelerator.github.io/nilalytics/>
+
+## Install
+
+```bash
+pip install git+https://github.com/Angelerator/nilalytics
+```
+
+## 60‑second local demo
+
+```bash
+# 1. object storage (local MinIO)
+minio server .minio-data --address 127.0.0.1:9100 --console-address 127.0.0.1:9101 &
+mc alias set nila http://127.0.0.1:9100 minioadmin minioadmin
+mc mb --ignore-existing nila/nilalytics
+
+# 2. run the pipeline
+nilalytics server &      # ingest + Quack catalog
+nilalytics gateway &     # public ingest gateway (CORS + tokens)
+
+# 3. send + query
+nilalytics emit --count 200 --persons 5
+nilalytics query report
+```
+
+## Architecture
+
+```mermaid
+flowchart LR
+  W["Web · Grafana Faro"] -->|OTLP + token| GW
+  M["Mobile · OpenTelemetry"] -->|OTLP + token| GW
+  GW["Ingest Gateway<br/>CORS · tokens · TLS"] --> SRV["OTLP server<br/>(duckdb-otlp)"]
+  SRV --> LAKE[("DuckLake<br/>DuckDB + Quack catalog<br/>+ Parquet on object storage")]
+  LAKE --> READ["Reads: DuckDB / DuckDB-WASM<br/>over Quack"]
+```
+
+## Acknowledgements
+
+nilalytics stands on the shoulders of giants. Huge thanks to
+[DuckDB](https://duckdb.org/), [DuckLake](https://ducklake.select/) and Quack (DuckDB Labs / DuckDB Foundation),
+[duckdb‑otlp](https://github.com/smithclay/duckdb-otlp) ([@smithclay](https://github.com/smithclay)),
+[OpenTelemetry](https://opentelemetry.io/) (CNCF),
+[Grafana Faro](https://github.com/grafana/faro-web-sdk) (Grafana Labs),
+and [MinIO](https://min.io/) — plus the projects that inspired it:
+[canardstack](https://github.com/smithclay/canardstack),
+[icelight](https://github.com/cliftonc/icelight), and
+[stratif.io](https://stratif.io/).
+
+Full credits and dependency list: [Acknowledgements](https://angelerator.github.io/nilalytics/acknowledgements/).
+
+## License
+
+[Apache‑2.0](LICENSE) © Angelerator
+

nilalytics-0.1.0/README.md

@@ -0,0 +1,69 @@
+# nilalytics
+
+**Serverless, self‑hosted realtime analytics for web and mobile — on your own object storage.**
+
+nilalytics collects product events, errors, and performance data over
+[OpenTelemetry](https://opentelemetry.io/) (OTLP), stores them in a
+[DuckLake](https://ducklake.select/) lakehouse on any major cloud's object
+storage, and serves sub‑second reads over DuckDB's [Quack](https://duckdb.org/docs/stable/core_extensions/quack) protocol — no warehouse, no per‑event fees, no data leaving your infrastructure.
+
+- **One SDK per platform:** Grafana Faro (web) or OpenTelemetry SDKs (mobile) → OTLP.
+- **Runs on any cloud:** S3, MinIO, Google Cloud Storage, Cloudflare R2, or Azure / ADLS Gen2.
+- **Small files solved:** DuckLake data inlining keeps streaming writes fast and cheap.
+- **Batteries included:** funnels, retention, errors, traces, metrics, cross‑device identity.
+- **Secure by default:** token‑authenticated ingest, read‑only query authz, a hardened public gateway.
+
+📖 **Full documentation:** <https://angelerator.github.io/nilalytics/>
+
+## Install
+
+```bash
+pip install git+https://github.com/Angelerator/nilalytics
+```
+
+## 60‑second local demo
+
+```bash
+# 1. object storage (local MinIO)
+minio server .minio-data --address 127.0.0.1:9100 --console-address 127.0.0.1:9101 &
+mc alias set nila http://127.0.0.1:9100 minioadmin minioadmin
+mc mb --ignore-existing nila/nilalytics
+
+# 2. run the pipeline
+nilalytics server &      # ingest + Quack catalog
+nilalytics gateway &     # public ingest gateway (CORS + tokens)
+
+# 3. send + query
+nilalytics emit --count 200 --persons 5
+nilalytics query report
+```
+
+## Architecture
+
+```mermaid
+flowchart LR
+  W["Web · Grafana Faro"] -->|OTLP + token| GW
+  M["Mobile · OpenTelemetry"] -->|OTLP + token| GW
+  GW["Ingest Gateway<br/>CORS · tokens · TLS"] --> SRV["OTLP server<br/>(duckdb-otlp)"]
+  SRV --> LAKE[("DuckLake<br/>DuckDB + Quack catalog<br/>+ Parquet on object storage")]
+  LAKE --> READ["Reads: DuckDB / DuckDB-WASM<br/>over Quack"]
+```
+
+## Acknowledgements
+
+nilalytics stands on the shoulders of giants. Huge thanks to
+[DuckDB](https://duckdb.org/), [DuckLake](https://ducklake.select/) and Quack (DuckDB Labs / DuckDB Foundation),
+[duckdb‑otlp](https://github.com/smithclay/duckdb-otlp) ([@smithclay](https://github.com/smithclay)),
+[OpenTelemetry](https://opentelemetry.io/) (CNCF),
+[Grafana Faro](https://github.com/grafana/faro-web-sdk) (Grafana Labs),
+and [MinIO](https://min.io/) — plus the projects that inspired it:
+[canardstack](https://github.com/smithclay/canardstack),
+[icelight](https://github.com/cliftonc/icelight), and
+[stratif.io](https://stratif.io/).
+
+Full credits and dependency list: [Acknowledgements](https://angelerator.github.io/nilalytics/acknowledgements/).
+
+## License
+
+[Apache‑2.0](LICENSE) © Angelerator
+

nilalytics-0.1.0/docs/acknowledgements.md

@@ -0,0 +1,49 @@
+# Acknowledgements
+
+nilalytics is a thin layer over remarkable open‑source work. It is standing on
+the shoulders of giants — deep thanks to everyone who built and maintains the
+projects below. 🙏
+
+## Built on
+
+- **[DuckDB](https://duckdb.org/)** — the in‑process analytical engine at the core, by **DuckDB Labs** and the **DuckDB Foundation**.
+- **[DuckLake](https://ducklake.select/)** — the SQL‑native lakehouse format (catalog + Parquet) that stores every event. Its **data inlining** is what makes streaming ingestion cheap and fast.
+- **Quack** — DuckDB's client–server protocol, which serves the catalog to readers and to DuckDB‑WASM in the browser.
+- **[duckdb‑otlp](https://github.com/smithclay/duckdb-otlp)** by **[@smithclay](https://github.com/smithclay)** — the embedded OTLP ingest server that lands telemetry straight into DuckLake, and does post‑seal compaction.
+- **[OpenTelemetry](https://opentelemetry.io/)** (CNCF) — the vendor‑neutral standard every nilalytics client speaks.
+- **[Grafana Faro](https://github.com/grafana/faro-web-sdk)** by **Grafana Labs** — the web RUM SDK and its OTLP transport.
+- **DuckDB `httpfs` / `azure` extensions** — object‑storage access across S3, GCS, R2, and Azure / ADLS.
+- **[MinIO](https://min.io/)** — S3‑compatible object storage used for local development.
+
+## Inspiration
+
+nilalytics wouldn't exist without prior art that proved the shape of this idea:
+
+- **[canardstack](https://github.com/smithclay/canardstack)** by [@smithclay](https://github.com/smithclay) — querying OpenTelemetry data stored in DuckLake with a Quack catalog.
+- **[icelight](https://github.com/cliftonc/icelight)** by [@cliftonc](https://github.com/cliftonc) — first‑party analytics.js → Iceberg on R2 → DuckDB.
+- **[stratif.io](https://stratif.io/)** by **Carlo Abi Chahine** — open‑source, warehouse‑native product analytics on DuckDB.
+- **[Definite](https://www.definite.app/blog/duckdb-quack-ducklake-catalog)** — for the clear writeup on using DuckDB + Quack as the DuckLake catalog.
+
+## Dependencies
+
+### Runtime (Python)
+
+| Package | License | Used for |
+|---------|---------|----------|
+| [duckdb](https://pypi.org/project/duckdb/) | MIT | engine + all extensions |
+| [requests](https://pypi.org/project/requests/) | Apache‑2.0 | HTTP (emitter, gateway forwarding) |
+| [pytz](https://pypi.org/project/pytz/) | MIT | timezone support for time‑travel queries |
+
+### DuckDB extensions (auto‑installed at runtime)
+
+`ducklake` · `quack` · `otlp` · `httpfs` · `azure`
+
+### Documentation
+
+- [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) by **[@squidfunk](https://github.com/squidfunk)** (Martin Donath).
+
+## Licensing
+
+nilalytics is released under [Apache‑2.0](https://github.com/Angelerator/nilalytics/blob/main/LICENSE). Every
+dependency and referenced project is distributed under its own license — please
+review each one for your use case.

nilalytics-0.1.0/docs/architecture.md

@@ -0,0 +1,67 @@
+# Architecture
+
+nilalytics is a thin pipeline over proven pieces: OpenTelemetry for collection,
+DuckLake for storage, DuckDB for compute, and Quack for serving.
+
+```mermaid
+flowchart LR
+  W["Web · Grafana Faro"] -->|OTLP| GW
+  IOS["iOS · OTel"] -->|OTLP| GW
+  AND["Android · OTel"] -->|OTLP| GW
+  GW["Ingest Gateway :4319<br/>CORS · short-lived tokens · TLS"] --> SRV["OTLP server :4318<br/>(duckdb-otlp, single writer)"]
+  SRV --> LAKE[("DuckLake<br/>hot: inlined rows in catalog<br/>cold: Parquet on object storage<br/>(S3/GCS/R2/Azure)")]
+  LAKE --> QUACK["Quack :9494"]
+  QUACK --> READ["DuckDB / DuckDB-WASM<br/>dashboards, funnels, errors, traces"]
+```
+
+## The pieces
+
+**Emitter (client).** Any OTLP producer. On the web that's **Grafana Faro** (via
+its OTLP transport); on mobile it's an **OpenTelemetry SDK**. Everything becomes
+OTLP logs (events + errors), spans (performance), and metrics.
+
+**Ingest gateway.** The public front door. It adds CORS (so browsers can post),
+verifies **short‑lived tokens** (so no long‑lived secret ships in a client),
+optionally terminates TLS, and forwards to the internal OTLP server. See
+[Ingest gateway](ingest-gateway.md).
+
+**OTLP server (`duckdb-otlp`).** An embedded HTTP server inside a DuckDB process.
+It buffers incoming OTLP and commits batches into the DuckLake, then runs
+best‑effort compaction. It is the single writer.
+
+**DuckLake.** The lakehouse format: a **catalog** (metadata) + **Parquet** (data
+on object storage). nilalytics uses a **DuckDB catalog served over Quack**, so
+many clients can read/write through one server.
+
+- **Data inlining:** small writes land as rows *inside the catalog* — no tiny
+  Parquet files. This is what makes streaming ingestion fast and cheap.
+- **Checkpoints:** flush inlined rows to Parquet and merge small files.
+
+**Read path (Quack).** Dashboards and DuckDB‑WASM connect to the Quack server and
+run SQL against the lake — they never touch object‑storage credentials. Reads are
+restricted to a read‑only authorization policy.
+
+## Two data tiers
+
+| Tier | Where | Speed | Used for |
+|------|-------|-------|----------|
+| **Hot** | inlined rows in the catalog | sub‑second | "right now" dashboards |
+| **Cold** | Parquet on object storage | fast, cheap | history / heavy analysis |
+
+Queries transparently combine both.
+
+## Signals → tables
+
+| Signal | OTLP kind | DuckLake table |
+|--------|-----------|----------------|
+| product events, errors, logs | logs | `otlp_logs` |
+| performance (page load, API) | traces | `otlp_traces` |
+| web‑vitals, counters | metrics | `otlp_metrics_*` |
+
+## Processes you run
+
+- `nilalytics server` — the OTLP server + Quack catalog.
+- `nilalytics gateway` — the public ingest gateway.
+- (optional) a scheduled `nilalytics maintenance` for compaction/retention.
+
+Everything is configured with environment variables — see [Configuration](configuration.md).

nilalytics-0.1.0/docs/cli.md

@@ -0,0 +1,77 @@
+# CLI reference
+
+All commands are subcommands of `nilalytics`. Each is also runnable as
+`python -m nilalytics.<module>`.
+
+```bash
+nilalytics <command> [args]
+```
+
+## `server`
+
+Runs the OTLP ingest server (`:4318`) and the Quack catalog server (`:9494`),
+attaching the DuckLake. Blocks until interrupted (Ctrl‑C commits buffered rows).
+
+```bash
+nilalytics server
+```
+
+## `gateway`
+
+Runs the public ingest gateway (`:4319`) — CORS, short‑lived tokens, optional TLS
+— forwarding to the internal OTLP server. See [Ingest gateway](ingest-gateway.md).
+
+```bash
+nilalytics gateway
+```
+
+## `emit`
+
+Sends sample telemetry (useful for demos and load checks).
+
+```bash
+nilalytics emit [options]
+```
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `-n`, `--count` | `200` | Number of log events |
+| `-b`, `--batch-size` | `50` | Events per POST |
+| `-e`, `--error-rate` | `0.1` | Fraction that are errors |
+| `--traces` | `10` | Trace spans |
+| `--metrics` | `10` | Metric points |
+| `--persons` | `0` | Simulate N cross‑device people (2 devices each, identified) |
+
+## `query`
+
+Reads over Quack. Default subcommand is `report`.
+
+```bash
+nilalytics query [subcommand] [args]
+```
+
+| Subcommand | Description |
+|------------|-------------|
+| `report` | Totals, funnel, errors, devices, identified persons, latency |
+| `traces` | Recent spans + p95 latency per span |
+| `metrics` | Metric names, counts, averages |
+| `errors` | Recent errors |
+| `stitch` | Cross‑device identity graph |
+| `snapshots` | DuckLake snapshots |
+| `asof <interval>` | Time travel (e.g. `asof "5 minutes"`) |
+| `changes [start] [end]` | Change feed between snapshots |
+| `count` | Total rows |
+| `schema` | `otlp_logs` columns |
+| `sample` | One raw row |
+
+## `maintenance`
+
+Flush inlined data to Parquet and compact. See [Maintenance](maintenance.md).
+
+```bash
+nilalytics maintenance [--expire]
+```
+
+| Option | Description |
+|--------|-------------|
+| `--expire` | Also expire old snapshots + delete unused files (destructive) |