diff --git a/documentation/client/README.md b/documentation/client/README.md index 74429921..3e8339a6 100644 --- a/documentation/client/README.md +++ b/documentation/client/README.md @@ -24,4 +24,5 @@ Welcome to the Client Engine Documentation. Navigate through the sections below: - [Arrow Flight SQL](arrow_flight_sql.md) - [ADBC Driver](adbc_driver.md) - [Telemetry & Privacy](telemetry.md) +- [Download Analytics](download_analytics.md) - [Federation Operator Guide](federation_operator_guide.md) diff --git a/documentation/sql/telemetry.md b/documentation/client/download_analytics.md similarity index 82% rename from documentation/sql/telemetry.md rename to documentation/client/download_analytics.md index 8f91b595..8b20bb08 100644 --- a/documentation/sql/telemetry.md +++ b/documentation/client/download_analytics.md @@ -1,11 +1,10 @@ -# Telemetry & Privacy +# Download Analytics 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. +the **download analytics** specifically — the small beacon sent when you click a Download button on the +website. For the complete, surface-by-surface product-telemetry overview (what the JDBC/ADBC drivers, the +REPL, and the Arrow Flight SQL / federation servers send, and how to opt out), see +[Telemetry & Privacy](telemetry.md). ## What is collected @@ -16,7 +15,7 @@ beacon to a public endpoint with exactly these fields: |---------------|----------|-----------------------------------------------| | `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 | +| `version` | `0.2.0` | The published artifact version | | `count_delta` | `1` | One download | A timestamp is added on the server. That is the **entire** record. diff --git a/documentation/client/telemetry.md b/documentation/client/telemetry.md index 41d64631..9e6117d3 100644 --- a/documentation/client/telemetry.md +++ b/documentation/client/telemetry.md @@ -116,7 +116,7 @@ softclient4es.telemetry.enabled = false -Dsoftclient4es.telemetry.enabled=false ``` -> A dedicated driver property (JDBC URL `?telemetry=false`) or ADBC connection option may also be offered — when available it will be documented here. Until then, use the HOCON / `-D` form above for the drivers. +> The JDBC driver also accepts `?telemetry=false` directly on the JDBC URL. The ADBC driver has no equivalent connection option — use the HOCON / `-D` form above. ## What happens when you opt out @@ -134,7 +134,7 @@ Nothing else changes. With telemetry disabled: ## Why we collect this -- **Measure the R1 launch** — did people actually adopt SoftClient4ES? +- **Measure the launch of this release** — did people actually adopt SoftClient4ES? - **Prioritise the right features** — which surfaces and capabilities get used most. - **Understand the mix** — how many JDBC vs. ADBC vs. sidecar vs. federation vs. REPL deployments exist, so we invest where it matters. diff --git a/documentation/sql/README.md b/documentation/sql/README.md index 600d027a..418a3f0e 100644 --- a/documentation/sql/README.md +++ b/documentation/sql/README.md @@ -20,5 +20,5 @@ Welcome to the SQL Engine Documentation. Navigate through the sections below: - [Cross-Index JOIN](joins.md) - [Materialized Views](materialized_views.md) - [Telemetry & Privacy](../client/telemetry.md) -- [Telemetry & Privacy](telemetry.md) +- [Download Analytics](../client/download_analytics.md) - [Federation Operator Guide](../client/federation_operator_guide.md)