From 7ed4b900563e3330397c61c7a1803ea950a7668a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Manciot?= Date: Sat, 20 Jun 2026 17:10:01 +0200 Subject: [PATCH] docs(sql): add driver download telemetry & privacy page Core-docs mirror of the website Telemetry & Privacy page (dual-doc convention): the no-IP / no-PII guarantee for driver-download analytics. Markdown only. Closes #107 Co-Authored-By: Claude Opus 4.8 (1M context) --- documentation/sql/README.md | 1 + documentation/sql/telemetry.md | 46 ++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 documentation/sql/telemetry.md diff --git a/documentation/sql/README.md b/documentation/sql/README.md index 1dded52a..e43b32aa 100644 --- a/documentation/sql/README.md +++ b/documentation/sql/README.md @@ -18,3 +18,4 @@ Welcome to the SQL Engine Documentation. Navigate through the sections below: - [DML Support](dml_statements.md) - [DQL Support](dql_statements.md) - [Materialized Views](materialized_views.md) +- [Telemetry & Privacy](telemetry.md) diff --git a/documentation/sql/telemetry.md b/documentation/sql/telemetry.md new file mode 100644 index 00000000..8f91b595 --- /dev/null +++ b/documentation/sql/telemetry.md @@ -0,0 +1,46 @@ +# Telemetry & Privacy + +SoftClient4ES measures **driver adoption** with anonymous, aggregate counts only. This page describes +the download analytics specifically; a complete, surface-by-surface telemetry overview will follow. + +> This is the core-project mirror of the website page +> [Telemetry & Privacy](https://softclient4es.com/privacy/telemetry/) — kept in sync per the dual-doc +> convention. + +## What is collected + +When you click a **Download** button on the website's installation page, the site sends one small +beacon to a public endpoint with exactly these fields: + +| Field | Example | Meaning | +|---------------|----------|-----------------------------------------------| +| `source` | `portal` | Where the count came from (the docs button) | +| `driver` | `jdbc` | Which driver family (`jdbc` or `adbc`) | +| `version` | `0.1.4` | The published artifact version | +| `count_delta` | `1` | One download | + +A timestamp is added on the server. That is the **entire** record. + +## What is NOT collected + +- **No IP address.** The endpoint never reads the remote address or any `X-Forwarded-For` / `Forwarded` + header, and never stores one. The privacy guarantee is enforced by the database schema itself — the + table has no IP, user-agent, account, or instance column. +- **No user agent, no cookies, no fingerprint.** +- **No account or identity.** The endpoint requires no login and no API key; nothing links a download + to a person or organisation. + +## How it is used + +The aggregate counts power an internal adoption dashboard (downloads per day/week, broken down by +driver, version, and source). Downloads are also counted independently from the public artifact +registry (JFrog Artifactory), so the two figures cross-check each other. + +The download beacon is **fire-and-forget**: it is sent asynchronously and never blocks, delays, or +fails your download. If it cannot be sent, your download still proceeds normally. + +## Self-hosting + +These analytics describe the **website's** download buttons only. The SoftClient4ES client libraries, +JDBC/ADBC drivers, REPL, and Arrow Flight SQL server you run in your own infrastructure do **not** phone +home for download tracking.