NAME

oslv_monitor - LibreNMS style JSON SNMP extend for OS level virtualization monitoring

VERSION

1.0.0

SYNOPSIS

oslv_monitor [-c] [-f <config file>] [-b <base dir>] [-q] [-t <time divider>]

DESCRIPTION

For cron...

    */5 * * * * /usr/local/bin/oslv_monitor -q

For snmpd...

    extend oslv_monitor /bin/cat /var/cache/oslv_monitor/snmp

FLAGS

-c

Compress the output using gzip and base64 encoded so it can be transmitted via SNMP with out issue.

/var/cache/oslv_monitor/snmp will always be available and compressed.

-f <file>

The config file to use.

Default :: /usr/local/etc/oslv_monitor.json

-q

Do not print the results.

-t <time divider>

What to use for the time divider.

CONFIG FILE

The following keys are used in the JSON config file.

    - include :: A array of regular expressions to include.
        Default :: ["^.*$"]
    - exlcude :: A array of regular expressions to exlclude.
        Default :: undef
    - backend :: Override the the backend and automatically choose it.
    - time_divider :: Override the time_divider value. The default value varies
        per backend and if it is needed.

Time divider notes.

    - cgroups :: While the default for usec to sec conversion should be 1000000,
              some settings report the value in nanoseconds, requiring 1000000000.
        Default :: 1000000
    - FreeBSD :: not used

By Defaults the backends are as below.

    FreeBSD: FreeBSD
    Linux: cgroups

Default would be like this.

    {
        "include": ["^.*$"]
    }