Telemetria do SDK
A partir da v0.5.3 o SDK Guardian pode enviar à Surt eventos de diagnóstico sobre o seu próprio comportamento: quanto tempo cada fase de uma chamada levou, erros internos e falhas de atestação. A Surt os usa para detectar regressões de latência e de falhas por modelo de dispositivo e versão do SO. A telemetria fica desativada por padrão e não exige mudanças de código no seu app.
Eventos
| Evento | Enviado | Conteúdo |
|---|---|---|
sdk_timing | após cada verify() e collect() | fluxo (verify ou collect), resultado (succeeded ou failed), milissegundos por fase (collection, permission, attestation, client_ip, network_intel, total) e o tempo da requisição em verify() ou o tempo de criptografia em collect() |
sdk_error | quando uma chamada falha dentro do SDK | a mensagem de erro, a operação que falhou e até dez linhas da pilha de chamadas |
attestation_failure | quando o App Attest ou o Play Integrity não produz um token | o motivo da falha |
Cada evento também carrega a versão do SDK, a plataforma (ios ou android), o modelo do dispositivo (por exemplo iPhone15,2 ou Google Pixel 8), a versão do SO, o nível de API do Android, o ID de sessão da chamada e um timestamp.
O que não é enviado
- Nenhum ID, nome ou e-mail de cliente. A Surt associa o evento à sua organização e à sessão por meio do JWT.
- Nenhum nome de dispositivo definido pelo usuário. O modelo é o identificador de hardware.
- Nenhum dado da transação, localização ou qualquer outro campo do payload de verificação.
Como é habilitada
A Surt habilita a telemetria por organização. Entre em contato com a Surt para ativá-la ou desativá-la na sua organização. Não existe nenhuma opção em GuardianOptions.
Quando está habilitada:
- O JWT que o seu backend recebe do endpoint de preflight carrega a configuração de telemetria. A Surt pode aplicar amostragem, então a configuração pode variar entre sessões.
- O SDK lê a configuração uma vez no início de cada chamada a
verify()oucollect(). - Se a configuração estiver desativada, ou a chamada não tiver JWT, o SDK não envia nada.
Efeito no seu app
- Os eventos são enviados em uma thread em segundo plano depois que o seu callback ou promise foi concluído. Eles não adicionam latência ao resultado.
- Cada evento é uma única requisição, sem novas tentativas. Um envio que falha é descartado e registrado no nível de depuração.
- Uma falha de telemetria não altera o resultado de
verify()nem decollect(). - Os eventos têm no máximo alguns kilobytes.
Ler os mesmos tempos localmente
As durações por fase de sdk_timing são os valores retornados em diagnostics.timings em cada resultado de verify() e collect(), no Android a partir da v0.5.2 e no iOS a partir da v0.5.3. Veja Diagnósticos do resultado.