Telemetry
Spice collects anonymous telemetry data to help improve the product. Usage telemetry is anonymous and aggregated.
Data Collected​
The following anonymous information is collected:
- The version of Spice being used (i.e.
v1.0.0) - An anonymous identifier for the Spice instance, computed as
sha256(hostname + spicepod.name). - An anonymous identifier for the Spicepod, computed as
sha256(spicepod.name).- The code to calculate these identifiers is here: https://github.com/spiceai/spiceai/blob/trunk/crates/telemetry/src/anonymous.rs#L65
- Various metrics related to usage of features of the runtime, see the full list here: https://github.com/spiceai/spiceai/blob/trunk/crates/telemetry/src/lib.rs#L32
Data collected is sent to https://telemetry.spiceai.org once every hour.
Disabling Telemetry​
In Spice.ai Open Source builds that include the anonymous_telemetry feature (the default), setting runtime.telemetry.enabled: false in a Spicepod or passing --telemetry-enabled=false does not disable anonymous usage telemetry. The runtime will log a warning when these settings are detected but are not applied.
To fully remove anonymous telemetry from an Open Source build, compile from source without the anonymous_telemetry feature (option 3 below), or use Spice.ai Enterprise.
Telemetry can be disabled in the following ways:
-
Spice.ai Enterprise: Anonymous telemetry respects the
runtime.telemetry.enabledand--telemetry-enabledsettings. -
Compile without the
anonymous_telemetryfeature (Open Source):
cargo build --release --no-default-features --features "<other_default_features>"
i.e.
cargo build --release --no-default-features --features "duckdb,postgres,sqlite,mysql,flightsql,delta_lake,databricks,dremio,clickhouse,spark,snowflake,ftp,debezium"
Configuration Settings (Enterprise only)​
The following settings disable telemetry in Spice.ai Enterprise builds:
Running the Spice runtime with the CLI flag --telemetry-enabled false:
spice run -- --telemetry-enabled false
or
spiced --telemetry-enabled false
Adding the following configuration to the Spicepod configuration file (spicepod.yaml):
runtime:
telemetry:
enabled: false
