hping 0.0.4 → 0.2.0

package/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: ci
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [20.x, 22.x, 24.x]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+      - run: npm ci
+      - run: npm test

package/README.md

@@ -1,35 +1,148 @@
-hPING
+hPING (HTTP ping)
 =====
 
-Node.js CLI that sends HTTP HEAD or GET or POST requests to any web or api servers.
+Node.js CLI that sends HTTP `HEAD`, `GET`, or `POST` requests to web/api servers.
 
-hPING is the fastest and easiest way to check or quickly monitor if http servers are alive.
+<img src="http://www.anothervision.com/img/github/hping.gif" width="1126"/>
+hPING is a quick way to check and monitor HTTP server availability.
+
+## Node.js Support
+
+- Supported: `Node.js 20+` (validated against current major runtimes, including Node `22+`).
 
 ## Installation
 
-The latest hPING version is installable via NPM:
+hPING is installable via npm:
 
 ```bash
 $ npm install hping -g
 ```
-If the above fails try this:
+
+## Usage
+
+hPING single server `www.google.com`:
+
+```bash
+$ hping www.google.com
+```
+
+hPING server `www.google.com` with a 10-second interval:
+
 ```bash
-$ npm install git://github.com/kurdin/hping#master -g
+$ hping www.google.com -i 10
 ```
-or
+
+hPING single server with `GET` method:
+
 ```bash
-$ git clone https://github.com/kurdin/hping
-$ cd hping 
-$ npm install 
-$ npm link 
+$ hping get www.google.com
 ```
 
-## Usage
+hPING multiple servers:
+
+```bash
+$ hping www.google.com www.apple.com www.microsoft.com
+```
+
+hPING group of servers from config file (default config: `~/.hping/hping.conf.yaml`):
+
+```bash
+$ hping "apple production"
+```
+
+hPING can mix group of servers and separate hosts with single command:
+
+```bash
+$ hping "apple production" www.github.com
+```
+
+Explicit `ping` command (modern style):
+
+```bash
+$ hping ping www.google.com
+```
+
+## Settings
+
+hPING default settings (`~/.hping/hping.conf.yaml`):
+
+```bash
+interval: 1 # (seconds) interval between hPING requests
+type: HEAD # (type or requests): HEAD, GET, POST, PUT
+timeout: 5000 # (milliseconds) request connection timeout
+use_colors: true # (true || false), use colors for hPING output
+show_stats_for_last: 100 # (number of requests) show hPING statistics for last X number of requests, set 0 to disable
+max_run_time: 600 # (seconds) hPING maximum running time, set 0 to disable
+
+log_status_change: false # (true || false) if true, hPING will log status changes to log file
+log_file: logs/hping.log # (path) to hPING log file, default path in users home .hping folder
+log_stats_on_exit: true # (true || false) if true, hPING will log statistics to file on exit
+
+display_in_output: # use true || fasle to turn on/off log output sections
+  status: true 
+  url: true
+  ip: true
+  type: false
+  status_code: true
+  status_info: true
+    server: true
+    content_length: false
+    response_time: true
+```
+
+Show hPING server groups:
+
+```bash
+$ hping servers
+```
+
+Display hPING current settings:
+
+```bash
+$ hping settings
+```
+
+hPING server `www.google.com` with custom config:
 
 ```bash
-$ hping www.google.com # hPING single server (www.google.com)
+$ hping www.google.com -c /etc/hping.conf.yaml
 ```
 
+## Help
+
+hPING quick usage help:
 
+```bash
+$ hping 
+usage: hping [ping|head|get|post] [http(s)://]www.webserver.com[:port] [another host] [server group]
+```
 
+hPING full help:
+
+```bash
+$ hping -h
+```
+
+## Log to file
+
+Enable status-change logging with `log_status_change: true`.
+
+Default log file location: `~/.hping/logs/hping.log` (override with `log_file`).
+
+## Development
+
+Install deps:
+
+```bash
+$ npm install
+```
+
+Run tests:
+
+```bash
+$ npm test
+```
 
+##License
+The MIT License (MIT)
+Copyright (c) 2014 Sergey Kurdin

package/bin/hping

@@ -2,384 +2,9 @@
 
 'use strict';
 
