Upptime: Unlimited, free and open source uptime monitor, powered by GitHub Actions

Anand Chowdhary — Sun, 16 Aug 2020 12:42:17 +0000

My Workflow

GitHub Actions is used as an uptime monitor
- Every 5 minutes, a workflow visits your website to make sure it's up
- Response time is recorded every 6 hours and committed to git
- Graphs of response time are generated every day
GitHub Issues are used for incident reports
- An issue is opened if an endpoint is down
- People from your team are assigned to the issue
- Incidents reports are posted as issue comments
- Issues are locked so non-members cannot comment on them
- Issues are closed automatically when your site comes back up
GitHub Pages are used for the status website
- A simple, beautiful, and accessible PWA is generated
- Built with Svelte and Sapper
- Fetches data from this repository using the GitHub API

Submission Category:

DIY Deployments

Yaml File or Link to Code

https://github.com/koj-co/upptime

Concepts

Issues as incidents

When the GitHub Actions workflow detects that one of your URLs is down, it automatically opens a GitHub issue (example issue #15). You can add incident reports to this issue by adding comments. When your site comes back up, the issue will be closed automatically as well.

Commits for response time

Four times per day, another workflow runs and records the response time of your websites. This data is commited to GitHub, so it's available in the commit history of each file (example commit history). Then, the GitHub API is used to graph the response time history of each endpoint and to track when a site went down.

Run a remote Node.js file quickly

Anand Chowdhary — Wed, 18 Mar 2020 21:31:12 +0000

If you have a local Node.js file that does something, it's very easy to run:

node path/to/file.js

However, if you have a remote file on a URL, say https://example.com/script.js, you have several steps before you can get your desired output in your terminal:

Download script.js (using curl, for example) to a directory
Create a package.json file to make sure it runs
Check if it has any external dependencies
Install external dependencies (using npm install, for example)
Use node script.js to execute it

This is too much of work, especially if you want to get started quickly. So, introducing run-url: an open-source npm remote URL runner written in TypeScript.

Now, you can just run the URL using npx, just like you're used to:

npx run-url https://example.com/script.js

You can also install run-url globally:

npm install --global run-url

And it'll be available in your terminal:

run-url https://example.com/script.js

Running GitHub Gists with Node.js

If you quickly want to prototype, a great way is to create a GitHub Gist. For example, I have the following: https://gist.github.com/AnandChowdhary/3c0400b29a18a2afff7a23e2a3308c22#file-log-moment-js, which has a dependency (moment) and outputs the current date.

Simply copy the raw URL of the gist file and run it:

npx run-url https://gist.githubusercontent.com/AnandChowdhary/3c0400b29a18a2afff7a23e2a3308c22/raw/8ab3ca87821511e580d72585c72736b833d18697/log-moment.js

run-url will install the required dependency (in this case, moment) in a temporary folder, run the Node.js file, and then remove the temporary folder. Just like npx, it just works.

See the source on GitHub or Download from npm

DEV Community: Anand Chowdhary