oneuptime/oneuptime

OneUptime is the complete open-source observability platform.

OneUptime: The Complete Open-Source Observability Platform

OneUptime is a comprehensive solution for monitoring and managing your online services. Whether you need to check the availability of your website, dashboard, API, or any other online resource, OneUptime can alert your team when downtime happens and keep your customers informed with a status page. OneUptime also helps you handle incidents, set up on-call rotations, run tests, secure your services, analyze logs, track performance, and debug errors.

OneUptime replaces multiple tools with one integrated platform:

Uptime Monitoring

Monitor the availability and response time of your online services from multiple locations around the world. Get notified via email, SMS, Slack, or other channels when something goes wrong. Replace tools like Pingdom.

Status Pages

Communicate with your customers and stakeholders during downtime or maintenance. Create a custom-branded status page that shows the current status and history of your services. Replace tools like StatusPage.io.

Incident Management

Manage incidents from start to finish with a collaborative workflow. Create incident reports, assign tasks, update stakeholders, and document resolutions. Replace tools like Incident.io.

On Call and Alerts

Schedule on-call shifts for your team and define escalation policies. Ensure that the right person is notified at the right time when an incident occurs. Replace tools like PagerDuty.

Logs Management

Collect, store, and analyze logs from your online services. Search, filter, and visualize log data to gain insights and troubleshoot issues. Replace tools like Loggly.

Workflows

Integrate OneUptime with your existing tools and automate your workflows. Integrate with tools like Slack, Jira, GitHub, and 5000+ more.

Application Performance Monitoring

Measure and optimize the performance of your online apps and services. Track key metrics such as traces, response time, throughput, error rate, and user satisfaction. Replace tools like NewRelic and DataDog.

Coming Soon

• Error Tracking: Detect and diagnose errors in your online services. Get detailed error reports with stack traces, context, and user feedback. Replace tools like Sentry.
• Reliability Autopilot: Scan your code and fix performance issues and errors automatically. Get recommendations for improving the reliability of your online services.

All under one platform.

Get Started for Free with OneUptime Cloud

OneUptime Cloud is the easiest and fastest way to monitor your website uptime and performance. You can sign up for free to OneUptime Cloud and enjoy the full benefits of OneUptime without any installation or maintenance hassle.

By using OneUptime Cloud, you also support the development of OneUptime open source project, which is a powerful and flexible tool for website monitoring. You can find more information about OneUptime open source project on GitHub. The code of OneUptime is completely open source, which means you can access, modify, and distribute it freely. You can also contribute to the project by reporting issues, suggesting features, or submitting pull requests.

If you need advanced features, such as API Access, Advances Workflows, or Advanced Access Control, you can upgrade to a paid plan anytime. You can compare the different plans and pricing on OneUptime Pricing page.

Installation

• Install on Kubernetes with Helm (recommended for production)
• Install with Docker Compose (hobby install, not recommended for production)
• Install for Local Development

Philosophy

Our mission is to reduce downtime and increase the number of successful products in the world. To do that, we built a platform that helps you understand causes of the downtime, incidents and help reduce toil. Our product is open-source, free and available for everyone to use.

Contributing

We <3 contributions big and small. In priority order (although everything is appreciated) with the most helpful first:

• Give us feedback in our Customer Slack community
• Talk to developers in our Developer Slack community
• Write tests for some of our codebase. See issues here
• Work on any issue you like. See issues here
• Open new issues and create new feature requests that you would like to see. Open issues here

Donate

If you like the project, please consider a small donation. Every single dollar will be used to ship new features or maintain existing ones. 100% of the work we do is open-source. Please donate here

oneuptime's Issues

Create a default pull request template

Please refer to this: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

We need to create a default pull request template so people who create PR's can follow the template we have and PR's are consistent.

Please pick a simple template from many templates out on GitHub.

Tests for Common/Types/Email

