gani0325 / upptime

Monitoring web dashboard

⭐ 오픈소스 upptime 원리

1. Github Actions의 스케줄링 기능을 이용해 미리 정의된 엔드포인트에 주기적으로 HTTP/TCP 요청을 날립니다 (기본 값: 5분).
2. Upptime이 체크하는 여러가지 사항 중 응답이 저하되거나 다운되는 경우, 새로운 Github Issue를 발행합니다.
3. 이후 서버 장애가 해결되면 해당 Github Issue는 Close 됩니다.
4. 이 리포트 결과를 Github Pages로 만들어진 웹 대시보드를 통해 언제든지 확인할 수 있습니다.

Upptime (https://upptime.js.org) is the open-source uptime monitor and status page, powered entirely by GitHub Actions, Issues, and Pages. It's made with 💚 by your friends at Koj.

I find Upptime an incredible clever usage of [GitHub Actions]. You essentially get a free configurable uptime monitor for whatever you want. – CSS Tricks

Upptime is used by 1,000+ people and teams to ensure they know when their endpoints go down.

📈 Live Status: 🟧 Partial outage

URL	Status	History	Response Time	Uptime
Google	🟩 Up	google.yml	101ms	100.00%
Wikipedia	🟩 Up	wikipedia.yml	231ms	100.00%
Hacker News	🟩 Up	hacker-news.yml	324ms	100.00%
Test Broken Site	🟥 Down	test-broken-site.yml	0ms	0.00%

⭐ How it works

• 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 is 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
  • Slack notifications are sent on updates
• GitHub Pages is 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

Upptime is not affiliated to or endorsed by GitHub.

👩‍💻 Documentation

1. How it works
2. Getting started
3. Configuration
4. Triggers
5. Notifications
6. Badges
7. Packages
8. Contributing
9. Frequently Asked Questions

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 #67). 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 committed 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.

📄 License

• Code: MIT © Koj
• Data in the ./history directory: Open Database License

_{An open source project by Koj.
Furnish your home in style, for as low as CHF175/month →}