Console Status
The Console Status page shows the health of the Console backend and its connections to the platform and external services. Each check includes a status and supporting details. While the Console Status page is open, Console refreshes the status approximately every two seconds. Each refresh runs the health checks again, so updates may take longer when a service responds slowly.
For more information about the operations used to generate these status checks, see the Console Status Queries reference guide.
System Status
System Status summarizes all applicable checks on the page.
| Status | Description |
|---|---|
| Healthy | All applicable checks passed. |
| Degraded | One or more checks failed, but at least one check passed. |
| Unhealthy | All applicable checks failed. |
Summary
| Name | Description |
|---|---|
| Total Checks | Total number of applicable health checks. |
| Healthy | Number of checks that passed. |
| Unhealthy | Number of checks that failed. |
| Platform Version | Version of the SmoothGlue Platform. Displays Unknown when version information is unavailable. |
Infrastructure
Infrastructure checks show whether Console can connect to its database and the Kubernetes API.
| Name | Description |
|---|---|
| Database | Verifies the database connection. |
| Detail | Description |
|---|---|
database | Database engine configured for Console. |
| Name | Description |
|---|---|
| Kubernetes | Verifies that Console can load its Kubernetes configuration and reach the Kubernetes API server. |
| Detail | Description |
|---|---|
config_loaded | true when the Kubernetes configuration loaded successfully. |
api_reachable | true when Console can reach the Kubernetes API server. |
Custom Resource Definitions (XRDs)
These checks verify that the Kubernetes resource definitions required by enabled Console features are present in the cluster.
| Name | Resource Definition | Checked When |
|---|---|---|
| Deployments | deployments.smoothglue.io | Deployments are enabled. |
| DataMesh | xdatameshes.smoothglue.io | Data Mesh is enabled. |
| Origins | xpublications.cdc.datamesh.smoothglue.io | Data Mesh is enabled. |
| Destinations | xsubscriptions.cdc.datamesh.smoothglue.io | Data Mesh is enabled. |
| Detail | Description |
|---|---|
xrd_name | Internal name of the resource definition check. |
enabled | Whether the feature that requires the resource definition is enabled. |
present | Whether the resource definition is present in the cluster. |
crd_name | Full Kubernetes name of the resource definition. |
Disabled features may be displayed as N/A
External Services
External service checks verify that enabled integrations are configured and reachable. Authentication is also verified.
| Service | What the Check Verifies | Availability |
|---|---|---|
| Keycloak | Console can connect to Keycloak, obtain an access token, and use the token. | Required |
| GitLab | Console can connect to the GitLab API using its configured access token. | Checked when GitLab is enabled. |
| Jira | Console can connect to the Jira API using its configured access token. | Checked when Jira is enabled. |
| Mattermost | Console can connect to the Mattermost API using its configured access token. | Checked when Mattermost is enabled. |
| Prometheus | Console can connect to Prometheus and run a query. | Checked when Data Mesh metrics are enabled. |
Shared Detail Fields
| Detail | Applies To | Description |
|---|---|---|
enabled | GitLab, Jira, Mattermost, and Prometheus | Whether the optional integration or related feature is enabled. |
configured | All services | Whether the required service settings and credentials are configured. |
authenticated | Keycloak, GitLab, Jira, and Mattermost | Whether Console successfully authenticated. This may be absent if authentication was not attempted. |
Service-Specific Details
| Service | Details | Description |
|---|---|---|
| Keycloak | base_url, realm | Keycloak server address and the realm used by Console. |
| GitLab | base_url, version | GitLab server address and reported version. |
| Jira | base_url, version | Jira server address and reported version. |
| Mattermost | base_url, version | Mattermost server address and reported version. |
| Prometheus | url | Prometheus endpoint used for the connectivity test query. |
The displayed fields depend on the service's status. Disabled checks may display
only enabled: false, while failed checks can include the error fields described below.
Failed Checks
When a check fails, its message describes the failure and its details can include the following fields:
| Detail | Description |
|---|---|
error_type | Type of error that caused the check to fail. |
error_message | Detailed error returned by the check. |