2021-07-30 13:18:26 +02:00
const https = require ( "https" ) ;
2021-06-25 15:55:49 +02:00
const dayjs = require ( "dayjs" ) ;
2021-07-30 13:18:26 +02:00
const utc = require ( "dayjs/plugin/utc" )
let timezone = require ( "dayjs/plugin/timezone" )
2021-06-27 10:10:55 +02:00
dayjs . extend ( utc )
dayjs . extend ( timezone )
const axios = require ( "axios" ) ;
2021-07-30 13:18:26 +02:00
const { Prometheus } = require ( "../prometheus" ) ;
2021-07-30 18:01:04 +02:00
const { debug , UP , DOWN , PENDING , flipStatus } = require ( "../../src/util" ) ;
2021-08-05 13:04:38 +02:00
const { tcping , ping , checkCertificate , checkStatusCode } = require ( "../util-server" ) ;
2021-07-30 13:18:26 +02:00
const { R } = require ( "redbean-node" ) ;
const { BeanModel } = require ( "redbean-node/dist/bean-model" ) ;
const { Notification } = require ( "../notification" )
2021-06-27 10:10:55 +02:00
/ * *
* status :
* 0 = DOWN
* 1 = UP
2021-07-27 19:53:59 +02:00
* 2 = PENDING
2021-06-27 10:10:55 +02:00
* /
2021-06-25 15:55:49 +02:00
class Monitor extends BeanModel {
2021-07-09 11:55:48 +02:00
async toJSON ( ) {
let notificationIDList = { } ;
let list = await R . find ( "monitor_notification" , " monitor_id = ? " , [
2021-07-30 13:18:26 +02:00
this . id ,
2021-07-09 11:55:48 +02:00
] )
for ( let bean of list ) {
notificationIDList [ bean . notification _id ] = true ;
}
2021-06-25 15:55:49 +02:00
return {
id : this . id ,
name : this . name ,
url : this . url ,
2021-07-01 08:03:06 +02:00
hostname : this . hostname ,
port : this . port ,
2021-07-19 18:23:06 +02:00
maxretries : this . maxretries ,
2021-07-01 07:11:16 +02:00
weight : this . weight ,
2021-06-25 15:55:49 +02:00
active : this . active ,
type : this . type ,
interval : this . interval ,
2021-07-01 11:19:28 +02:00
keyword : this . keyword ,
2021-07-30 16:11:14 +02:00
ignoreTls : this . getIgnoreTls ( ) ,
2021-07-30 18:01:04 +02:00
upsideDown : this . isUpsideDown ( ) ,
2021-08-05 13:04:38 +02:00
maxredirects : this . maxredirects ,
accepted _statuscodes : this . getAcceptedStatuscodes ( ) ,
2021-07-30 13:18:26 +02:00
notificationIDList ,
2021-06-25 15:55:49 +02:00
} ;
}
2021-07-30 16:11:14 +02:00
/ * *
* Parse to boolean
* @ returns { boolean }
* /
getIgnoreTls ( ) {
return Boolean ( this . ignoreTls )
}
/ * *
* Parse to boolean
* @ returns { boolean }
* /
2021-07-30 18:01:04 +02:00
isUpsideDown ( ) {
2021-07-30 16:11:14 +02:00
return Boolean ( this . upsideDown ) ;
}
2021-08-05 13:04:38 +02:00
getAcceptedStatuscodes ( ) {
return JSON . parse ( this . accepted _statuscodes _json ) ;
}
2021-06-25 15:55:49 +02:00
start ( io ) {
2021-06-29 10:06:20 +02:00
let previousBeat = null ;
2021-07-19 18:23:06 +02:00
let retries = 0 ;
2021-06-29 10:06:20 +02:00
2021-07-27 18:52:31 +02:00
let prometheus = new Prometheus ( this ) ;
2021-07-22 17:00:11 +02:00
2021-06-27 10:10:55 +02:00
const beat = async ( ) => {
2021-07-24 05:42:14 +02:00
2021-06-29 10:06:20 +02:00
if ( ! previousBeat ) {
previousBeat = await R . findOne ( "heartbeat" , " monitor_id = ? ORDER BY time DESC" , [
2021-07-30 13:18:26 +02:00
this . id ,
2021-06-29 10:06:20 +02:00
] )
}
2021-07-24 05:42:14 +02:00
const isFirstBeat = ! previousBeat ;
2021-06-27 10:10:55 +02:00
let bean = R . dispense ( "heartbeat" )
bean . monitor _id = this . id ;
bean . time = R . isoDateTime ( dayjs . utc ( ) ) ;
2021-07-24 05:42:14 +02:00
bean . status = DOWN ;
2021-06-27 10:10:55 +02:00
2021-07-30 18:01:04 +02:00
if ( this . isUpsideDown ( ) ) {
bean . status = flipStatus ( bean . status ) ;
}
2021-06-30 20:02:54 +02:00
// Duration
2021-07-24 05:42:14 +02:00
if ( ! isFirstBeat ) {
2021-07-30 13:18:26 +02:00
bean . duration = dayjs ( bean . time ) . diff ( dayjs ( previousBeat . time ) , "second" ) ;
2021-06-30 20:02:54 +02:00
} else {
bean . duration = 0 ;
}
2021-06-27 10:10:55 +02:00
try {
2021-07-01 11:19:28 +02:00
if ( this . type === "http" || this . type === "keyword" ) {
2021-06-27 10:10:55 +02:00
let startTime = dayjs ( ) . valueOf ( ) ;
2021-07-30 16:11:14 +02:00
// Use Custom agent to disable session reuse
// https://github.com/nodejs/node/issues/3940
2021-07-11 22:01:34 +02:00
let res = await axios . get ( this . url , {
2021-08-11 17:12:38 +02:00
timeout : this . interval * 1000 * 0.8 ,
2021-07-30 13:18:26 +02:00
headers : {
2021-08-10 14:23:15 +02:00
"Accept" : "*/*" ,
2021-07-30 13:18:26 +02:00
"User-Agent" : "Uptime-Kuma" ,
} ,
2021-07-30 16:11:14 +02:00
httpsAgent : new https . Agent ( {
maxCachedSessions : 0 ,
rejectUnauthorized : ! this . getIgnoreTls ( ) ,
} ) ,
2021-08-05 13:04:38 +02:00
maxRedirects : this . maxredirects ,
validateStatus : ( status ) => {
return checkStatusCode ( status , this . getAcceptedStatuscodes ( ) ) ;
} ,
2021-07-23 05:22:37 +02:00
} ) ;
2021-06-27 10:10:55 +02:00
bean . msg = ` ${ res . status } - ${ res . statusText } `
bean . ping = dayjs ( ) . valueOf ( ) - startTime ;
2021-07-01 11:19:28 +02:00
2021-07-22 10:04:32 +02:00
// Check certificate if https is used
2021-07-23 06:58:05 +02:00
let certInfoStartTime = dayjs ( ) . valueOf ( ) ;
2021-07-22 10:13:58 +02:00
if ( this . getUrl ( ) ? . protocol === "https:" ) {
2021-07-23 06:58:05 +02:00
try {
await this . updateTlsInfo ( checkCertificate ( res ) ) ;
} catch ( e ) {
2021-08-08 07:47:29 +02:00
if ( e . message !== "No TLS certificate in response" ) {
console . error ( e . message )
}
2021-07-23 06:58:05 +02:00
}
2021-07-21 06:09:09 +02:00
}
2021-07-01 11:19:28 +02:00
2021-07-23 06:58:05 +02:00
debug ( "Cert Info Query Time: " + ( dayjs ( ) . valueOf ( ) - certInfoStartTime ) + "ms" )
2021-07-01 11:19:28 +02:00
if ( this . type === "http" ) {
2021-07-24 05:42:14 +02:00
bean . status = UP ;
2021-07-01 11:19:28 +02:00
} else {
2021-07-12 04:52:41 +02:00
let data = res . data ;
// Convert to string for object/array
if ( typeof data !== "string" ) {
data = JSON . stringify ( data )
}
if ( data . includes ( this . keyword ) ) {
2021-07-01 11:19:28 +02:00
bean . msg += ", keyword is found"
2021-07-24 05:42:14 +02:00
bean . status = UP ;
2021-07-01 11:19:28 +02:00
} else {
throw new Error ( bean . msg + ", but keyword is not found" )
}
}
2021-07-01 08:03:06 +02:00
} else if ( this . type === "port" ) {
bean . ping = await tcping ( this . hostname , this . port ) ;
2021-07-01 15:47:14 +02:00
bean . msg = ""
2021-07-24 05:42:14 +02:00
bean . status = UP ;
2021-07-01 11:00:23 +02:00
} else if ( this . type === "ping" ) {
bean . ping = await ping ( this . hostname ) ;
2021-07-01 15:47:14 +02:00
bean . msg = ""
2021-07-24 05:42:14 +02:00
bean . status = UP ;
2021-06-27 10:10:55 +02:00
}
2021-07-30 18:01:04 +02:00
if ( this . isUpsideDown ( ) ) {
bean . status = flipStatus ( bean . status ) ;
if ( bean . status === DOWN ) {
throw new Error ( "Flip UP to DOWN" ) ;
}
}
2021-07-19 18:23:06 +02:00
retries = 0 ;
2021-06-27 10:10:55 +02:00
} catch ( error ) {
2021-07-30 18:01:04 +02:00
bean . msg = error . message ;
// If UP come in here, it must be upside down mode
// Just reset the retries
if ( this . isUpsideDown ( ) && bean . status === UP ) {
retries = 0 ;
} else if ( ( this . maxretries > 0 ) && ( retries < this . maxretries ) ) {
2021-07-19 18:23:06 +02:00
retries ++ ;
2021-07-24 05:42:14 +02:00
bean . status = PENDING ;
2021-07-19 18:23:06 +02:00
}
2021-06-27 10:10:55 +02:00
}
2021-07-24 05:42:14 +02:00
// * ? -> ANY STATUS = important [isFirstBeat]
// UP -> PENDING = not important
// * UP -> DOWN = important
// UP -> UP = not important
// PENDING -> PENDING = not important
// * PENDING -> DOWN = important
// PENDING -> UP = not important
// DOWN -> PENDING = this case not exists
// DOWN -> DOWN = not important
// * DOWN -> UP = important
let isImportant = isFirstBeat ||
( previousBeat . status === UP && bean . status === DOWN ) ||
( previousBeat . status === DOWN && bean . status === UP ) ||
( previousBeat . status === PENDING && bean . status === DOWN ) ;
2021-07-20 11:50:33 +02:00
// Mark as important if status changed, ignore pending pings,
// Don't notify if disrupted changes to up
2021-07-24 05:42:14 +02:00
if ( isImportant ) {
2021-06-29 10:06:20 +02:00
bean . important = true ;
2021-07-09 11:55:48 +02:00
2021-07-24 05:42:14 +02:00
// Send only if the first beat is DOWN
if ( ! isFirstBeat || bean . status === DOWN ) {
2021-07-30 13:18:26 +02:00
let notificationList = await R . getAll ( "SELECT notification.* FROM notification, monitor_notification WHERE monitor_id = ? AND monitor_notification.notification_id = notification.id " , [
this . id ,
2021-07-09 19:15:21 +02:00
] )
2021-07-09 11:55:48 +02:00
2021-07-09 19:15:21 +02:00
let text ;
2021-07-24 05:42:14 +02:00
if ( bean . status === UP ) {
2021-07-09 19:15:21 +02:00
text = "✅ Up"
} else {
text = "🔴 Down"
}
2021-07-09 11:55:48 +02:00
2021-07-09 19:15:21 +02:00
let msg = ` [ ${ this . name } ] [ ${ text } ] ${ bean . msg } ` ;
2021-07-09 11:55:48 +02:00
2021-07-30 13:18:26 +02:00
for ( let notification of notificationList ) {
2021-07-22 06:28:47 +02:00
try {
await Notification . send ( JSON . parse ( notification . config ) , msg , await this . toJSON ( ) , bean . toJSON ( ) )
} catch ( e ) {
console . error ( "Cannot send notification to " + notification . name )
}
2021-07-09 19:15:21 +02:00
}
}
2021-07-09 11:55:48 +02:00
2021-06-29 10:06:20 +02:00
} else {
bean . important = false ;
}
2021-07-24 05:42:14 +02:00
if ( bean . status === UP ) {
2021-07-21 00:41:38 +02:00
console . info ( ` Monitor # ${ this . id } ' ${ this . name } ': Successful Response: ${ bean . ping } ms | Interval: ${ this . interval } seconds | Type: ${ this . type } ` )
2021-07-24 05:42:14 +02:00
} else if ( bean . status === PENDING ) {
2021-07-27 19:53:59 +02:00
console . warn ( ` Monitor # ${ this . id } ' ${ this . name } ': Pending: ${ bean . msg } | Max retries: ${ this . maxretries } | Type: ${ this . type } ` )
2021-07-21 00:41:38 +02:00
} else {
console . warn ( ` Monitor # ${ this . id } ' ${ this . name } ': Failing: ${ bean . msg } | Type: ${ this . type } ` )
}
2021-07-27 18:52:31 +02:00
prometheus . update ( bean )
2021-07-22 10:38:27 +02:00
2021-06-29 10:06:20 +02:00
io . to ( this . user _id ) . emit ( "heartbeat" , bean . toJSON ( ) ) ;
2021-06-27 10:10:55 +02:00
await R . store ( bean )
2021-07-01 08:03:06 +02:00
Monitor . sendStats ( io , this . id , this . user _id )
2021-06-29 10:06:20 +02:00
previousBeat = bean ;
2021-06-25 15:55:49 +02:00
}
beat ( ) ;
this . heartbeatInterval = setInterval ( beat , this . interval * 1000 ) ;
}
stop ( ) {
clearInterval ( this . heartbeatInterval )
}
2021-06-30 15:04:58 +02:00
2021-07-30 05:23:04 +02:00
/ * *
* Helper Method :
* returns URL object for further usage
* returns null if url is invalid
* @ returns { null | URL }
* /
2021-07-22 10:04:32 +02:00
getUrl ( ) {
try {
return new URL ( this . url ) ;
} catch ( _ ) {
return null ;
}
}
2021-07-30 05:23:04 +02:00
/ * *
* Store TLS info to database
* @ param checkCertificateResult
* @ returns { Promise < void > }
* /
2021-07-22 10:04:32 +02:00
async updateTlsInfo ( checkCertificateResult ) {
let tls _info _bean = await R . findOne ( "monitor_tls_info" , "monitor_id = ?" , [
2021-07-30 13:18:26 +02:00
this . id ,
2021-07-22 10:04:32 +02:00
] ) ;
if ( tls _info _bean == null ) {
tls _info _bean = R . dispense ( "monitor_tls_info" ) ;
tls _info _bean . monitor _id = this . id ;
}
tls _info _bean . info _json = JSON . stringify ( checkCertificateResult ) ;
2021-07-23 06:58:05 +02:00
await R . store ( tls _info _bean ) ;
2021-07-22 10:04:32 +02:00
}
2021-06-30 15:04:58 +02:00
static async sendStats ( io , monitorID , userID ) {
Monitor . sendAvgPing ( 24 , io , monitorID , userID ) ;
2021-07-01 07:11:16 +02:00
Monitor . sendUptime ( 24 , io , monitorID , userID ) ;
Monitor . sendUptime ( 24 * 30 , io , monitorID , userID ) ;
2021-07-22 10:04:32 +02:00
Monitor . sendCertInfo ( io , monitorID , userID ) ;
2021-06-30 15:04:58 +02:00
}
2021-07-01 07:11:16 +02:00
/ * *
*
* @ param duration : int Hours
* /
2021-06-30 15:04:58 +02:00
static async sendAvgPing ( duration , io , monitorID , userID ) {
let avgPing = parseInt ( await R . getCell ( `
SELECT AVG ( ping )
FROM heartbeat
2021-07-10 06:04:40 +02:00
WHERE time > DATETIME ( 'now' , ? || ' hours' )
2021-07-01 07:11:16 +02:00
AND ping IS NOT NULL
2021-06-30 15:04:58 +02:00
AND monitor _id = ? ` , [
- duration ,
2021-07-30 13:18:26 +02:00
monitorID ,
2021-06-30 15:04:58 +02:00
] ) ) ;
io . to ( userID ) . emit ( "avgPing" , monitorID , avgPing ) ;
}
2021-07-22 10:04:32 +02:00
static async sendCertInfo ( io , monitorID , userID ) {
2021-07-30 13:18:26 +02:00
let tls _info = await R . findOne ( "monitor_tls_info" , "monitor_id = ?" , [
monitorID ,
2021-07-22 10:04:32 +02:00
] ) ;
if ( tls _info != null ) {
io . to ( userID ) . emit ( "certInfo" , monitorID , tls _info . info _json ) ;
}
2021-07-21 06:09:09 +02:00
}
2021-07-01 07:11:16 +02:00
/ * *
2021-07-09 08:14:03 +02:00
* Uptime with calculation
* Calculation based on :
* https : //www.uptrends.com/support/kb/reporting/calculation-of-uptime-and-downtime
2021-07-01 07:11:16 +02:00
* @ param duration : int Hours
* /
static async sendUptime ( duration , io , monitorID , userID ) {
2021-07-01 11:00:23 +02:00
let sec = duration * 3600 ;
2021-07-11 14:07:03 +02:00
let heartbeatList = await R . getAll ( `
2021-07-09 08:14:03 +02:00
SELECT duration , time , status
2021-07-01 07:11:16 +02:00
FROM heartbeat
2021-07-10 06:04:40 +02:00
WHERE time > DATETIME ( 'now' , ? || ' hours' )
2021-07-01 07:11:16 +02:00
AND monitor _id = ? ` , [
- duration ,
2021-07-30 13:18:26 +02:00
monitorID ,
2021-07-01 11:00:23 +02:00
] ) ;
let downtime = 0 ;
2021-07-09 08:14:03 +02:00
let total = 0 ;
let uptime ;
2021-07-01 11:00:23 +02:00
2021-07-11 14:07:03 +02:00
// Special handle for the first heartbeat only
if ( heartbeatList . length === 1 ) {
2021-07-01 15:47:14 +02:00
2021-07-11 14:07:03 +02:00
if ( heartbeatList [ 0 ] . status === 1 ) {
uptime = 1 ;
} else {
uptime = 0 ;
}
} else {
for ( let row of heartbeatList ) {
let value = parseInt ( row . duration )
let time = row . time
2021-07-01 11:00:23 +02:00
2021-07-11 14:07:03 +02:00
// Handle if heartbeat duration longer than the target duration
// e.g. Heartbeat duration = 28hrs, but target duration = 24hrs
if ( value > sec ) {
2021-07-30 13:18:26 +02:00
let trim = dayjs . utc ( ) . diff ( dayjs ( time ) , "second" ) ;
2021-07-11 14:07:03 +02:00
value = sec - trim ;
if ( value < 0 ) {
value = 0 ;
}
}
total += value ;
2021-07-19 18:23:06 +02:00
if ( row . status === 0 || row . status === 2 ) {
2021-07-11 14:07:03 +02:00
downtime += value ;
2021-07-01 11:00:23 +02:00
}
}
2021-07-01 07:11:16 +02:00
2021-07-11 14:07:03 +02:00
uptime = ( total - downtime ) / total ;
if ( uptime < 0 ) {
uptime = 0 ;
2021-07-06 07:44:33 +02:00
}
2021-07-01 11:00:23 +02:00
}
2021-07-01 07:11:16 +02:00
io . to ( userID ) . emit ( "uptime" , monitorID , duration , uptime ) ;
2021-06-30 15:04:58 +02:00
}
2021-06-25 15:55:49 +02:00
}
module . exports = Monitor ;