Skip to content

Sessions 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

NameTypeFreqLabelsDescription
yb_idle_session_countgauge30ssession_typeNumber of idle database sessions
yb_idle_session_time_seconds_bucketcounter30sle, session_typeCumulative count of sessions idle for <= bucket thresholds
yb_idle_session_time_seconds_countcounter30ssession_typeTotal number of idle sessions (for histogram)
yb_idle_session_time_seconds_sumgauge30ssession_typeTotal sum of idle session times
yb_peak_session_memory_bytes_bucketcounter1mle, session_type, clusterCumulative count of sessions by peak memory usage (bytes)
yb_peak_session_memory_bytes_countcounter1msession_type, clusterTotal number of sessions contributing to peak memory usage
yb_peak_session_memory_bytes_sumgauge1msession_type, clusterTotal peak memory usage across all sessions (in bytes)
yb_session_countgauge30ssession_type, clusterNumber of open database sessions