domain-check-tool

Sumary

For monitor a list of hosts using HTTP, ICMP and PORT check.

Credits

Without those libs this project won't work!

PING | CLI-TABLE3 | COLORS | IS-PORT-REACHABLE | AXIOS | LODASH

Examples

import { checkHosts, IHost, RequestType } from './index';

const hosts: IHost[] = [
    {
        host: 'https://google.com',
        identifier: 'HTTPS',
    },
    {
        host: 'http://google.com',
        identifier: 'HTTP',
    },
    {
        host: 'www.google.com',
        identifier: 'WWW',
    },
    {
        host: 'https://www.google.com',
        identifier: 'HTTPS + WWW',
    },
    {
        host: 'http://www.google.com',
        identifier: 'HTTP + WWW',
    },
    {
        host: 'https://google.com',
        identifier: 'HEADER',
        httpRequestType: RequestType.GET,
        header: { user: 'user' },
    },
    {
        host: 'https://google.com',
        identifier: 'BODY. ALSO THIS ONE WILL RETURN BAD REQUEST',
        httpRequestType: RequestType.GET,
        body: { test: 'test' },
    },
    {
        host: 'google.com',
        identifier: 'HOST',
        bypassHttp: true,
    },
    {
        host: 'https://google.com',
        identifier: 'PORT',
        port: 80,
        bypassHttp: true,
    },
    {
        host: 'google.com',
        identifier: 'INVALID URL',
        httpRequestType: RequestType.GET,
        port: 80,
        header: null,
        body: null,
        bypassHttp: false,
        bypassPing: false,
        bypassPort: false
    },
    {
        host: 'https://unknowmhostfortest.com',
        identifier: 'UNKNOW HOST',
        httpRequestType: RequestType.GET,
        port: 80,
        header: null,
        body: null,
        bypassHttp: false,
        bypassPing: false,
        bypassPort: false
    },
    {
        host: 'https://google.com',
        identifier: 'COMPLETE',
        httpRequestType: RequestType.GET,
        port: 80,
        header: null,
        body: null,
        bypassHttp: false,
        bypassPing: false,
        bypassPort: false
    },
]

checkHosts(hosts, true).then(response => console.log(response));

Table printed

┌────────┬─────────────────────────────────────────────┬────────────────────────────────┬─────────────┬─────────┬────────┬───────┐
│ STATUS │ IDENTIFIER                                  │ HOST                           │    HTTP     │  PORT   │  PING  │ LOSS% │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏹    │ WWW                                         │ www.google.com                 │   INVALID   │ SKIPPED │ PASSED │ 0.000 │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏺    │ HOST                                        │ google.com                     │   SKIPPED   │ SKIPPED │ PASSED │ 0.000 │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏹    │ UNKNOW HOST                                 │ https://unknowmhostfortest.com │  ENOTFOUND  │  ERROR  │ ERROR  │ ERROR │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏺    │ PORT                                        │ https://google.com             │   SKIPPED   │ PASSED  │ PASSED │ 0.000 │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏹    │ INVALID URL                                 │ google.com                     │   INVALID   │ PASSED  │ PASSED │ 0.000 │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏺    │ HTTP + WWW                                  │ http://www.google.com          │     OK      │ SKIPPED │ PASSED │ 0.000 │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏹    │ BODY. ALSO THIS ONE WILL RETURN BAD REQUEST │ https://google.com             │ BAD REQUEST │ SKIPPED │ PASSED │ 0.000 │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏺    │ HTTPS + WWW                                 │ https://www.google.com         │     OK      │ SKIPPED │ PASSED │ 0.000 │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏺    │ HTTP                                        │ http://google.com              │     OK      │ SKIPPED │ PASSED │ 0.000 │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏺    │ HTTPS                                       │ https://google.com             │     OK      │ SKIPPED │ PASSED │ 0.000 │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏺    │ HEADER                                      │ https://google.com             │     OK      │ SKIPPED │ PASSED │ 0.000 │
├────────┼─────────────────────────────────────────────┼────────────────────────────────┼─────────────┼─────────┼────────┼───────┤
│   ⏺    │ COMPLETE                                    │ https://google.com             │     OK      │ PASSED  │ PASSED │ 0.000 │
└────────┴─────────────────────────────────────────────┴────────────────────────────────┴─────────────┴─────────┴────────┴───────┘

Object returned