Write the test for Common/Types/Email/*.ts

Create issues to test Common/Utils

You can break this issue down into multiple issues.

We have lots of Common/Utils. Ideally, there should be 1 issue for each of those types in Common/Utils. Create 1 issue for each of those utils and close this issue.

Labels for those issues: good first code

Ligthouse Scan for Accounts.

Similar to issue #112, we need to enable lighthouse scan for Accounts project.

Add Styling for SSO and Register page

The SSO page and register page are not styled.

Draft CONTRIBUTING.md template

A CONTRIBUTING.md file provides potential project contributors with a short guide to how they can contribute to project.

Write tests for Common/Types/API

Write the tests for the Common/Types/API

Write docker build job for `HelmChart`

Similar to #24

CSS for Login Page

Our login page does not have CSS at this time and we need to write one for it. Please make sure CSS is refactored property. We also use frameworks like Twitter Bootstrap to make our lives easier.

No extra non-null-assertion

Disallow extra non-null assertion.
https://typescript-eslint.io/rules/no-extra-non-null-assertion

Write docker build job for `/Mail`, `/ProbeAPI`, `/Home`, `/Licensing`

Similar to #24

Write docker build job for /Mail, /ProbeAPI, /Home, /Licensing

Validating input fields

Add validation for required fields

Write npm compile job for ApiDocs and Realtime

Similar to #36

Write docker-build github workflow for haraka.

We need to check if docker containers are successfully built on every PR. For this, we need to write docker build GitHub action workflow.

You can currently build the haraka docker container by running.

npm run build-ci haraka

in the root folder.

Please write a GitHub Workflow file for it.

Create React App for Dashboard

Create a brand new react application for the dashboard

Tests for /Home

We have a /Home project which is basically the home page of the application. When you npm install and npm start the project, it runs on port 1444.

It has several pages, however, there are no tests for these pages. We need to create jest puppeteer tests for all the pages, we need to make sure the page loads properly, and there's content on the page.

Please create a test file for each page. You can create a draft PR and ask for early review.

Add logo to Account Pages

• Add logo to all account pages.
• Change favicon.
• Change page title for each account page. It should be "OneUptime | Login" for login page for example.

Style register page

Register page needs styling

Implement issue template

Implement issue template in Git

Disallow the declaration of empty interfaces

Disallow the declaration of empty interfaces.

An empty interface is equivalent to its supertype. If the interface does not implement a supertype, then the interface is equivalent to an empty object ({}). In both cases it can be omitted.

INCORRECT

// an empty interface
interface Foo {}

// an interface with only one supertype (Bar === Foo)
interface Bar extends Foo {}

// an interface with an empty list of supertypes
interface Baz {}

CORRECT

// an interface with any number of members
interface Foo {
  name: string;
}

// same as above
interface Bar {
  age: number;
}

// an interface with more than one supertype
// in this case the interface can be used as a replacement of a union type.
interface Baz extends Foo, Bar {}

Write `npm compile` github actions job for common.

• cd into Common
• npm install
• npm run compile

The project compiles successfully, but we don't have a GitHub actions job that makes sure the project compiles. Please write one.

Write tests for Common/Utils/Email

There are no tests for Common/Utils/Email/, write tests for it.

Write test for Common/Utils/Slug

There are no tests for Common/Utils/Slug.ts, write the tests for it.

Validate data in forms.

You need to make sure the form data is valid. Please check loom here for an explaination.

https://www.loom.com/share/10b2f3305e584e379d4c234729a33304

Extend IP to DatabaseProperty

Please look at this file for inspiration:

Common/Types/Email.ts

As email extends DatabaseProperty. IP (Common/Types/IP/IP.ts) should also extend DatabaseProperty. Override and Implement toDatabase and fromDatabase functions.

Write tests for it.

Write `npm compile` github actions job for `/Mail`, `/ProbeAPI`, '/Home`, `/Licensing`

Please refer to this issue: #19 <- This should be completed first.

Once you're done with issue #19. We can do the same for /Mail, /ProbeAPI, '/Home, /Licensing` projects in the repo.

Tests for Common/Types/*.ts

Write test for the files in directory Common/Types/ not in sub directory

Create docker build and test infra for Accounts, and Mail.

Setup test infrastructure for Probe, ProbeAPI, HelmChart, Home and write Github actions job for it.

Please look at how tests are set up for Common. Please set up the same test infrastructure for Probe, ProbeAPI, HelmChart, Home and write github actions job for it.

Initial Dashboard Design.

Move the current dashboard to code graveyard and create a new dashboard

Tests for Common/Types/Exception/*.ts

Write the tests for files in Common/Types/Exception/

Await Dangling Promises

Some code statements are meant to be await

Compile Probe

Run npm run compile and make sure the project compiles.

Lighthouse Scan for Home.

We have a /Home project which is basically the home page of the application. When you npm intall and npm start the project, it runs on port 1444.

It has several pages, however, there's no lighthouse scan for these pages. Lighthouse is a project by Google and it scans the page for performance, styling, etc etc. We need to scan all the pages in the home project on Lighthouse in the GitHub Runner.

So,

• Create a GitHub Actions Job that runs the home project in a docker container.
• After the home project is running, you can initiate lighthouse scans on the pages.
• If the score of any page is <80%, we fail the job otherwise we pass the job.
• We have one job for all the pages in the home project.

Organize GitHub Workflows better.

We have to organize GitHub actions workflow better.

We have file names like .github/workflows/accounts-production-deploy.yaml which can be renamed to deployment.production.accounts.yaml.

Please do this for all files that are marked as *-production-deply.yaml or staging-deploy.yaml in the github workflows folder.

Context: https://stackoverflow.com/questions/62288443/where-should-you-put-the-git-hub-workflow-directory-for-actions-in-a-full-stack

Disallow usage of the any type

Disallow usage of the any type

Write the test for Common/Utils/API

There are no tests for Common/Utils/API.ts, write the tests for it.

Create test infrastructure for Accounts.

Setup testing infrastructure for Common

• We have an directory "Common" where most of the common code across services lives.
• There are no tests written for it.
• To begin with, we need to set up testing infrastructure on common, which basically means we need to set up https://jestjs.io/ for this project.
• Create a directory called "Tests" inside of "Common"
• Set up jest https://jestjs.io/ testing framework for this project.
• To begin with write tests for Common/Utils/UUID.ts
• Make sure tests run when you run npm run test inside of Common
• Set up GitHub Actions job for it and make sure they run on all branches except hotfix-*, release and staging-release. You can copy the workflow file from here: .github/skipped-workflows/test-saas.yaml
• This PR should have that test job passing.

Change from Apache License to MIT

The current license is Apache Version 2.0, change it to the MIT

Fix no-duplicate-imports eslint errors

Rule no-duplicate-imports is currently commented in .eslintrs.json

Please uncomment that rule and fix all the eslint errors.

You can run eslint, by executing npm run fix in the root directory.

Please work from ts-migrate branch repo and send a pr to ts-migrate branch.

Implement sonar-cloud

Implement https://sonarcloud.io/

Tests for Common/Types/IP/*

Please write jests tests for these files.

Write npm compile job for `HelmChart`

Similar to #20

Style Layout for TopNav

Create basic layout for TopBar

Write getting started and readme

Write getting started guides and readme.

Create issues to test Common/Types

You can break this issue down into multiple issues.

We have lots of Common/Types. Ideally, there should be 1 issue for each of those types Common/Types. Create 1 issue for each of those types and close this issue.

Labels for those issue: good first code

Stronger TS Lint

Our current eslintrc file .eslintrc.json is missing some typescript lint rules. You can find TS eslint rules here: https://typescript-eslint.io/rules/

We need to implement more lint eslint rules from https://typescript-eslint.io/rules/

Please look into all the rules here: https://typescript-eslint.io/rules/ and compare it with rules in the file .eslintrc.json. For rules that does not exists in .eslintrc.json, we should create a new issue to implement that rule.

This is no-code PR which means, new issues will be created and this issue will be closed.

Add Styling for account in Topbar

Write docker build job for ApiDocs and Realtime

Similar to #35