Session metrics

Monitor session metrics in realtime to understand session quality.

Whilst in an active Cobrowse session there may be external factors that affect the quality of the session. Most notably varying network connectivity. Session metrics can be used to notify the user of the poor connection allowing for them to make adjustments to improve the connection.

The available metrics are:

Metric	Description
Latency	Round-trip time taken to respond to a ping from the device to the server.
Last alive	The timestamp when the device last successfully pinged the server.

With these it is possible to understand when the device last successfully responded and how long that message took to be acknowledged.

A latencey of 200ms or below is a good connection.

Web

CobrowseIO.on('session.metrics.updated', session => {
    console.log('Latency:', session.metrics.latency)
    console.log('Last alive:', session.metrics.last_alive)
});

iOS

class CobrowseSession: NSObject, CobrowseIODelegate {
    func cobrowseSessionMetricsDidUpdate(_ session: CBIOSession) {
        let metrics = session.metrics()
        
        print("Latency:", metrics.latency())
        print("Last alive:", metrics.lastAlive())
    }
}

Android

class CobrowseSession : CobrowseIO.SessionMetricsDelegate {
    override fun sessionMetricsDidUpdate(session: Session) {
        val metrics: Session.Metrics = session.metrics()
        
        println("Latency: ${metrics.latency()}")
        println("Last alive: ${metrics.lastAlive()}")
    }
}