-var program = require('commander'),
-  util = require('util'),
-  fs = require('fs'),
-  log4js = require('log4js'),
-  dns = require('dns'),
-  path = require('path'),
-  color = require('cli-color'),
-  request = require('request'),
-  status_codes = require('../lib/status'),
-  config = require('yaml-config'),
-  helpers = require('../lib/helpers'),
-  info = 'hPING sends HEAD or GET or POST requests to web or api servers to check if they alive',
-  usage = '[head|get|post] [http(s)://]www.webserver.com[:port] [another host] [server group]',
-  hping_home_dir = getHPINGHome(),
-  defconfile = path.resolve(__dirname, '../config/hping.yaml'),
-  confile = path.resolve(hping_home_dir, 'hping.conf.yaml'),
-  colors = {
-    r: 'red',
-    g: 'green',
-    bb: 'blackBright',
-    u: 'underline',
-    m: 'magenta',
-    y: 'yellow'
-  },
-  defaults = {
-    confile: confile,
-    interval: 1
-  };
+const { runCli } = require('../lib/cli');
 
-var settings, stats = {},
-  logger_file;
-
-program
-  .version('0.0.4')
-  .usage(usage)
-  .option('-c, --config [' + confile + ']', 'hping config file in YAML format', defaults.confile)
-  .option('-i, --interval [1]', 'hping interval in seconds (set default in ' + confile + ')', defaults.interval);
-
-program
-  .command('servers')
-  .description('Show server groups information from config file')
-  .action(function() {
-    hping('servers');
-  });
-
-program
-  .command('settings')
-  .description('Show hPING settings from config file')
-  .action(function() {
-    hping('settings');
-  });
-
-program
-  .command('get')
-  .description('Sends HTTP GET requests to web or api server (set default in ' + confile + ')')
-  .action(function() {
-    if (program.args.length > 1) {
-      hping(program.args, 'GET');
-    } else {
-      console.log(usage);
-    }
-  });
-
-program
-  .command('post')
-  .description('Sends HTTP POST requests to web or api server (set default in ' + confile + ')')
-  .action(function() {
-    if (program.args.length > 1) {
-      hping(program.args, 'POST');
-    } else {
-      console.log(usage);
-    }
-  });
-
-program
-  .command('head')
-  .description('Sends HTTP HEAD requests to web or api server (set default in ' + confile + ')')
-  .action(function() {
-    if (program.args.length > 1) {
-      hping(program.args, 'HEAD');
-    } else {
-      console.log(usage);
-    }
-  });
-
-program
-  .on('*', function(e) {
-    hping(e);
-  });
-
-program.parse(process.argv);
-
-if (program.args.length < 1) {
-  console.log('usage: hping ' + usage);
-}
-
-function hping(args, type) {
-  fs.exists(confile, function(exists) {
-    if (exists) {
-      hping_run(args, type);
-    } else {
-      fs.mkdir(path.resolve(hping_home_dir), function(e) {
-        if (!e || (e && e.code === 'EEXIST')) {
-          fs.mkdir(path.resolve(hping_home_dir + '/logs'), function(e) {
-            fs.createReadStream(defconfile).pipe(fs.createWriteStream(confile)).on('error', function(err) {
-              console.log(err);
-            }).on('close', function() {
-              hping_run(args, type);
-            });
-          });
-        } else {
-          console.log(e);
-        }
-      });
-    }
-  });
-}
-
-function hping_run(args, type) {
-  var cnf = (program.config !== defaults.confile) ? program.config : defaults.confile;
-  settings = config.readConfig(cnf);
-  if (!settings.interval) {
-    console.error('Specified config file: %s could not be used, see error above. Using default config: %s', cnf, defaults.confile);
-    settings = config.readConfig(defaults.confile);
-    cnf = defaults.confile;
-  }
-  if (settings.log_status_change) logger_file = require('../lib/logger')(settings.log_file);
-  settings.interval = (program.interval === 1) ? settings.interval : program.interval;
-  if (args == 'servers') {
-    showServers();
-    return;
-  }
-  if (args == 'settings') {
-    showSettings(cnf);
-    return;
-  }
-  args.forEach(function(url) {
-    if (typeof url == 'string' || url instanceof String) {
-      if (settings.servers && settings.servers[url]) {
-        settings.servers[url].forEach(function(url) {
-          prerequest(url, type);
-        });
-      } else {
-        prerequest(url, type);
-      }
-    }
-  });
-}
-
-function prerequest(url, t) {
-  if (!/^(https?):\/\//i.test(url)) url = 'http://' + url;
-
-  var type = t || settings.type.toUpperCase(),
-    run_time = 0,
-    interval = ints(settings.interval),
-    max_run_time = ints(settings.max_run_time),
-    options = {
-      url: url,
-      timeout: ints(settings.timeout) || 5000,
-      method: type,
-      headers: {
-        'User-Agent': 'hPING [git.io/hping]'
-      }
-    };
-
-  dns.resolve4(require('url').parse(url).hostname, function(err, ip) {
-    if (err) ip = [''];
-    stats[url] = [];
-    (function dorequest() {
-      var start = new Date();
-      request(options, function(e, r) {
-        var res_time = new Date() - start;
-        var line = predisplay(e, r, url, type, ip[0], res_time);
-        display(line);
-      });
-      if (max_run_time === 0 || max_run_time > (interval * run_time)) {
-        setTimeout(dorequest, interval * 1000);
-        run_time++;
-      } else {
-        console.log('hPING: Maximum running time has been reached (set in config), exiting.');
-        gracefulExit();
-      }
-    })();
-  });
-}
-
-function predisplay(err, res, url_org, type, ip, ms) {
-  var hcode, hlength, hserver, hinfo, hip, htime, code, status_color, empty,
-    sdo = settings.display_in_output,
-    status = '[UP]',
-    down = '[DOWN]',
-    hstatus = status,
-    htype = cc('type', type.toLowerCase()),
-    hurl = url_org,
-    line = [],
-    url_p = require('url').parse(url_org);
-
-  if (ip && hurl.indexOf(ip) == -1) hip = '(' + ip + ')';
-  if (err && err.code) {
-    code = 'error';
-    status_color = colors.r;
-    status = down;
-    hcode = cc('error', err.code.toLowerCase(), colors.r);
-    ms = 0;
-    switch (err.code) {
-      case 'ETIMEDOUT':
-        hinfo = cc('info', 'connection_timeout', colors.r);
-        break;
-      case 'ENOTFOUND':
-        hinfo = cc('info', 'server_not_found', colors.r);
-        break;
-      case 'ECONNRESET':
-        hinfo = cc('info', 'connection_closed', colors.r);
-        break;
-      case 'ECONNREFUSED':
-        hinfo = cc('info', 'connection_refused', colors.r);
-        break;
-    }
-  } else if (res && res.headers) {
-    htime = cc('time', ms, colors.u, 'ms');
-    code = res.statusCode;
-    status_color = statusColor(code);
-    if (code >= 500) status = down;
-    hcode = cc('code', code, (status_color !== colors.g) ? status_color : '');
-    if (status_codes[code]) hinfo = cc('info', status_codes[code].replace(/\s+/g, '_'), (status_color !== colors.g) ? status_color : '');
-    if (res.headers['content-length'] && res.headers['content-length'] > 0) hlength = 'content-length=' + res.headers['content-length'];
-    if (res.headers.server) hserver = 'server=' + res.headers.server;
-  } else {
-    status = hstatus = 'unknown_error';
-  }
-
-  hurl = hurl.replace(url_p.hostname, colr('bold', colr(status_color, url_p.hostname))).replace(url_p.port, colr('bold', colr(status_color, url_p.port)));
-  if (url_p.path && url_p.path != '/' && code !== 'error') hurl = hurl.replace(url_p.path, colr(status_color, url_p.path));
-  hstatus = colr('bold', colr(status_color, status));
-  hip = colr(colors.bb, hip);
-
-  line = [
-    'hPING:', (sdo.status) ? hstatus : empty, (sdo.url) ? hurl : empty, (sdo.ip) ? hip : empty, (sdo.type) ? htype : empty, (sdo.status_code) ? hcode : empty, (sdo.status_info) ? hinfo : empty, (sdo.server) ? hserver : empty, (sdo.content_length) ? hlength : empty, (sdo.response_time) ? htime : empty
-  ];
-
-  if (stats[url_org].length >= ints(settings.stats_for_last)) stats[url_org].shift();
-  if (settings.log_status_change) {
-    if (stats[url_org][stats[url_org].length - 1] === undefined || (stats[url_org][stats[url_org].length - 1] !== undefined && stats[url_org][stats[url_org].length - 1].status !== status)) {
-      log(line);
-    }
-  }
-  stats[url_org].push({
-    status: status,
-    code: code,
-    time: ms
-  });
-
-  return line;
-}
-
-function showServers() {
-  console.log(info, (settings.servers) ? '\nServer groups (set in config):' + pp(settings.servers) : '', 'usage: hping ' + usage);
-}
-
-function showSettings(cnf) {
-  console.log('Settings from config file: %s %s', cnf, pp(settings));
-}
-
-function display(line) {
-  console.log(pline(line));
-}
-
-function log(line) {
-  if (settings.log_status_change) logger_file.info(pline(line));
-}
-
-function gracefulExit() {
-  if (ints(settings.show_stats_for_last) > 0) {
-    for (var url in stats) {
-      if (url) {
-        display(displayStat(url));
-        if (settings.log_stats_on_exit) log(displayStat(url));
-      }
-    }
-  }
-  log4js.shutdown(function() {
-    process.exit(1);
-  });
-}
-
-function statusColor(code) {
-  var status_color = colors.g;
-
-  if (code >= 500 || code == 'error') {
-    status_color = colors.r;
-  } else if (code >= 400) {
-    status_color = colors.y;
-  }
-  return status_color;
-}
-
-function displayStat(url) {
-  if (stats[url].length === 0) return;
-
-  var codes = [],
-    out = [],
-    total = {
-      requests: stats[url].length,
-      codes: {},
-      time: [],
-      up: 0,
-      down: 0
-    },
-    timesrange,
-    requests = '[' + ((total.requests > settings.show_stats_for_last) ? 'last ' : '') + total.requests + ' requests] ',
-    stat_line = '\n--- ' + url + ' hPING statistics ' + requests + '---\n';
-
-  stats[url].forEach(function(stat) {
-
-    if (!total.codes[stat.code]) total.codes[stat.code] = 1;
-    else total.codes[stat.code]++;
-
-    if (stat.status == '[UP]') total.up++;
-    else total.down++;
-
-    if (stat.time > 0) total.time.push(stat.time);
-  });
-
-  for (var code in total.codes) {
-    if (code) codes.push(statProcess(code, total.codes[code], total.requests, statusColor(code), ''));
-  }
-
-  timesrange = total.time.range();
-
-  out = [
-    stat_line,
-    statProcess('UP', total.up, total.requests, colors.g, 'bold'),
-    statProcess('DOWN', total.down, total.requests, colors.r, 'bold'),
-    codes.join(' '), (timesrange.min) ? 'time(min=' + timesrange.min + ' avg=' + timesrange.avg + ' max=' + timesrange.max + ')ms' : ''
-  ];
-
-  function statProcess(lb, tv, tr, tc, tb) {
-    if (lb === 'error') lb += 's';
-    var st = lb + '=' + Math.floor10((tv / tr) * 100) + '%';
-    return (tv > 0) ? colr(tb, colr(tc, st)) : '';
-  }
-
-  return out;
-}
-
-process.on('SIGTERM', function() {
-  gracefulExit();
-}).on('SIGINT', function() {
-  gracefulExit();
+runCli(process.argv.slice(2)).catch((error) => {
+  console.error(error.message || error);
+  process.exitCode = 1;
 });
-
-function cc(s1, s2, c, s3) {
-  if (!s3) s3 = '';
-  return (c && settings.use_colors) ? s1 + '=' + (color[c](s2)) + s3 : s1 + '=' + s2 + s3;
-}
-
-function colr(c, s) {
-  return (!settings.use_colors || !c) ? s : color[c](s);
-}
-
-function ints(s) {
-  return parseInt(s, 10);
-}
-
-function pp(s) {
-  return JSON.stringify(s, null, ' ').replace(/[{}]|\,|[\[\]]|/g, '').replace(/\n\s*\n\s*\n/g, '\n');
-}
-
-function pline(l) {
-  if (util.isArray(l)) {
-    l = l.filter(function(e) {
-      return e;
-    });
-    return l.join(' ').replace(/\n\s/g, '\n');
-  }
-  return '';
-}
-
-function getHPINGHome() {
-  return path.resolve(process.env.HOME || process.env.HOMEPATH || process.env.USERPROFILE, '.hping/');
-}

package/config/hping.yaml

@@ -1,17 +1,18 @@
 default:
 
   interval: 1 # (seconds) interval between hPING requests
-  type: HEAD # (type or requests): HEAD, GET, POST, PUT
+  type: HEAD # (request type): HEAD, GET, POST
   timeout: 5000 # (milliseconds) request connection timeout
   use_colors: true # (true || false), use colors for hPING output
   show_stats_for_last: 100 # (number of requests) show hPING statistics for last X number of requests, set 0 to disable
+  stats_for_last: 100 # (number of requests) keep stats for last X requests per target
   max_run_time: 600 # (seconds) hPING maximum running time, set 0 to disable
 
   log_status_change: false # (true || false) if true, hPING will log status changes to log file
   log_file: logs/hping.log # (path) to hPING log file, default path in users home .hping folder
   log_stats_on_exit: true # (true || false) if true, hPING will log statistics to file on exit
 
-  display_in_output: # use true || fasle to turn on/off log output sections
+  display_in_output: # use true || false to turn on/off log output sections
     status: true 
     url: true
     ip: true