Skip to content

Session Metrics

This page documents Prometheus metrics related to database session activity in Yellowbrick. These metrics provide insight into the number of active and idle sessions, as well as session-level memory consumption over time.

Purpose

Session metrics help operators and developers:

  • Monitor how many sessions are active or idle across the system
  • Identify long-idle sessions that may need to be closed (e.g. for resource hygiene)
  • Analyze memory usage trends across sessions, including per-cluster patterns
  • Tune connection pool behavior, session limits, or auto-idle disconnect logic

These metrics are critical for capacity planning, managing concurrency, and detecting orphaned client connections or resource exhaustion caused by excessive memory use.

Metrics

NameTypeFreqLabelsVersion IntroducedVersion DeprecatedDescription
yb_idle_session_countgauge30ssession_type7.3.0-Number of idle database sessions
yb_idle_session_time_seconds_bucketcounter30sle, session_type7.3.0-Cumulative count of sessions idle for <= bucket thresholds
yb_idle_session_time_seconds_countcounter30ssession_type7.3.0-Total number of idle sessions (for histogram)
yb_idle_session_time_seconds_sumgauge30ssession_type7.3.0-Total sum of idle session times
yb_peak_session_memory_bytes_bucketcounter1mle, session_type, cluster, cluster_name7.3.0-Cumulative count of sessions by peak memory usage (bytes)
yb_peak_session_memory_bytes_countcounter1msession_type, cluster, cluster_name7.3.0-Total number of sessions contributing to peak memory usage
yb_peak_session_memory_bytes_sumgauge1msession_type, cluster, cluster_name7.3.0-Total peak memory usage across all sessions (in bytes)
yb_session_countgauge30ssession_type, cluster, cluster_name7.3.0-Number of open database sessions