on-prem infra status
Go to file
Torma Kristóf d5d0ed3b42
Update deploy.yml
2023-09-23 11:26:39 +02:00
.gitbook/assets refactor: switch css framework to tailwind 2020-11-21 12:16:25 +01:00
.github Update deploy.yml 2023-09-23 11:26:39 +02:00
out init 2020-11-08 22:36:21 +01:00
pages chore: patch flareact to support script tags 2020-11-22 13:56:18 +01:00
public feat: collect response metrics from cron locations 2020-11-22 12:42:33 +01:00
src Replace all '-' for monitor name. 2022-02-15 22:08:15 +00:00
.cargo-ok init 2020-11-08 22:36:21 +01:00
.gitignore refactor: switch css framework to tailwind 2020-11-21 12:16:25 +01:00
.prettierignore feat: collect response metrics from cron locations 2020-11-22 12:42:33 +01:00
.prettierrc init 2020-11-08 22:36:21 +01:00
CODE_OF_CONDUCT.md feat: collect response metrics from cron locations 2020-11-22 12:42:33 +01:00
LICENSE Create LICENSE 2020-11-19 22:12:11 +01:00
README.md Added documentation 2021-07-23 09:19:34 +02:00
SUMMARY.md feat: collect response metrics from cron locations 2020-11-22 12:42:33 +01:00
config.yaml remove 2023-08-31 18:51:59 +02:00
flareact.config.js init 2020-11-08 22:36:21 +01:00
index.js refactor: switch css framework to tailwind 2020-11-21 12:16:25 +01:00
package.json chore(deps-dev): bump postcss from 8.2.10 to 8.2.13 2022-08-24 10:51:26 +01:00
postcss.config.js refactor: switch css framework to tailwind 2020-11-21 12:16:25 +01:00
tailwind.config.js refactor: switch css framework to tailwind 2020-11-21 12:16:25 +01:00
wrangler.toml reduce interval 2022-05-25 10:59:51 +02:00
yarn.lock chore(deps): bump nanoid from 3.1.23 to 3.3.4 2022-08-24 10:51:37 +01:00


Cloudflare Worker - Status Page

Monitor your websites, showcase status including daily history, and get Slack notification whenever your website status changes. Using Cloudflare Workers, CRON Triggers, and KV storage. Check my status page out! 🚀

Status Page

Slack notifications


You'll need a Cloudflare Workers account with

Also, prepare the following secrets

  • Cloudflare API token with Edit Cloudflare Workers permissions
  • Slack incoming webhook optional
  • Discord incoming webhook optional

Getting started

You can either deploy with Cloudflare Deploy Button using GitHub Actions or deploy on your own.

Deploy with Cloudflare Deploy Button

Deploy to Cloudflare Workers

  1. Click the button and follow the instructions, you should end up with a clone of this repository

  2. Navigate to your new GitHub repository > Settings > Secrets and add the following secrets:

    - Name: CF_API_TOKEN (should be added automatically)
    - Name: CF_ACCOUNT_ID (should be added automatically)
    - Name: SECRET_SLACK_WEBHOOK_URL (optional)
    - Value: your-slack-webhook-url
    - Name: SECRET_DISCORD_WEBHOOK_URL (optional)
    - Value: your-discord-webhook-url
  3. Navigate to the Actions settings in your repository and enable them

  4. Edit config.yaml to adjust configuration and list all of your websites/APIs you want to monitor

      title: 'Status Page'
      url: 'https://status-page.eidam.dev' # used for Slack & Discord messages
      logo: logo-192x192.png # image in ./public/ folder
      daysInHistogram: 90 # number of days you want to display in histogram
      collectResponseTimes: false # experimental feature, enable only for <5 monitors or on paid plans
      # configurable texts across the status page
      allmonitorsOperational: 'All Systems Operational'
      notAllmonitorsOperational: 'Not All Systems Operational'
      monitorLabelOperational: 'Operational'
      monitorLabelNotOperational: 'Not Operational'
      monitorLabelNoData: 'No data'
      dayInHistogramNoData: 'No data'
      dayInHistogramOperational: 'All good'
      dayInHistogramNotOperational: 'Some checks failed'
    # list of monitors
      - id: workers-cloudflare-com # unique identifier
        name: workers.cloudflare.com
        description: 'You write code. They handle the rest.' # default=empty
        url: 'https://workers.cloudflare.com/' # URL to fetch
        method: GET # default=GET
        expectStatus: 200 # operational status, default=200
        followRedirect: false # should fetch follow redirects, default=false
        linkable: false # should the titles be links to the service, default=true
  5. Push to main branch to trigger the deployment

  6. 🎉

  7. optional Go to Cloudflare Workers settings and assign custom domain/route

    • e.g. status-page.eidam.dev/* make sure you include `/*` as the Worker also serve static files
  8. optional Edit wrangler.toml to adjust Worker settings or CRON Trigger schedule, especially if you are on Workers Free plan

Telegram notifications

To enable telegram notifications, you'll need to take a few additional steps.

  1. Create a new Bot
  2. Set the api token you received when creating the bot as content of the SECRET_TELEGRAM_API_TOKEN secret in your github repository.
  3. Send a message to the bot from the telegram account which should receive the alerts (Something more than /start)
  4. Get the chat id with curl https://api.telegram.org/bot<YOUR TELEGRAM API TOKEN>/getUpdates | jq '.result[0] .message .chat .id'
  5. Set the retrieved chat id in the SECRET_TELEGRAM_CHAT_ID secret variable
  6. Redeploy the status page using the github action

Deploy on your own

You can clone the repository yourself and use Wrangler CLI to develop/deploy, extra list of things you need to take care of:

  • create KV namespace and add the KV_STATUS_PAGE binding to wrangler.toml
  • create Worker secrets optional

Workers KV free tier

The Workers Free plan includes limited KV usage, but the quota is sufficient for 2-minute checks only

  • Change the CRON trigger to 2 minutes interval (crons = ["*/2 * * * *"]) in wrangler.toml

Known issues

  • Max 25 monitors to watch in case you are using Slack notifications, due to the limit of subrequests Cloudflare Worker can make 50.

    The plan is to support up to 49 by sending only one Slack notification per scheduled run.

  • KV replication lag - You might get Slack notification instantly, however it may take couple of more seconds to see the change on your status page as Cron Triggers are usually running on underutilized quiet hours machines.

  • Initial delay (no data) - It takes couple of minutes to schedule and run CRON Triggers for the first time

Future plans

WIP - Support for Durable Objects - Cloudflare's product for low-latency coordination and consistent storage for the Workers platform. There is a working prototype, however, we are waiting for at least open beta.

There is also a managed version of this project, currently in beta. Feel free to check it out https://statusflare.com (https://twitter.com/statusflare_com).

Running project locally


  • Linux or WSL
  • Yarn (npm i -g yarn)
  • Node 14+

Steps to get server up and running

Install wrangler

npm i -g wrangler

Login With Wrangler to Cloudflare

wrangler login

Create your KV namespace in cloudflare

On the workers page navigate to KV, and create a namespace

Update your wrangler.toml with

kv-namespaces = [{binding="KV_STATUS_PAGE", id="<KV_ID>", preview_id="<KV_ID>"}]

Note: you may need to change kv-namespaces to kv_namespaces

Install packages

yarn install

Create CSS

yarn run css


yarn run dev

Note: If the styles do not come through try using localhost:8787 instead of localhost:8080