Available metrics
Custom Cobrowse metrics are available via OpenMetrics endpoints and include counters, gauges and summaries.
Some of the custom Cobrowse instance metrics we provide via our OpenMetrics endpoints are:
Metric Name | Metric Type | Description |
---|---|---|
cobrowse_device_registrations_total | Counter | Count of devices registered |
cobrowse_presence_queue_delay_seconds | Gauge | Current wait time for presence queue processing (should be close to 0 most of the time) |
cobrowse_presence_queue_length_count | Gauge | Current number of sockets waiting in the presence system processing queue (should be close to 0 most of the time) |
cobrowse_session_created_total | Counter | Count of sessions created |
cobrowse_session_duration_seconds | Summary | Duration of sessions |
cobrowse_session_unused_total | Counter | Count of sessions that were created but then never activated |
cobrowse_websocket_byte_in_total | Counter | Count of WebSocket bytes received |
cobrowse_websocket_connection_duration_seconds | Summary | Duration of WebSocket connection |
cobrowse_websocket_connection_end_total | Counter | Count of WebSocket connections ended |
cobrowse_websocket_connection_start_total | Counter | Count of WebSocket connections started |
cobrowse_websocket_connections_count | Gauge | Current number of open WebSocket connections |
cobrowse_websocket_message_in_total | Counter | Count of WebSocket messages received |
cobrowse_websocket_message_size_bytes | Summary | Size of WebSocket message |
cobrowse_limits_members_used_count | Gauge | Count of used members |
cobrowse_limits_members_remaining_count | Gauge | Count of remaining members |
cobrowse_limits_members_daily_used_count | Gauge | Count of used daily members |
cobrowse_limits_members_daily_remaining_count | Gauge | Count of remaining daily members |
cobrowse_limits_sessions_used_count | Gauge | Count of used sessions |
cobrowse_limits_sessions_remaining_count | Gauge | Count of remaining sessions |
cobrowse_limits_session_concurrency_used_count | Gauge | Count of used concurrent sessions |
cobrowse_limits_session_concurrency_remaining_count | Gauge | Count of remaining concurrent sessions |
Many of these will depend on the behaviour of your deployment and use case, so we do not provide specific ranges thresholds to monitor by default. You should monitor and decide what the appropriate limits are for your deployment.
As well as these custom metrics, the prometheus client also collects some generic system metrics and NodeJS specific metrics, see below for more information:
Last updated