openstatushq/openstatus

🏓 The open-source synthetic & real user monitoring platform 🏓

OpenStatus

The Open-Source website & API monitoring platform.
Learn more »

Discord · Website · Issues · Roadmap

About OpenStatus 🏓

OpenStatus is open-source synthetic monitoring platform with beautiful status page and incident management. We are building it publicly for everyone to see our progress. We believe great softwares are built this way.

You can choose to host it yourself or use our hosted version at openstatus.dev

Contact us 💌

If you want to learn more about this project or have any questions, book a call with us or send us an email at [email protected]

Built with 🛠️

• Next.js
• Tailwind CSS
• shadcn/ui
• tinybird
• turso
• drizzle
• clerk
• Resend

Getting Started 🚀

Requirements

• Node.js >= 20.0.0
• pnpm >= 8.6.2

Setup

1. Clone the repository

   git clone https://github.com/openstatushq/openstatus.git

2. Install dependencies

   pnpm install

3. Set up your .env file

   From apps/web and packages/db, you will find .env.example. Create your own copy.

4. Follow the steps to run your sqlite database locally inside of README.md

5. Start the development with the below command

    pnpm dev

   It will:

   • run the web app on port 3000
   • run the api server on port 3001
   • run the docs on port 3002

6. See the results:

• open http://localhost:3000 for the web app
• open http://localhost:3001/ping for the api server health check
• open http://localhost:3002 for the docs

For clerk, you will need to create a webhook endpoint. To access the link, you can use tunneling tools like Tunnelmole, an open source tunnelling tool or ngrok, a popular closed source tunnelling tool.

Using Tunnelmole

1. Install Tunnelmole with curl -O https://install.tunnelmole.com/384HK/install && sudo bash install. (On Windows, download tmole.exe)
2. Run tmole 3000. In the output, you'll see two URLs, one HTTP, and an HTTPS URL. It's best to use the HTTPS URL for privacy and security.

➜  ~ tmole 3000
http://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000
https://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000

Append /api/webhook/clerk to the HTTPs URL.

Using ngrok

After login, append /api/webhook/clerk to the link you get after entering:

$ ngrok http 3000

Videos

Videos to better understand the OpenStatus codebase:

• The code behind OpenStatus and how it uses Turbopack.
• Drop Betterstack and go open source

Roadmap 🗺️

Here's our roadmap feel free to contribute to it.

Contributing 🤝

If you want to help us building the best status page and alerting system, you can check our contributing guidelines

Top Contributors

Made with Contrib.rocks

Stats

openstatus's Issues

[OPE-51] Edit monitor

We should be able to edit a monitor

• Status → Pause/active
• Name
• Description

_{From SyncLinear.com | OPE-51}

Set up documentation site

Create a new app with nextra with the doc
How to contribute to the project
How to set up env !

Public project Support

How do you look at converting it to a public project with subdomain or path?

See example: https://github.com/fatih-yavuz/my-links

The sustainability of the project can also be ensured by adding certain limits that anyone can use by signing up with a dashboard.

UI design bug on All main pages

When we resize window using button from top right between close and minimize, the background stays on the old position after switching to full screen again.

Pages: All pages

Fix Nextjs Cache on status page

On the first request we should fetch the data and not rely on cache

UI: height of submit button doesnt match input field

i would like to be assigned to this

[OPE-54] Improve DX for new developers

We should improve DX for new development

A single command should launched a local dev

_{From SyncLinear.com | OPE-54}

provide a way to un track these IP from analytics

this way we lead to too much miss good analytics, as edge will use different ips each time even for the same region

so is there's a way to prevent that ?!

When I click the redirect link is relative so it misses the way

when I click here it directs me to the path but relative with the subdomain,

there are two solutions to that

• putting the full URI
• redirect on subdomain level

[OPE-53] Create ContentLayer Changelog

_{From SyncLinear.com | OPE-53}

[OPE-62] Create better user workflow to create pages/montitors

_{From SyncLinear.com | OPE-62}

[OPE-57] Save name and email in user table when a user sign up

We should save name and user in the user table to avoid extra calls to clerk

_{From SyncLinear.com | OPE-57}

[OPE-41] Integrate Email

_{From SyncLinear.com | OPE-41}

[ENG-32] Create custom /play[ground]

This route will be publicly available and data is coming from our website.

_{From SyncLinear.com | ENG-32}

[OPE-58] Add GitHub login

_{From SyncLinear.com | OPE-58}

500 error code randomly

Once in a while when I open farmako.openstatus.dev it throws a 500 error and then on refresh it starts working. It doesn't happen all the time. I wonder what it is, probably something related db?

