SDK-Telemetrie
Ab v0.5.3 kann das Guardian SDK Diagnoseereignisse über sein eigenes Verhalten an Surt senden: wie lange jede Phase eines Aufrufs gedauert hat, interne Fehler und fehlgeschlagene Attestierungen. Surt nutzt sie, um Latenz- und Absturzregressionen pro Gerätemodell und Betriebssystemversion zu erkennen. Die Telemetrie ist standardmäßig deaktiviert und erfordert keine Codeänderung in deiner App.
Ereignisse
| Ereignis | Gesendet | Inhalt |
|---|---|---|
sdk_timing | nach jedem verify() und collect() | Ablauf (verify oder collect), Ergebnis (succeeded oder failed), Millisekunden pro Phase (collection, permission, attestation, client_ip, network_intel, total) sowie die Anfragezeit bei verify() oder die Verschlüsselungszeit bei collect() |
sdk_error | wenn ein Aufruf innerhalb des SDK fehlschlägt | die Fehlermeldung, die fehlgeschlagene Operation und bis zu zehn Stack-Frames |
attestation_failure | wenn App Attest oder Play Integrity kein Token liefert | der Grund des Fehlers |
Jedes Ereignis enthält außerdem die SDK-Version, die Plattform (ios oder android), das Gerätemodell (zum Beispiel iPhone15,2 oder Google Pixel 8), die Betriebssystemversion, das Android-API-Level, die Sitzungs-ID des Aufrufs und einen Zeitstempel.
Was nicht gesendet wird
- Keine Kunden-ID, kein Name, keine E-Mail-Adresse. Surt ordnet das Ereignis über das JWT deiner Organisation und der Sitzung zu.
- Kein vom Nutzer vergebener Gerätename. Das Modell ist die Hardware-Kennung.
- Keine Transaktionsdaten, kein Standort und kein anderes Feld der Verifizierungs-Payload.
Aktivierung
Surt aktiviert die Telemetrie pro Organisation. Wende dich an Surt, um sie für deine Organisation ein- oder auszuschalten. In GuardianOptions gibt es keine Einstellung dafür.
Wenn sie aktiviert ist:
- Das JWT, das dein Backend vom Preflight-Endpunkt erhält, enthält die Telemetrie-Einstellung. Surt kann stichprobenartig vorgehen, daher kann die Einstellung zwischen Sitzungen variieren.
- Das SDK liest die Einstellung einmal zu Beginn jedes
verify()- odercollect()-Aufrufs. - Ist die Einstellung aus oder hat der Aufruf kein JWT, sendet das SDK nichts.
Auswirkungen auf deine App
- Ereignisse werden in einem Hintergrund-Thread gesendet, nachdem dein Callback oder Promise abgeschlossen ist. Sie verlängern die Antwortzeit nicht.
- Jedes Ereignis ist eine einzelne Anfrage ohne Wiederholungsversuche. Ein fehlgeschlagener Versand wird verworfen und auf Debug-Ebene protokolliert.
- Ein Telemetriefehler ändert das Ergebnis von
verify()odercollect()nicht. - Ereignisse sind höchstens wenige Kilobyte groß.
Dieselben Zeiten lokal lesen
Die Phasendauern in sdk_timing sind die Werte, die diagnostics.timings in jedem Ergebnis von verify() und collect() zurückgibt, unter Android ab v0.5.2 und unter iOS ab v0.5.3. Siehe Ergebnis-Diagnose.