Installation

npm install cronitor --save# oryarn add cronitor

Monitoring Background Jobs

Integrate with Cron Libraries

constcron=require('cronitor')('cronitor_api_key');constnodeCron=require('node-cron');cron.wraps(nodeCron);// the first parameter is now the key that Cronitor will use// to send telemetry events when the jobs runs, completes or failscron.schedule('SendWelcomeEmail','*/5 * * * *',()=>{console.log('Sending welcome email to new sign ups every five minutes.');});

Monitor Any Function

constcronitor=require('cronitor')('cronitor_api_key');letasyncWorker=cronitor.wrap('background-worker',async()=>{// do some async work});// cronitor will track the start and end time and state (promise resolved or rejected).awaitasyncWorker();

Monitor long running processes

constcronitor=require('cronitor')('cronitor_api_key');const{ Consumer}=require('sqs-consumer');event=newcronitor.Event('monitor-key');constapp=Consumer.create({queueUrl:'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',pollingWaitTimeMs:100,// duration to wait before repolling the queue (defaults to 0).handleMessage:async(message)=>{// do some work with `message`}});// Consumer is an event emitter and will emit one of the below events each time it is called.// a message was processedapp.on('processed_message',()=>{// increment the tick counter, no other side effects.event.tick();});// the queue is emptyapp.on('empty',()=>{// record a tick and also record that no message was processedevent.tick(0);});// an error occurred connectiong to SQSapp.on('error',(err)=>{// .error is a special "tick" method for reporting error counts.// Use it to tell Cronitor your program is still running, but encountering errors.// Error rate alert thresholds are configurable.event.error();});onconapp.start();

Sending Telemetry Events

constmonitor=newcronitor.Monitor('heartbeat-monitor');// send a heartbeat eventmonitor.ping();// optional params can be passed as an object.// for a complete list see https://cronitor.io/docs/ping-apimonitor.ping({state:'run|complete|fail|ok',// run/complete|fail used to measure lifecycle of a job.env:'',// the environment this is running in (development, staging, production)message:'',// optional message that will be displayed in alerts as well as monitor activity panel on your dashboard.metrics:{duration:100,count:4500,error_count:10}});

Configuring Monitors

Yaml Configuration File

constcronitor=require('cronitor')('apiKey123');cronitor.readConfig({path:'./cronitor.yaml'});// parse the yaml file of monitorscronitor.validateConfig({path:'./cronitor.yaml'});// send monitors to Cronitor for configuration validationcronitor.applyConfig({path:'./cronitor.yaml'});// sync the monitors from the config file to Cronitorcronitor.generateConfig({path:'./cronitor.yaml'});// generate a new config file from the Cronitor API

jobs:nightly-database-backup:schedule:0 0 * * *notify:            -devops-alert-pagerdutyassertions:            -metric.duration < 5 minutessend-welcome-email:schedule:every 10 minutesassertions:            -metric.count > 0            -metric.duration < 30 secondschecks:cronitor-homepage:request:url:https://cronitor.ioregions:                -us-east-1                -eu-central-1                -ap-northeast-1assertions:            -response.code = 200            -response.time < 2scronitor-ping-api:request:url:https://cronitor.link/pingassertions:            -response.body contains ok            -response.time < .25sheartbeats:production-deploy:notify:alerts:['deploys-slack']events:true# send alert when the event occurs

Async Uploads

Monitor.put

constcronitor=require('cronitor')('apiKey123');constjobMonitor=awaitcronitor.Monitor.put({type:'job',key:'send-customer-invoices',schedule:'0 0 * * *',assertions:['metric.duration < 5 min'],notify:['devops-alerts-slack']});constuptimeMonitor=awaitcronitor.Monitor.put({type:'check',key:'Cronitor Homepage',schedule:'every 45 seconds',request:{url:'https://cronitor.io'},assertions:['response.code = 200','response.time < 600ms']})

Pause, Reset, Delete

constmonitor=newcronitor.Monitor('heartbeat-monitor');monitor.pause(24)// pause alerting for 24 hoursmonitor.unpause()// alias for .pause(0)monitor.ok()// reset to a passing state alias for monitor.ping({state: ok})monitor.delete()// destroy the monitor

Package Configuration

constcronitor=require('cronitor')('cronitor_api_key',{apiVersion:'2020-10-01',environment:'staging',timeout:5000,region:'eu'});

Contributing

To contribute

git clone git@github.com:your-username/cronitor-js.git

npm install

npm test

npm test