The StackRox system health dashboard provides a single interface for viewing information about the StackRox Kubernetes Security Platform components to help users assess their health.
Health dashboard is only available on the StackRox Kubernetes Security Platform version 3.0.53 and newer.
To access the health dashboard:
- On the StackRox Portal, select Platform Configuration > System Health.
The health dashboard organizes information in the following 5 groups:
- Cluster Health - Showcases the overall state of the StackRox cluster.
- Vulnerability Definitions - Showcases the last update time of vulnerability definitions.
- Image Integrations - Showcases the health of all registries that you’ve integrated.
- Notifier Integrations - Showcases the health of any notifiers (Slack, email, Jira, and others) you’ve integrated.
- Backup Integrations - Showcases the health of any backup providers you’ve integrated.
The dashboard lists the following states for different components:
- Healthy - The component is functional.
- Degraded - The component is partially unhealthy. This state means the cluster is functional, but some components are unhealthy and require attention.
- Unhealthy - This component isn’t healthy and requires immediate attention.
- Uninitialized - The component hasn’t yet reported back to Central to have its health assessed. An uninitialized state may sometimes require attention, but often components report back the health status after a while or when the integration is used.
The Cluster Overview shows information about your StackRox Kubernetes Security Platform cluster health. It reports the health information about the following:
- Collector Status - It shows whether the Collector pod, which the StackRox Kubernetes Security Platform is using is reporting healthy.
- Sensor Status - It shows whether the Sensor pod, which the StackRox Kubernetes Security Platform is using is reporting healthy.
- Sensor Upgrade - It shows whether the Sensor is running the correct version when compared with Central.
- Credential Expiration - It shows if the credentials for the StackRox Kubernetes Security Platform are nearing expiration.
Clusters in the
Uninitialized state aren’t reported in the number of clusters
secured by the StackRox Kubernetes Security Platform until they check in.
The Vulnerabilities Definition section shows the last time vulnerability definitions were updated and if the definitions are up to date.
There are 3 integration sections Image Integrations, Notifier Integrations, and Backup Integrations. Similar to the Cluster Health section, these sections list the number of unhealthy integrations if any exist. Otherwise, all integrations report as healthy.
The Integrations section lists the healthy integrations as
0 if any of the
following conditions are met:
- You haven’t integrated the StackRox Kubernetes Security Platform with any third-party tools, or
- You have integrated with some tools, but disabled the integrations, or haven’t set up any policy violations.
You can also generate a diagnostic bundle from the health dashboard. See the Generate a diagnostic bundle topic for more information.
We're happy to help! Reach out to us to discuss questions, issues, or feature requests.