Cobrowse.io Docs
  • Getting started
  • SDK Installation
    • Web
    • iOS
    • Android
    • React Native
    • Flutter
    • .NET Mobile
    • macOS
    • Windows
  • SDK Features
    • Account config
    • Identify your devices
    • Use 6-digit codes
    • Redact sensitive data
    • Viewing PDFs
    • Universal Cobrowse
    • Customize the interface
      • Active session controls
      • 6-digit code screen
      • User consent dialog
      • Remote control consent dialog
      • Full device consent dialog
      • Localization / translation
    • Initiate sessions with push
    • Listening for events
    • Full device capabilities
      • Full device screen sharing
      • Full device remote control
      • Managing full device mode
    • Advanced configuration
      • Starting and stopping the SDK
      • Declaring capabilities
      • Intercepting mobile SDK network requests
      • Web
        • IFrames support
        • IE 11 polyfills
        • Cross-domain session support
        • Ignore Views
      • iOS
        • Alternate render method
        • Custom touch handling
      • Android
        • Backporting TLS to older Android versions
  • Agent-side integrations
    • Agent-side overview
    • Platform integrations
      • Zendesk
      • Salesforce
        • Migrating from legacy to v2
        • Salesforce (Legacy)
      • Genesys
        • Genesys Cloud
        • Engage Workspace Web Edition (WWE)
        • Engage Workspace Desktop Edition (WDE)
      • Intercom
      • Freshworks
      • Talkdesk
      • NICE
    • Custom integrations
    • Agent SDK
      • API Reference
      • Sample code snippets
    • Authentication (JWTs)
      • JWT Policies
    • Authentication (SAML 2.0)
    • IFrame embeds
  • Enterprise self-hosting
    • Self-hosting overview
    • Docker Compose
    • Helm chart
      • Image Pull Secret
      • Environment Variables
      • Optional recording components
      • Pod Annotations
    • AWS terraform
      • AWS metrics configuration
    • Azure terraform
      • Azure metrics configuration
    • GCP terraform
      • GCP metrics configuration
    • Sizing guidelines
    • Running your instance
      • Adding a superuser
      • Limiting account creation
      • Limiting magic link recipients
      • Configuring SMTP
      • Managing your deployment
    • Monitoring your instance
      • Available metrics
      • Self-Hosted Prometheus
    • Advanced configuration
      • Air gap configuration
      • Pin web SDK version
      • L7 firewall configuration
      • Docker proxy configuration
    • Troubleshooting
Powered by GitBook
On this page

Was this helpful?

  1. Enterprise self-hosting
  2. Monitoring your instance

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:

PreviousMonitoring your instanceNextSelf-Hosted Prometheus

Last updated 1 year ago

Was this helpful?

Writing client libraries | Prometheus
prom-client/lib/metrics at master · siimon/prom-clientGitHub
Logo
Logo