Definitions
Status page
defineStatusPage chooses what the public /status page shows, from your monitors and alerts.
definitions/status.ts
import { defineStatusPage } from 'vigie/sdk'
import { failedPayments } from './alerts/acme.ts'
import { api, shop } from './monitors/acme.ts'
export const status = defineStatusPage({
title: 'Acme status',
description: 'The Acme shop, its API and payments.',
public: true,
components: [
{ name: 'Shop', from: shop },
{ name: 'API', from: api },
{ name: 'Payments', from: failedPayments, group: 'Integrations' },
],
days: 90,
})
A component is a monitor or an alert, so anything an alert watches can be on the page: an error rate, failed tasks, a queue. Only what is listed shows, in this order, under the names visitors read. Outages of anything else stay off the page.
| Field | What it does |
|---|---|
components | { name, from, group? }. from is a monitor or alert from your definitions, or 'monitor:<id>' / 'alert:<id>' for one made in the app. |
public | Anyone with the link can open it. Leave it out to decide in the app. |
days | 30, 60 or 90 days of history. |
show | Turn sections off: active, history, uptime, past. |
When this file exists, it takes over: the Status page screen shows it read-only. Incidents and their updates stay runtime data, written on that screen or by an agent. See Status page.