Documentation

Everything you need to start monitoring and get real time alert with Noty

Introduction

Welcome to the documentation of noty. noty is a monitoring system focus on simplicity, speed, accurate, and add-ons utilty to help monitor system more easily.


What is a check

Check is a basic monitoring unit that noty.im will periodcally visit your check URL, record the result then validate the result agains a set of rule. Whenever the result matches any rule, an incident will be created. At the same time, we send you a notification with incident detail.
noty.im use user-agen 'notybot/1.0' so if you see that in your log, that's us.


How to add check

You add checks by going to https://noty.im/checks after logging in, then click on "Create New Check" button and follow instruction on screen. These are core concept of a check.

  • Type: We support HTTP/TCP/Hearbeat check. Depend on your type, you can define different rule for alert. Such as in a HTTP check, we can define rule based on up/down status, or based on response code, response time.
  • Name: A friendly name to help you idenfity the check
  • URI: This is your website URL in case of HTTP/TCP check. Or some internal URL in case of heartbeat.

Define alert

Great job on adding your first check. Now we will define when an alert should be created and who to receive the alert.


Define alert condition

An alert condition is a rule agains the result of reading your check URI. Example of alert conditions:

  • Alerting when you website is down
  • Alerting when the response time is greater than 3 seconds. Mean your site is still up, it's just much slower than normal
  • Alert when the response contains some words. Such as your website is still up, but it got error and contains an error message in the response

From https://noty.im/checks, you can click on Config button of any check to go to config page. From there you can define alert in sections Alert Conditions . The from is interactive and guide you want to do. You can define one ore more alert, no limitation on number of alert condition.
By default, if you don't create any alert condition, we automatically create two alerts for you:

  • First one is an alert when your service is down.
  • First one is an alert when your service is down.

What is a check

Check is a basic monitoring unit that noty.im will periodcally visit your check URL, record the result then validate the result agains a set of rule. Whenever the result matches any rule, an incident will be created. At the same time, we send you a notification with incident detail.
noty.im use user-agen 'notybot/1.0' so if you see that in your log, that's us.


How to add check

You add checks by going to https://noty.im/checks after logging in, then click on "Create New Check" button and follow instruction on screen. These are core concept of a check.

  • Type: We support HTTP/TCP/Hearbeat check. Depend on your type, you can define different rule for alert. Such as in a HTTP check, we can define rule based on up/down status, or based on response code, response time.
  • Name: A friendly name to help you idenfity the check
  • URI: This is your website URL in case of HTTP/TCP check. Or some internal URL in case of heartbeat.
The rest is coming soon