https://github.com/getsentry/status-page-list
JS Library for list of public status pages
https://github.com/getsentry/status-page-list
tag-production
Last synced: 7 months ago
JSON representation
JS Library for list of public status pages
- Host: GitHub
- URL: https://github.com/getsentry/status-page-list
- Owner: getsentry
- License: mit
- Created: 2024-04-08T21:07:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-03T17:06:16.000Z (7 months ago)
- Last Synced: 2025-03-22T06:47:11.246Z (7 months ago)
- Topics: tag-production
- Language: TypeScript
- Homepage:
- Size: 270 KB
- Stars: 10
- Watchers: 29
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Status Page List
[](https://www.npmjs.com/package/@sentry/status-page-list)
This page is a list of public status pages for various cloud services exposed as a JavaScript library.
Big thank you to [Awesome status pages](https://github.com/ivbeg/awesome-status-pages) and it's creator [Ivan Begtin](https://github.com/ivbeg) for helping provide the initial list of status pages.
If you know of a status page that is not listed here, please open an issue or a pull request. Please also make sure to update [Awesome status pages](https://github.com/ivbeg/awesome-status-pages) as well!
## Usage
To access status page info, you can import a `xxxStatusInfo` import from `@sentry/status-page-list`.
```js
import { sentryStatusInfo } from "@sentry/status-page-list";
const {
// Sentry
name,
// ["sentry.io", "*.sentry.io"]
domains,
// "https://status.sentry.io/"
statusPageUrl,
// false
isServiceDefunct,
} = sentryStatusInfo;
```
### domainToStatusPageUrls
If you want to map a domain (like `sentry.io`) to it's status page, you can use the `domainToStatusPageUrls` exported object.
```js
import { domainToStatusPageUrls } from "@sentry/status-page-list";
const sentryStatusPageLink = domainToStatusPageUrls["sentry.io"];
// also accepts glob URLs
const sentryStatusPageLink = domainToStatusPageUrls["*.sentry.io"];
```
Since `domainToStatusPageUrls` can get large, we recommend lazy loading it with `await import` or similar.
## Contributing
This project requires yarn v1 and Node.js v20 or higher to run. We recommend configuring your Node version with [Volta](https://volta.sh/).
New status page entries can be added by adding a new entry to `src/data` folder. You can use the `yarn generate:data` CLI helper to add entries via the command line. You can look at the [Sentry entry](./src/data/sentry.ts) as an example.
After adding a new status entry run `yarn generate` to update the codegen files.