readyset-telemetry-reporter/README.md
This crate provides the telemetry reporting capability for Readyset applications. It implements the Segment HTTP Tracking API. More details can be found here.
Applications using this crate support disabling telemetry with the --disable-telemetry command-line flag.
They can also be configured by setting the following environment variables:
| Environment Variable | Default | Description |
|---|---|---|
RS_API_KEY | "" | Provided by the Readyset console. Used to associate telemetry with users. If omitted, telemetry will attempt to generate an anonymous (i.e. hashed with blake2b) uuid based on the machine it is running on. |
RS_SEGMENT_WRITE_KEY | Readyset write key | Identifies a Segment source. By default, telemetry is reported to the Readyset, Inc. Segment account. Users can receive telemetry from their Readyset deployment by providing their own write key. |
Use of the Unicode Character Database, as this crate does, is governed by the <a href="LICENSE-UNICODE">Unicode License Agreement – Data Files and Software (2016)</a>.