Product Documentation

Appearance

EE: All appliance platforms

System Metrics ​

This page documents Prometheus metrics that reflect the overall uptime and availability status of key Yellowbrick system components, including the Lime service and the platform as a whole.

Purpose ​

System-level metrics are essential for tracking service health, restart behavior, and uptime baselines. Specifically, they help:

  • Monitor whether the system is currently marked as “up” or “down”
  • Track the total uptime duration of services (e.g., Lime/Cluster Manager)
  • Detect unexpected restarts or prolonged downtimes

Metrics ​

NameTypeFreqLabelsVersion IntroducedVersion DeprecatedDescription
yb_guc_setting_infogauge1dname, value, source7.4.5-Non-default system-level Postgres configuration settings (GUCs), for support/escalation diagnosis. Only settings changed via postgresql.conf, an environment variable, or a command-line flag are shown; per-session/per-role overrides and unchanged defaults are excluded. String-valued settings are shown only if explicitly reviewed as non-sensitive -- every other string setting, including any not yet reviewed, reports value="[redacted]" instead of its real value. The sampled value is always 1.
yb_lime_uptime_totalcounter10s-7.4.0-Uptime of lime service in seconds
yb_role_countgauge1mrole_type7.4.5-Number of Postgres roles defined in the system, split into YB-provided (system) and user-created (user) roles.
yb_system_is_upgauge1m-7.4.0-Is the system up and running
yb_system_uptime_secondsgauge1m-7.4.0-YB system uptime in seconds
yb_system_versiongauge1mversion7.4.0-The current version (seen on the version label) of the Yellowbrick system. The sampled value will always be 1.
yb_ts_active_wlm_profile_infogauge5mcluster, cluster_name, active_wlm_profile_name7.4.5-The currently active wlm profile for a cluster
yb_ts_backup_chain_age_maxgauge5mdatabase_oid7.4.4-YB oldest backup chain per database
yb_ts_cluster_hw_type_infogauge5mcluster, cluster_name, hardware_instance_name7.4.5-The hw type for a cluster
yb_ts_cluster_region_infogauge5mcluster, cluster_name, cloud_region7.4.5-The cloud region of the cluster
yb_ts_default_wlm_profile_infogauge5mcluster, cluster_name, default_wlm_profile_name7.4.5-The default wlm profile for a cluster
yb_ts_max_spill_pctgauge5mcluster, cluster_name, active_wlm_profile_name, default_wlm_profile_name, hardware_instance_name, cloud_region, provider_name7.4.5-Percentage of blade disk space allocated for spill
yb_ts_provider_hw_type_infogauge5mcluster, cluster_name, provider_name7.4.5-The underlying instance type used on the cloud provider
yb_ts_snapshot_age_maxgauge5mdatabase_oid7.4.4-YB oldest snapshot per database
yb_ts_sys_index_sizegauge5mtable_name7.4.4-Size in bytes of the indexes on each sys table
yb_ts_sys_table_sizegauge5mtable_name7.4.4-Size in bytes of each sys table
yb_ts_sys_total_sizegauge5mtable_name7.4.4-Size in bytes of each sys table including indexes