Custom Status Page¶
Status Page lets you publicly share the operational status of business services with customers or collaborators. You can associate services such as Payment API and Order Inquiry with SLOs to show service status and attainment rates, and use notes to publish incidents or maintenance updates. Visitors can view the page through its public URL without logging into the workspace. Each workspace can configure one Status Page.
Prerequisites¶
- Your account must have the Status Page configuration permission. This can be configured in Role Management.
- You have already created an SLO and have read permission for it. Both monitor and metric SLI types are supported. The associated SLO must be enabled and must not have grouping dimensions configured.
- To publish incident or maintenance records, prepare a public note in the current workspace and have read permission for notes.
Create and Publish a Page¶
- Go to Management > Status Page, create a page, and fill in the basic information. The time zone is used to interpret the business date of records and to define historical statistics dates. Select the time zone of the region the service serves.
- In the Services area, add business services to be publicly displayed and associate an SLO with each service. Multiple services can reuse the same SLO. Targets and detection rules are maintained under Monitoring > SLO.
- After Save Draft, preview the page. When the content is confirmed, click Publish Page to share the public URL.
At least one service with public display enabled and a valid associated SLO is required for publishing. Drafts are used to edit configuration, while the published page uses the most recently published configuration. After later changes to the page, services, or note associations, save the draft and Update Publish to apply the changes.
Publish Incident and Maintenance Records¶
Under Associated Notes, select a public note, set the business date, type, and affected services, enable public display, then save and publish.
Affected services can be left empty. Records with no affected services can be viewed on the history page by selecting All Services in the service filter. When a specific service is selected, only records associated with that service are shown.
Records with the type Maintenance make the associated service display a maintenance status for the business date. Incident and delayed records describe the course of events; the service status is still calculated from the SLO attainment rate.
How a record is updated depends on what you change:
- Title and body: Edit the source note directly. Published records read the latest content of the source note, and changes are publicly visible after saving.
- Date, type, affected services, or display status: Modify the association settings, then save the draft and update the publication.
- Remove a record: Disassociate the note, save, and publish. The source note is retained. If the source note is made private or deleted, the public page stops displaying the record.
Published records remain in history according to their business date. The affected service names in a record use the names at the time of publication.
Understand Service Status and Attainment Rate¶
The X-day SLO attainment rate uses the evaluation period configured in the associated SLO. For example, if the SLO is set to the last 30 days, the service displays the attainment rate for the last 30 days. Monitor type is calculated as the uptime percentage, while metric type is calculated as the ratio of successes to the total count.
The service status is determined by the attainment rate and the SLO target:
| Status | Description |
|---|---|
| Normal | The attainment rate reaches the target. |
| Delayed | The attainment rate reaches the minimum target but is below the target. |
| Abnormal | The attainment rate is below the minimum target. |
| Maintenance | A published maintenance record covers the service and the current business date. |
| Unknown | The associated source is invalid or no valid statistics are available. |
The 24-hour trend shows the status calculated at each point in time based on the SLO evaluation period. The 90-day trend records the period attainment rate as of the end of each day. Today shows the latest result. If no historical record exists, the page displays no valid samples. The metric type uses the most recent valid detection result; refer to the data update time when interpreting it.
For example, when an SLO with a 30-day period is associated, the value for a historical day represents the attainment rate for the last 30 days ending on that day.
Manage the Public Page¶
- Hide or delete a service: Modify, save, and publish the page. The service is removed from the public list. Before deleting a service referenced by a note, adjust the affected services in the note first.
- View historical versions: Use the version selector to view the configuration at the time of publication. Historical versions retain the configuration snapshot, while source information and note body still read the current content.
- Unpublish and republish: Select Unpublish in the Published menu. The original URL stops displaying business content. Configuration and historical versions are retained, and republishing reuses the original URL.