Monitooor

Monitor system health for various drivers (including System, MongoDB, ElasticSearch, ...)

Installation

$ npm install -g @poool/monitooor

or

$ yarn global add @poool/monitooor

Usage

$ monitooor

Options

--help, -h

Get some help running Monitooor

$ monitooor --help

--version, -v

Show current package version

$ monitooor --version

--config, -c

Custom config file path

$ monitooor --config=/tmp/config.json

Default config :

--log-level, -l

Current log level. 0: Trace, 1: Log, 2: Warn, 3: Error. Default: 2

$ monitooor --log-level=0

--write.retention

Monitoring data older than this number will be erased from storage (0 means infinite retention). Default: 5

$ monitooor --write.retention=0

--write.interval

Monitoring interval (in seconds). Setting this number too low might slow things down. Default: 60

$ monitooor --write.interval=30

--server.store

Store name in which you want to be able to retrieve data. Default: internal

$ monitooor --server.store="mongodb"

Config file

Default

{
    "log_level": 2,
    "read": {
        "drivers": [
            {
                "name": "system",
                "type": "system"
            }
        ]
    },
    "write": {
        "stores": [
            {
                "name": "internal",
                "type": "internal",
                "path": "/tmp/monitooor"
            }
        ],
        "retention": 5, // <-- days
        "interval": 10, // <-- seconds
        "flush": 5 // <-- seconds
    },
    "server": {
        "store": "internal",
        "port": 5000
    }
}

Drivers

System

{
    "name": "...",
    "type": "system",
    "proc": "/host/proc",
    "disk": "/media/data"
}

MongoDB

{
    "name": "...",
    "type": "mongodb",
    "uri": "mongodb://localhost:27017/admin",
    "retry": 5 // <-- seconds before autoconnect retry
}

ElasticSearch

{
    "name": "...",
    "type": "elasticsearch",
    "host": "http://localhost:9200",
    // or
    "hosts": ["http://localhost:9200"],
    "auth": "username:password",
    "api": "5.4"
}

Stores

Internal (NeDB)

{
    "name": "...",
    "type": "internal",
    "path": "/tmp/monitooor"
}

MongoDB

{
    "name": "...",
    "type": "mongodb",
    "uri": "mongodb://localhost:9200",
    "retry": 5 // <-- seconds before autoconnect retry
}

Contributing

Feel free to contribute to this repository by making pull requests and create any related issue on the repository itself 😊

Install

$ yarn global add grunt-cli && yarn install

Build

$ grunt build

Run

$ node build/