socketlabs-status

Nagios plugin to check Socketlabs SMTP server and API utilization. The plugin calls the Socketlabs reporting API to retrieve usage metrics for SMTP servers.

Requirements

The plugin is implemented in Node.js. The following components are required to run this plugin -

• git
• nodejs (5.9.1)

Configuration and Installation

Check out the repository from git -

$ git clone https://github.com/hcentive/socketlabs-status

Configuration

Go to the socketlabs-status directory. Rename default.json.template to default.json.

$ cd socketlabs-status
$ mv conf/default.json.template conf/default.json

Optionally, update configuration attributes with your Socketlabs API credentials and server IDs. Make the following changes to conf/default.json -

• Replace YOUR_API_USERNAME with your Socketlabs API username.
• Replace YOUR_API_PASSWORD with the password for the API user.
• Update server_ids attribute with a comma-separated list of your Socketlabs servers. For example, 1000,1001,1002.

NOTE: All the above attributes can be passed to the plugin as command-line parameters.

If using a proxy server to make outbound HTTP calls, update the proxy server configuration -

• Set the value of proxy_enabled to true.
• Replace YOUR_PROXY_SERVER with the address of your proxy server. For example, http://localhost:3128.

Critical and Warning Thresholds

The plugin uses percentage usage of the total Socketlabs allowance as the unit of measure for the Nagios checks. Default critical and warning thresholds are set at 85 and 70, respectively.

To change thresholds, update the following attributes in conf/default.json -

• warning_threshold to set the warning threshold.
• critical_threshold to set the critical threshold.

Installation

Run npm install in the installation directory to install dependencies and the executable to run the status check. Run socketlabs-status to test the plugin -

$ npm install -g

Usage

The plugin can be run with command line options to override attributes in the configuration files. Run with --help option to view available command line parameters

$ check-socketlabs --help
Usage: check-socketlabs [options]

Options:

  -h, --help                    output usage information
  -u, --username <username>     API username
  -p, --password <password>     API password
  -s, --serverids <server_ids>  Server IDs

For example, to run the check for a specific server, pass the server ID with the -s or --serverid parameter.

$ check-socketlabs -u myusername -p mypassword -s 0000
SOCKETLABS OK - Server ID: 0000 - 0.26% of total message allowance used; 0.00% of total bandwidth allowance used; 2.74% of total API allowance used|message-usage=0.26%;70;85;; bandwidth-usage=0.00%;70;85;; api-usage=2.74%;70;85;;

Depending on your Nagios installation, follow one of the following guides to install the plugin on your Nagios server -

• Nagios Core - Nagios Plugins
• Nagios XI - Managing Plugins In Nagios XI