PresentmentTelemetry

data class PresentmentTelemetry(val protocol: PresentmentProtocol, val engagementType: EngagementType? = null, val outcome: PresentmentOutcome, val warnings: List<TransportWarning> = emptyList(), val requesterInTrustList: Boolean? = null, val requestSizeBytes: Int? = null, val responseSizeBytes: Int? = null, val numRequestsServed: Int = 0, val numDocumentsPresented: Int = 0, val numNfcReTaps: Int = 0, val durationEngagementToConnected: Duration? = null, val durationConnectedToRequestReceived: Duration? = null, val durationUserConsentAndAuth: Duration? = null, val durationResponseGeneration: Duration? = null, val durationResponseTransmission: Duration? = null, val durationTotal: Duration? = null, val transportStats: MdocTransportStats? = null)

Anonymized, PII-free telemetry collected during a credential presentment session.

This data class deliberately excludes any personally identifiable information (such as credential identifiers, claim values, reader certificate subjects, origins, or session transcripts) so that it can be stored in org.multipaz.eventlogger.EventLogger and safely aggregated or transmitted to a wallet provider's telemetry server.

Constructors

Link copied to clipboard
constructor(protocol: PresentmentProtocol, engagementType: EngagementType? = null, outcome: PresentmentOutcome, warnings: List<TransportWarning> = emptyList(), requesterInTrustList: Boolean? = null, requestSizeBytes: Int? = null, responseSizeBytes: Int? = null, numRequestsServed: Int = 0, numDocumentsPresented: Int = 0, numNfcReTaps: Int = 0, durationEngagementToConnected: Duration? = null, durationConnectedToRequestReceived: Duration? = null, durationUserConsentAndAuth: Duration? = null, durationResponseGeneration: Duration? = null, durationResponseTransmission: Duration? = null, durationTotal: Duration? = null, transportStats: MdocTransportStats? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

time elapsed from transport connected state until the first request was received.

Link copied to clipboard

time elapsed from start of presentment until transport reached connected state.

Link copied to clipboard

time spent generating and signing the credential response.

Link copied to clipboard

time spent transmitting the response over the transport or HTTP endpoint.

Link copied to clipboard

total duration of the presentment session.

Link copied to clipboard

time spent obtaining user consent, unlocking keys, and performing face matching.

Link copied to clipboard

the engagement channel type for proximity presentment, if applicable.

Link copied to clipboard

total number of documents presented across all served requests.

Link copied to clipboard

number of NFC re-taps that occurred during the session.

Link copied to clipboard

number of requests served during the session.

Link copied to clipboard

the outcome of the presentment.

Link copied to clipboard

the presentment protocol used.

Link copied to clipboard

whether the requester was authenticated against a known trust list, or null if unauthenticated/not applicable.

Link copied to clipboard

size in bytes of the incoming request payload, if received.

Link copied to clipboard

size in bytes of the generated response payload, if generated.

Link copied to clipboard

underlying MdocTransportStats for proximity transports, if applicable.

Link copied to clipboard

structured warnings collected during presentment and transport execution.

Functions

Link copied to clipboard
Link copied to clipboard