mirror of
https://github.com/rajnandan1/kener.git
synced 2026-02-14 20:58:55 -06:00
3ffec4f1fe
Implements push-based monitoring via heartbeats. Fixes data interpolation issues. Enhances UI and documentation.
152 lines
5.7 KiB
Markdown
152 lines
5.7 KiB
Markdown
---
|
||
title: Monitors | Kener
|
||
description: Monitors are the heart of Kener. This is where you define the monitors you want to show on your site.
|
||
---
|
||
|
||
# Monitors
|
||
|
||
Monitors are the heart of Kener. This is where you define the monitors you want to show on your site.
|
||
|
||
## Add Monitors
|
||
|
||
Click on the ➕ to add a monitor.
|
||
|
||
<div class="border rounded-md">
|
||
|
||
|
||
|
||
</div>
|
||
|
||
## Tag
|
||
|
||
<span class="text-red-500 text-xs font-semibold">
|
||
UNIQUE
|
||
</span>
|
||
&
|
||
<span class="text-red-500 text-xs font-semibold">
|
||
REQUIRED
|
||
</span>
|
||
|
||
The tag is unique to each monitor and is used to identify the monitor in the code. It is also used to generate the URL for the monitor.
|
||
|
||
## Name
|
||
|
||
<span class="text-red-500 text-xs font-semibold">
|
||
UNIQUE
|
||
</span>
|
||
&
|
||
<span class="text-red-500 text-xs font-semibold">
|
||
REQUIRED
|
||
</span>
|
||
|
||
Name is also unique to each monitor and is used to identify the monitor in the admin panel or in the status page.
|
||
|
||
## Image
|
||
|
||
The image is used to display a logo or an image for the monitor. It is displayed on the status page and in the admin panel. It is optional.
|
||
|
||
## Description
|
||
|
||
The description is used to describe the monitor. It is displayed on the status page and in the admin panel. It is optional. You can also write html in the description and can use tailwind classes.
|
||
|
||
## Cron
|
||
|
||
<span class="text-red-500 text-xs font-semibold">
|
||
REQUIRED
|
||
</span>
|
||
|
||
The cron is used to define the interval at which the monitor should run. It is a cron expression. For example, `* * * * *` will run the monitor every minute.
|
||
|
||
## Default Status
|
||
|
||
Using default status you can set a predefined status for the monitor. The predefined status can be `UP`, `DOWN`, or `DEGRADED`. If the monitor does not have api/dns/ping or if the monitor status is not updated using webbhook, manual incident this will the status of the monitor.
|
||
|
||
## Category Name
|
||
|
||
The category name is used to group monitors. It is displayed on the status page and in the admin panel. It is optional. By a home category is already present. Adding monitor to the home category will show the monitor on the home page.
|
||
|
||
## Day Degraded Min Count
|
||
|
||
<span class="text-red-500 text-xs font-semibold">
|
||
REQUIRED
|
||
</span>
|
||
|
||
The day degraded minimum count is used to define the minimum number of degraded incidents in a day to mark the monitor as degraded for the day. A degraded day means if you are using Monitor Style as FULL under Theme, the whole bar will be shown as Degraded (yellow color) . It is optional. It has to be more than equal to 1
|
||
|
||
## Day Down Min Count
|
||
|
||
<span class="text-red-500 text-xs font-semibold">
|
||
REQUIRED
|
||
</span>
|
||
|
||
The day down minimum count is used to define the minimum number of down incidents in a day to mark the monitor as down for the day. A down day means if you are using Monitor Style as FULL under Theme, the whole bar will be shown as Down (red color) . It is optional. It has to be more than equal to 1
|
||
|
||
## Include Degraded
|
||
|
||
The include degraded is used to include the degraded checks in the total bad checks count. It is optional. By default uptime percentage is calculated as (UP+DEGRADED/UP+DEGRADED+DOWN). Setting it as `YES` will change the calculation to (UP/UP+DEGRADED+DOWN)
|
||
|
||
## Monitor Type
|
||
|
||
<span class="text-red-500 text-xs font-semibold">
|
||
REQUIRED
|
||
</span>
|
||
|
||
### API
|
||
|
||
To monitor an API, you need to provide the URL of the API and the expected status code. If the status code is not received, the monitor will be marked as down. You can read more about API monitoring [here](/docs/monitors-api).
|
||
|
||
### DNS
|
||
|
||
To monitor the DNS records, you need to provide the domain name and the record type. If the record is not found, the monitor will be marked as down. You can read more about DNS monitoring [here](/docs/monitors-dns).
|
||
|
||
### PING
|
||
|
||
To monitor the ping, you need to provide the IP address or the domain name. If the ping is not successful, the monitor will be marked as down. You can read more about PING monitoring [here](/docs/monitors-ping).
|
||
|
||
---
|
||
|
||
## Triggers
|
||
|
||
To add a trigger to a monitor make sure you have created a trigger. You can read more about triggers [here](/docs/triggers).
|
||
|
||
- Click on the 🔔 icon on the top right corner of the monitor.
|
||
- Add details for either DOWN or DEGRADED.
|
||
- Failure Threshold(Required): The number of consecutive failures before the trigger is activated.
|
||
- Success Threshold(Required): The number of consecutive successes before the trigger is deactivated.
|
||
- Create Incident: Chose whether to create an incident or not when the trigger is activated. The incident will be created in Github. So make sure you have set up the Github token in the environment variables. The incident will be closed when the monitor is back to UP.
|
||
- Severity (Required): The severity of the incident. It can be `Critcal` or `Warning`.
|
||
- Custom Message (Required): Add your owner alert message.
|
||
- Choose Triggers: Choose the triggers you want to activate the trigger. You can choose multiple triggers.
|
||
- It will take upto 1 minute for the trigger to be activated.
|
||
|
||
---
|
||
|
||
## Edit Monitors
|
||
|
||
Click on the ⚙️ to edit the monitor.
|
||
|
||
### Deactivate Monitor
|
||
|
||
You can deactivate the monitor by switching the toggle to off. Deactivation a monitor will stop the monitor from running. It will take one minute to deactivate.
|
||
|
||
### Activate Monitor
|
||
|
||
You can activate the monitor by switching the toggle to on. Activation a monitor will start the monitor. It will take one minute to activate.
|
||
|
||
<div class="note info">
|
||
|
||
Any changes in the a live monitor will take 2 minutes to reflect.
|
||
|
||
</div>
|
||
|
||
## Supported Monitors
|
||
|
||
- [API Monitors](/docs/monitors-api)
|
||
- [DNS Monitors](/docs/monitors-dns)
|
||
- [PING Monitors](/docs/monitors-ping)
|
||
- [TCP Monitors](/docs/monitors-tcp)
|
||
- [SQL Monitors](/docs/monitors-sql)
|
||
- [SSL Monitors](/docs/monitors-ssl)
|
||
- [HEARTBEAT Monitors](/docs/monitors-heartbeat)
|
||
- [GROUP Monitors](/docs/monitors-group)
|