Content
- Nagios Plugins
- Nagios Tools
- Nagios Plugins: XRPL Validator
- XRPL Validator: Server Check
- Nagios Plugins: Flare Networks
- Flare Networks: Check Network Fees
- Flare Networks: Check Avalanche Version
- Flare Networks: Check Network ID
- Flare Networks: Check Peers
- Nagios Interface
Recent Updates

Nagios Plugins

Date: 8th June 2021

Nagios is an open source software application that can be used to monitor computer systems, networks and infrastructure. It also can be configured to send alerts.

You can install Nagios here, be sure to understand the configuration options available for Nagios before installing any plugins.

Our Nagios server runs on a Raspberry Pi 4.

Nagios Tools

We have written some Nagios tools that help us monitor our XRPL Validator, FTSO Data provider and out Flare Networks' Node.

We wrote these tools in Nodejs as this is a requirement for the Flare Networks' Node.

Nagios Plugins: XRPL Validator

The following Nagios software can be used to monitor your XRPL Validator and XRPL Stock Server.

XRPL Validator: Server Check

This module checks the server_info using HTTP. It verifies that the XRPL Validator is up and running, periodically outputting its history, (complete_ledgers) and latency (io_latency_ms) amongst other information.

//usage
// node xrpl_rippleServerCheck.js [your node IP] [your port]

const https = require('http');
var params = process.argv.slice(2);
var obj;
var extCode = 0;
var log = [];
var stringedData = '';

const data = JSON.stringify({
    "method": "server_info",
    "params": [
        {}
    ]
});

const options = {
  hostname: params[0], //server IP
  port: params[1],    //5005
  path: '/',
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length
  }
}

const req = https.request(options, res => {
  if(res.statusCode != 200) {
      console.log("Service Down: HTTP status code"+res.statusCode);
      extCode = 2;
  }

  res.on('data', d => {
    obj = JSON.parse(d);
//    console.log(obj.info);
    log[log.length] = "IP: RPC: "+params[0]+":"+params[1]
                +', Build Version: '
                +obj.result.info.build_version
                +', complete_ledgers: '
                +obj.result.info.complete_ledgers
                +', pubkey_node: '+obj.result.info.pubkey_node
                +', server_state: '+obj.result.info.server_state
                +', time: '+obj.result.info.time + "|";

    log[log.length] = 'connected: duration_us:'+obj.result.info.state_accounting.connected.duration_us+" transitions:"+obj.result.info.state_accounting.connected.transitions;
    log[log.length] = 'disconnected: duration_us:'+obj.result.info.state_accounting.disconnected.duration_us+" transitions:"+obj.result.info.state_accounting.disconnected.transitions;
    log[log.length] = 'full: duration_us:'+obj.result.info.state_accounting.full.duration_us+" transitions:"+obj.result.info.state_accounting.full.transitions;
    log[log.length] = 'syncing: duration_us:'+obj.result.info.state_accounting.syncing.duration_us+" transitions:"+obj.result.info.state_accounting.syncing.transitions;
    log[log.length] = 'tracking: duration_us:'+obj.result.info.state_accounting.tracking.duration_us+" transitions:"+obj.result.info.state_accounting.tracking.transitions;

    for(var n = 0;n < log.length; n++) {
        stringedData = stringedData +log[n]+'\r\n';
    }
    console.log(stringedData);
  })
})

req.on('error', error => {
  console.log('ERROR');
  extCode = 2;
});

req.write(data);
req.end();

process.on('exit', (code) => {
    process.exit(extCode);
});

Nagios Plugins: Flare Networks

The following Nagios plugin software can be used to monitor your Flare Networks' node.

Flare Networks: Check Network Fees

This module outputs any network fees associated to the Flare Networks.

//flare_get_node_gettxfee.js [IP ADDRESS] [PORT] 2000000 3000000 2000000 3000000 
//                                                                     |--txfee critical
//                                                              |--txfee warning
//                                                      |--creation fee critical
//                                             |--creation fee warning
const https = require('http');
var params = process.argv.slice(2);
var obj;
var peers;
var log = [];
var creationFeeWarning = params[2] * 1;
var creationFeeCritical = params[3]* 1;
var creationFeeRes = '';
var txFeeWarning = params[4]* 1;
var txFeeCritical = params[5]* 1;
var txFeeRes = '';
const data = JSON.stringify({
    "jsonrpc":"2.0",
    "id"     :1,
    "method" :"info.getTxFee"
});

