Interface: UsageMetrics
@roomful/core / UsageMetrics
Interface: UsageMetrics
Section titled “Interface: UsageMetrics”Defined in: packages/core/src/types.ts:464
Cumulative usage metrics for a room session, for feeding telemetry/analytics. Unlike RoomDiagnostics (a point-in-time snapshot), these counters accumulate over the room’s lifetime and do not reset on reconnect.
Properties
Section titled “Properties”broadcastsSent
Section titled “broadcastsSent”broadcastsSent:
number
Defined in: packages/core/src/types.ts:481
Custom events sent as a room-wide broadcast.
connectCount
Section titled “connectCount”connectCount:
number
Defined in: packages/core/src/types.ts:466
How many times the room reached the connected state (each is a session).
directSends
Section titled “directSends”directSends:
number
Defined in: packages/core/src/types.ts:484
Custom events sent directly to a single peer.
messagesReceived
Section titled “messagesReceived”messagesReceived:
number
Defined in: packages/core/src/types.ts:478
Custom events received by the local peer.
messagesSent
Section titled “messagesSent”messagesSent:
number
Defined in: packages/core/src/types.ts:475
Custom events sent by the local peer.
peakRemotePeerCount
Section titled “peakRemotePeerCount”peakRemotePeerCount:
number
Defined in: packages/core/src/types.ts:472
The most remote peers seen in the room at once.
reconnectCount
Section titled “reconnectCount”reconnectCount:
number
Defined in: packages/core/src/types.ts:469
How many reconnect attempts have been made across the room’s lifetime.