[
  {
    isAlive: false,
    hostIdentifier: 'UNKNOW HOST',
    host: 'https://unknowmhostfortest.com',
    http: 'ENOTFOUND',
    ping: 'ERROR',
    port: 'ERROR',
    packetLoss: 'ERROR'
  },
  {
    isAlive: false,
    hostIdentifier: 'WWW',
    host: 'www.google.com',
    http: 'INVALID',
    ping: 'PASSED',
    port: 'SKIPPED',
    packetLoss: '0.000'
  },
  {
    isAlive: true,
    hostIdentifier: 'HOST',
    host: 'google.com',
    http: 'SKIPPED',
    ping: 'PASSED',
    port: 'SKIPPED',
    packetLoss: '0.000'
  },
  {
    isAlive: true,
    hostIdentifier: 'PORT',
    host: 'https://google.com',
    http: 'SKIPPED',
    ping: 'PASSED',
    port: 'PASSED',
    packetLoss: '0.000'
  },
  {
    isAlive: false,
    hostIdentifier: 'INVALID URL',
    host: 'google.com',
    http: 'INVALID',
    ping: 'PASSED',
    port: 'PASSED',
    packetLoss: '0.000'
  },
  {
    isAlive: true,
    hostIdentifier: 'HTTP + WWW',
    host: 'http://www.google.com',
    http: 'OK',
    ping: 'PASSED',
    port: 'SKIPPED',
    packetLoss: '0.000'
  },
  {
    isAlive: false,
    hostIdentifier: 'BODY. ALSO THIS ONE WILL RETURN BAD REQUEST',
    host: 'https://google.com',
    http: 'BAD REQUEST',
    ping: 'PASSED',
    port: 'SKIPPED',
    packetLoss: '0.000'
  },
  {
    isAlive: true,
    hostIdentifier: 'HTTPS + WWW',
    host: 'https://www.google.com',
    http: 'OK',
    ping: 'PASSED',
    port: 'SKIPPED',
    packetLoss: '0.000'
  },
  {
    isAlive: true,
    hostIdentifier: 'HTTP',
    host: 'http://google.com',
    http: 'OK',
    ping: 'PASSED',
    port: 'SKIPPED',
    packetLoss: '0.000'
  },
  {
    isAlive: true,
    hostIdentifier: 'HTTPS',
    host: 'https://google.com',
    http: 'OK',
    ping: 'PASSED',
    port: 'SKIPPED',
    packetLoss: '0.000'
  },
  {
    isAlive: true,
    hostIdentifier: 'HEADER',
    host: 'https://google.com',
    http: 'OK',
    ping: 'PASSED',
    port: 'SKIPPED',
    packetLoss: '0.000'
  },
  {
    isAlive: true,
    hostIdentifier: 'COMPLETE',
    host: 'https://google.com',
    http: 'OK',
    ping: 'PASSED',
    port: 'PASSED',
    packetLoss: '0.000'
  }
]

Using with EXPRESS

import express from 'express';
import { checkHosts, IHost, RequestType } from 'domain-check-tool';

const server = express();

server.get('/testGET', (req, res) => {
    res.send(200);
});

server.post('/testPOST', (req, res) => {
    res.send(200);
});

server.delete('/testDELETE', (req, res) => {
    res.send(200);
});

server.put('/testPUT', (req, res) => {
    res.send(200);
});

server.get('/test400', (req, res) => {
    res.send(400);
});

server.get('/test500', (req, res) => {
    res.send(500);
});



server.listen(3333, () => {
    const hosts: IHost[] = [
        {
            host: 'http://localhost:3333/testGET',
            identifier: 'GET',
            bypassPing: true,
            bypassUrlValidation: true,
        },
        {
            host: 'http://localhost:3333/testPOST',
            httpRequestType: RequestType.POST,
            identifier: 'POST',
            bypassPing: true,
            bypassUrlValidation: true,
        },
        {
            host: 'http://localhost:3333/testDELETE',
            httpRequestType: RequestType.DELETE,
            identifier: 'DELETE',
            bypassPing: true,
            bypassUrlValidation: true,
        },
        {
            host: 'http://localhost:3333/testPUT',
            httpRequestType: RequestType.PUT,
            identifier: 'PUT',
            bypassPing: true,
            bypassUrlValidation: true,
        },
        {
            host: 'http://localhost:3333/test400',
            identifier: '400',
            bypassPing: true,
            bypassUrlValidation: true,
        },
        {
            host: 'http://localhost:3333/test500',
            identifier: '500',
            bypassPing: true,
            bypassUrlValidation: true,
        },
    ]
    
    checkHosts(hosts, true);
});

Table printed

┌────────┬────────────┬──────────────────────────────────┬───────────────────────┬─────────┬─────────┬─────────┐
│ STATUS │ IDENTIFIER │ HOST                             │         HTTP          │  PORT   │  PING   │  LOSS%  │
├────────┼────────────┼──────────────────────────────────┼───────────────────────┼─────────┼─────────┼─────────┤
│   ⏺    │ GET        │ http://localhost:3333/testGET    │          OK           │ SKIPPED │ SKIPPED │ SKIPPED │
├────────┼────────────┼──────────────────────────────────┼───────────────────────┼─────────┼─────────┼─────────┤
│   ⏺    │ POST       │ http://localhost:3333/testPOST   │          OK           │ SKIPPED │ SKIPPED │ SKIPPED │
├────────┼────────────┼──────────────────────────────────┼───────────────────────┼─────────┼─────────┼─────────┤
│   ⏺    │ DELETE     │ http://localhost:3333/testDELETE │          OK           │ SKIPPED │ SKIPPED │ SKIPPED │
├────────┼────────────┼──────────────────────────────────┼───────────────────────┼─────────┼─────────┼─────────┤
│   ⏺    │ PUT        │ http://localhost:3333/testPUT    │          OK           │ SKIPPED │ SKIPPED │ SKIPPED │
├────────┼────────────┼──────────────────────────────────┼───────────────────────┼─────────┼─────────┼─────────┤
│   ⏹    │ 400        │ http://localhost:3333/test400    │      BAD REQUEST      │ SKIPPED │ SKIPPED │ SKIPPED │
├────────┼────────────┼──────────────────────────────────┼───────────────────────┼─────────┼─────────┼─────────┤
│   ⏹    │ 500        │ http://localhost:3333/test500    │ INTERNAL SERVER ERROR │ SKIPPED │ SKIPPED │ SKIPPED │
└────────┴────────────┴──────────────────────────────────┴───────────────────────┴─────────┴─────────┴─────────┘