const options = {
  hostname: params[0], //server IP
  port: params[1],    //9650
  path: '/ext/info',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length
  }
}

const req = https.request(options, res => {
  //console.log(`statusCode: ${res.statusCode}`);
  
  if(res.statusCode != 200) {
      console.log("Service Down: HTTP status code"+res.statusCode);
      creationFeeRes = creationFeeCritical + 1;
  }

  res.on('data', d => {
    obj = JSON.parse(d);
    peers = obj.result.peers;
    creationFeeRes = obj.result.creationTxFee * 1;
    txFeeRes = obj.result.txFee * 1;
    console.log("Creation Fee:"+creationFeeRes+". Transaction Fee:"+txFeeRes);
  })
})

req.on('error', error => {
  console.error(error);
});

req.write(data);
req.end();

process.on('exit', (code) => {    
  if(creationFeeRes >= creationFeeCritical) {           
    process.exit(2);
  }
  
  if(txFeeRes >= txFeeCritical) {      
    process.exit(2);
  }
  
  if(txFeeRes >= creationFeeWarning) {      
    process.exit(1);
  }
  
  if(txFeeRes >= creationFeeWarning) {      
    process.exit(1);
  } 
  
    process.exit(0);
 
});

Flare Networks: Check Avalanche Version

Outputs the Avalanche version is running on the Flare Networks' node. This is useful when or if the Flare Networks' node software is updated.

//usage 
// node flare_get_node_version.js [IP Address] [Port Number]

const https = require('http');
var params = process.argv.slice(2);
var obj;
var extCode = 0;

const data = JSON.stringify({
    "jsonrpc":"2.0",
    "id"     :1,
    "method" :"info.getNodeVersion"
});

const options = {
  hostname: params[0], //server IP
  port: params[1],    //9650
  path: '/ext/info',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length
  }
}

const req = https.request(options, res => {
  if(res.statusCode != 200) {
      console.log("Service Down: HTTP status code"+res.statusCode); 
      extCode = 2;
  }

  res.on('data', d => {
    obj = JSON.parse(d);
    console.log("Node Version: "+obj.result.version);
  })
})

req.on('error', error => {
  console.log('ERROR');  
  extCode = 2;
});

req.write(data);
req.end();

process.on('exit', (code) => {                  
    process.exit(extCode);
});

Flare Networks: Get Node ID

//usage 
// node flare_get_node_id.js [IP Address] [Port]

const https = require('http');
var params = process.argv.slice(2);
var obj;
var extCode = 0;

const data = JSON.stringify({
    "jsonrpc":"2.0",
    "id"     :1,
    "method" :"info.getNodeID"
});

const options = {
  hostname: params[0], //server IP
  port: params[1],    //9650
  path: '/ext/info',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length
  }
}

const req = https.request(options, res => {
  if(res.statusCode != 200) {
      console.log("Service Down: HTTP status code"+res.statusCode); 
      extCode = 2;
  }

  res.on('data', d => {
    obj = JSON.parse(d);
    console.log(obj.result.nodeID);
  })
})

req.on('error', error => {
  console.log('ERROR');  
  extCode = 2;
});

req.write(data);
req.end();

process.on('exit', (code) => {                  
    process.exit(extCode);
});

Flare Networks: Check Chain Bootstrapped

//usage 
// node flare_get_node_bootstrapped.js [IP ADDRESSS] [PORT] [Chain]

const https = require('http');
var params = process.argv.slice(2);
var obj;
var extCode = 0;

const data = JSON.stringify({
    "jsonrpc":"2.0",
    "id"     :1,
    "method" :"info.isBootstrapped",
    "params": {
        "chain": params[2]
    }
});

const options = {
  hostname: params[0], //server IP
  port: params[1],    //9650
  path: '/ext/info',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length
  }
}

const req = https.request(options, res => {
   if(res.statusCode != 200) {
      console.log("Service Down: HTTP status code"+res.statusCode); 
      extCode = 2;
  }

  res.on('data', d => {
    obj = JSON.parse(d);    
    if(obj.result.isBootstrapped == true) {
        console.log("Chain "+params[2]+" is bootstrapped - "+obj.result.isBootstrapped);
    } else {
        extCode = 1;
        console.log("Chain "+params[2]+" is not bootstrapped - "+obj.result.isBootstrapped);
    }    
  })
})

req.on('error', error => {
  console.error(error);
});

req.write(data);
req.end();

process.on('exit', (code) => {                  
    process.exit(extCode);
});

Flare Networks: Check Network ID

