Docs/Concepts/Metrics

Metrics

In short

The SDK reports aggregate, privacy-preserving counters to the license backend. The counters carry no location data: no coordinates, no region ids, no proof contents. Disable them with OctetConfig.telemetryEnabled = false.

What the SDK reports

When telemetryEnabled is on (the default), the SDK reports counters to {activationServerUrl}/v1/metrics, indexed by your license: how many proofs were generated, uploaded, or could not be produced, by coarse level and region type. The counters are buffered in an encrypted file in the app's private storage and uploaded at most once a day, plus a best-effort flush when the app enters the background.

The counters carry no location data. No coordinates, no region ids, no proof contents leave the device in a metrics report.

What is and is not collected

Sent Not sent
Counts of proofs generated / uploaded / not produced, by coarse level and region type Coordinates, region ids, or proof contents
SDK version, platform, OS version, app id Any identifier that resolves to a person
A pseudonymous deviceKey (a one-way HMAC of the install UUID) The install UUID itself

Turning it off

Set OctetConfig.telemetryEnabled = false. That disables the metrics upload and deletes any buffered report.

Where to go next