Fix hero grammar

"OpenStatus is an open source alternative to your current monitoring service with beautiful status page.
should be
OpenStatus is an open source alternative to your current monitoring service with a beautiful status page.

GitHub OAuth?

Will there be a GitHub sign up option any time soon?

[OPE-19] Status Page

_{From SyncLinear.com | OPE-19}

[OPE-52] Create ContentLayer Blog

_{From SyncLinear.com | OPE-52}

[OPE-61] On monitor creation form we should block if the user has not selected a frequency

Some users did not select a frequency and they were able to create a monitor, it could lead to a bad ux

_{From SyncLinear.com | OPE-61}

Fix migrate script dont run

Should fix the tsconfig.ts to run the migrate script

As a quick fix run the migration with

Bun arc/migrate.ts

[OPE-38] Notification System

Whenever a ping is not 200-299, we should send a notification to the user.

Before starting, we should make sure to have a stable API around that.

For each integration, we should have a mapping function from our API to the service one.

_{From SyncLinear.com | OPE-38}

Invalid environment variables: { DATABASE_URL: [ 'Required' ] }

i'm trying to play with this project but i got this error

web:dev: - ready started server on 0.0.0.0:3000, url: http://localhost:3000
web:dev: ❌ Invalid environment variables: { DATABASE_URL: [ 'Required' ] }
web:dev: Error: Invalid environment variables
web:dev: at c (file:///C:/Users/Adam/openstatus-main/node_modules/.pnpm/@t3-oss[email protected][email protected][email protected]/node_modules/@t3-oss/env-core/dist/index.mjs:1:426)

i know it's related to env var but wich one i cant find tree of it or where's came from

aslo is there's any env file except this ?

[OPE-39] Integrate Slack

_{From SyncLinear.com | OPE-39}

Dynamically add blog links to sitemap

Description

Since all blog routes /blog/* are public it's better to include them in the sitemap to make the blogs easily discoverable on the web🚀

I'll open a PR fixing this issue.

Noticed a small typo in the waitlist email

I noticed a small typo in the email I received after joining the waitlist. We are missing Y in the highlighted paragraph.

I know it's a small fix and I would have looked into repo, before creating this Issue, but I am on my phone and unable to do it properly.

Apologies, if I reported it in a wrong place 🙏.

my monitor page doesn't show anything

my status page is empty and I have made a monitor to ping my site
and also there's no data recorded !!

I have been added it 8h ago

Z-index stacking issue on Safari

There seems to be an issue with the z-index of the HoverCard on the landing page in Safari. The card is displayed behind the content below, if the card is rendered underneath.

The issue seems to discussed on the following page: https://ecomgraduates.com/blogs/news/fixing-z-index-issue-on-safari-browser

Monitor Data Page dont display any data

The monitor datapage is blank

[OPE-40] Integrate Discord

_{From SyncLinear.com | OPE-40}

[OPE-37] Create a content support

Use contentlayer for easy file management on github. Can be used for:

• changelog
• blog

Install reading-time for good read estimation.

Support mdx.

Some repos to get inspiration from:

• mxkaske/doxi
• mxkaske/mxkaske.dev
• shadcn/taxonomy
• steven-tey/dub

_{From SyncLinear.com | OPE-37}

[OPE-49] Select subdomain to status page

_{From SyncLinear.com | OPE-49}

[OPE-22] Add GitHub Actions

• tsc
• lint
• …

_{From SyncLinear.com | OPE-22}

[OPE-59] Improve email

we should see some content bellow the title

_{From SyncLinear.com | OPE-59}

[OPE-46] Raycast integration

_{From SyncLinear.com | OPE-46}

[OPE-45] Select monitor to display on status page

_{From SyncLinear.com | OPE-45}

[OPE-46] Raycast integration

_{From SyncLinear.com | OPE-46}

Date handling on monitor and status page

First of all, the requests are working super well, awesome!

I've noticed most of the bugs like "data not showing" and related are due to how date is being handled.
When we access the monitor page it should pick the data from the current day, right now it is fetching from the previous day; if we set the date to today, it is possible to verify it. It also happens on the status page, only there we can't set the date to validate this issue.

[OPE-48] Support for Cloudflare Pages with CF functions

https://twitter.com/hyrousek/status/1679150301281157123?s=20

_{From SyncLinear.com | OPE-48}

[OPE-35] Create sitemap

https://nextjs.org/docs/app/api-reference/file-conventions/metadata/sitemap

_{From SyncLinear.com | OPE-35}

[OPE-47] Setup I18n

Allow different locales

_{From SyncLinear.com | OPE-47}

[OPE-50] Settings page

create a shell page for settings

_{From SyncLinear.com | OPE-50}

[OPE-60] Remove Region from monitor creation

it's optional, we should not ask if they want a preferred region to make the form simpler

_{From SyncLinear.com | OPE-60}

[OPE-44] Allow user to choose theme for status page

• check tremorlabs colors
• [ ]

_{From SyncLinear.com | OPE-44}

Tooltips don't work on mobile

On status page tooltip don't work on mobile

Fix spelling mistake in README.md

Hey, I've noticed a minor spelling mistake in contact section of README.

I've opened a PR which fixes this issue.

Create public roadmap

Let's release a public roadmap to provide a clearer view of the project.

Invalid environment variables JITSU_HOST, JITSU_WRITE_KEY

Error Description:

When running the steps of the repository and using pnpm dev, I encounter the following error when trying to access localhost:3000:

web:dev: ❌ Invalid environment variables: { JITSU_HOST: [ 'Required' ], JITSU_WRITE_KEY: [ 'Required' ] }
web:dev: - wait compiling /_error (client and server)...
web:dev: - error ../node_modules/.pnpm/@[email protected][email protected][email protected]/node_modules/@t3-oss/env-core/dist/index.mjs (1:501) @ y
web:dev: - error Error: Invalid environment variables
web:dev:     at y (webpack-internal:///(rsc)/../../node_modules/.pnpm/@[email protected][email protected][email protected]/node_modules/@t3-oss/env-core/dist/index.mjs:11:91)
web:dev:     at h (webpack-internal:///(rsc)/../../node_modules/.pnpm/@[email protected][email protected][email protected]/node_modules/@t3-oss/env-core/dist/index.mjs:15:31)
web:dev:     at eval (webpack-internal:///(rsc)/../../packages/analytics/env.ts:9:72)
web:dev:     at (rsc)/../../packages/analytics/env.ts (/home/user/Documentos/openstatus/apps/web/.next/server/app/page.js:5960:1)
web:dev:     at __webpack_require__ (/home/user/Documentos/openstatus/apps/web/.next/server/webpack-runtime.js:33:42)
web:dev:     at eval (webpack-internal:///(rsc)/./src/env.ts:8:83)
web:dev:     at (rsc)/./src/env.ts (/home/user/Documentos/openstatus/apps/web/.next/server/app/page.js:3774:1)
web:dev:     at __webpack_require__ (/home/user/Documentos/openstatus/apps/web/.next/server/webpack-runtime.js:33:42)
web:dev:     at eval (webpack-internal:///(rsc)/./src/lib/tb.ts:7:62)
web:dev:     at (rsc)/./src/lib/tb.ts (/home/user/Documentos/openstatus/apps/web/.next/server/app/page.js:3785:1) {
web:dev:   digest: undefined
web:dev: }
web:dev: null

Error Explanation:

The error message indicates that there are invalid environment variables, specifically JITSU_HOST and JITSU_WRITE_KEY. The error seems to be occurring in the file env-core/dist/index.mjs from the @t3-oss/env-core package version 0.6.0 with TypeScript version 5.1.6 and Zod version 3.21.4. The specific line where the error is triggered is line 1, column 501 (1:501).

The error traceback suggests that the issue is related to the file analytics/env.ts at line 9, column 72, and the file src/env.ts at line 8, column 83. Additionally, there is a reference to src/lib/tb.ts at line 7, column 62.

analytics/env.ts content:

import { createEnv } from "@t3-oss/env-core";
import { z } from "zod";

export const env = createEnv({
  server: {
    JITSU_HOST: z.string(),
    JITSU_WRITE_KEY: z.string(),
  },
  runtimeEnv: {
    JITSU_HOST: process.env.JITSU_HOST,
    JITSU_WRITE_KEY: process.env.JITSU_WRITE_KEY,
  },
});

Steps Taken:

1. Checked the .env file to ensure that JITSU_HOST and JITSU_WRITE_KEY are properly defined, but they seem to be correctly set.
2. Verified the env.ts file and ensured that the variables are being imported and accessed correctly.

Expected Behavior:

When executing pnpm dev and accessing localhost:3000, the application should run without any errors related to invalid environment variables.

Additional Information:

Operating System: Ubuntu 22.04.2 LTS (Jammy Jellyfish)

Node.js Version: 18.16.0

pnpm Version: 8.6.10

Bug: status page is created even when `slug` is not provided⚠

Demo

screen-capture.webm

One solution would be to check if all relevant fields are present in the form before making the form submission. Alterly we can generate a random slug as we are already doing with workspaces.