Outputs the Chain ID. Useful when connecting wallets to your Flare Networks' node such as Metamask.

//usage 
// node flare_get_node_network_id.js [IP Address] [Port]

const https = require('http');
var params = process.argv.slice(2);
var obj;
var extCode = 0;

const data = JSON.stringify({
    "jsonrpc":"2.0",
    "id"     :1,
    "method" :"info.getNetworkID"
});

const options = {
  hostname: params[0], //server IP
  port: params[1],    //9650
  path: '/ext/info',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length
  }
}

const req = https.request(options, res => {
  if(res.statusCode != 200) {
      console.log("Service Down: HTTP status code"+res.statusCode); 
      extCode = 2;
  }

  res.on('data', d => {
    obj = JSON.parse(d);
    console.log("Flare Network ID: "+obj.result.networkID);
  })
})

req.on('error', error => {
  console.log('ERROR');  
  extCode = 2;
});

req.write(data);
req.end();

process.on('exit', (code) => {                  
    process.exit(extCode);
});

Flare Networks: Check Peers

Warns if it is taking a long time to communicate with peers. Indication of a connection issue or remote peer is down.

//usage 
// node flare_get_node_peers.js [IP Address] [Port] 60 120
//                                                      |-critical
//                                                  |-warning
const https = require('http');
var params = process.argv.slice(2);
var warningElapsed = params[2];
var criticalElapsed = params[3];
var test = '';
var obj;
var peers;
var markProblem = false;
var log = [];
var extCode = 0;
var stringedData = '';
var now = new Date;
var firstLineText = '';
var utc_timestamp = Date.UTC(
                now.getUTCFullYear(),
                now.getUTCMonth(),
                now.getUTCDate(), 
                now.getUTCHours(),
                now.getUTCMinutes(),
                now.getUTCSeconds(),
                now.getUTCMilliseconds()
    );

const data = JSON.stringify({
    "jsonrpc":"2.0",
    "id"     :1,
    "method" :"info.peers"
});

const options = {
  hostname: params[0], //server IP
  port: params[1],    //9650
  path: '/ext/info',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length
  }
}

const req = https.request(options, res => {
  if(res.statusCode != 200) {
      console.log("Service Down: HTTP status code"+res.statusCode); 
      extCode = 2;
  }

  res.on('data', d => {
    obj = JSON.parse(d);    
    peers = obj.result.peers;
    for(var n = 0;n < peers.length; n++) {
        markProblem = false;
        test = defineDatesDiffInSeconds(peers[n].lastSent, utc_timestamp);
        if(test >= warningElapsed) {                
                markProblem = true;
                
                if(extCode < 1) {
                    extCode = 1;
                }
           }
           
           test = defineDatesDiffInSeconds(peers[n].lastReceived, utc_timestamp);
           if(test >= criticalElapsed) {                
                markProblem = true;
                if(extCode < 2) {
                    extCode = 2;
                }
           }
        
        log[log.length] = peers[n].nodeID;
        log[log.length] = " --  "+peers[n].ip;
        log[log.length] = " --  "+peers[n].publicIP;        
        log[log.length] = " --  "+peers[n].version;
        log[log.length] = " --  "+peers[n].lastSent + " Last Sent";
        log[log.length] = " --  "+peers[n].lastReceived + "Last Received";
        if(markProblem == true) {
            log[log.length] = " `- ERROR";
            firstLineText = firstLineText+ peers[n].nodeID +' - ERROR, ';
        } else {
            log[log.length] = " `- OK";
            firstLineText = firstLineText + peers[n].nodeID +' - OK, ';
        }
    }
    
    for(var n = 0;n < log.length; n++) {
        stringedData = stringedData +log[n]+'\r\n';
    }
if(markProblem == true) {
      console.log(firstLineText + '\r\n' + stringedData);
} else {    
    console.log(firstLineText + '\r\n' + stringedData);
}
  })
})

req.on('error', error => {
  console.log('ERROR');
  extCode = 2;
});

req.write(data);
req.end();

process.on('exit', (code) => {                  
    process.exit(extCode);
});

function defineDatesDiffInSeconds(from, to) {
    var startDate = new Date(from);//.parse(""+from+"");    
    //startDate.parse(""+from+"");
    // Do your operations
    var endDate = new Date(to);//.parse(""+to+"");
    //endDate.parse(""+to+"");
    var seconds = (endDate.getTime() - startDate.getTime()) / 1000;
    return seconds;
}

Nagios Interface

Once installed correctly, you should begin seeing Nagios output as follows.