From fbb9c2357bbde0f7c1169dd41405a6863a24dd06 Mon Sep 17 00:00:00 2001
From: Herman van Rink <rink@initfour.nl>
Date: Fri, 14 Jan 2022 22:23:53 +0100
Subject: [PATCH] Add Nagios compatible script to export data from the monitor
 page

Migrated from https://git.ispconfig.org/ispconfig/ispconfig3/-/merge_requests/1432
Added README, moved suggested location to /usr/local/ispconfig/server/scripts/ and add Licence text.
---
 check_ispconfig/README              | 20 +++++++
 check_ispconfig/check_ispconfig.php | 92 +++++++++++++++++++++++++++++
 2 files changed, 112 insertions(+)
 create mode 100644 check_ispconfig/README
 create mode 100755 check_ispconfig/check_ispconfig.php

diff --git a/check_ispconfig/README b/check_ispconfig/README
new file mode 100644
index 0000000..24e0f6e
--- /dev/null
+++ b/check_ispconfig/README
@@ -0,0 +1,20 @@
+# check_ispconfig
+
+Nagios compatible script to export data from the monitor page.
+
+Outputs a single line like: `WARNING: (ok: 12, info: system_update, warning: sys_log)`
+
+
+## Installation
+
+- In an NRPE compatibe config file, such as /etc/nagios/nrpe.cfg:
+`command[check_ispconfig]=/usr/bin/sudo /usr/local/ispconfig/server/scripts/check_ispconfig.php`
+
+- To allow an nrpe user to run this, add /etc/sudoers.d/ispconfig:
+```
+Cmnd_Alias  CHECK_ISPCONFIG = /usr/local/ispconfig/server/scripts/check_ispconfig.php
+
+nagios  ALL = NOPASSWD : CHECK_ISPCONFIG
+```
+
+- Setup your monitoring tool of choice to call this script.
diff --git a/check_ispconfig/check_ispconfig.php b/check_ispconfig/check_ispconfig.php
new file mode 100755
index 0000000..6d3bd91
--- /dev/null
+++ b/check_ispconfig/check_ispconfig.php
@@ -0,0 +1,92 @@
+#!/usr/bin/env php
+<?php
+
+/**
+ * Nagios compatible script to export data from the monitor page.
+ *
+ * Outputs a single line like: `WARNING: (ok: 12, info: system_update, warning: sys_log)`
+ *
+ * Usage:
+ *
+ * In an NRPE compatibe config file, such as /etc/nagios/nrpe.cfg:
+ * `command[check_ispconfig]=/usr/bin/sudo /usr/local/ispconfig/server/scripts/check_ispconfig.php`
+ *
+ * To allow an nrpe user to run this, /etc/sudoers.d/ispconfig:
+ * ```
+ * Cmnd_Alias  CHECK_ISPCONFIG = /usr/local/ispconfig/server/scripts/check_ispconfig.php
+ *
+ * nagios  ALL = NOPASSWD : CHECK_ISPCONFIG
+ * ```
+ */
+
+/*
+Copyright (c) 2021-03-07, Herman van Rink / Initfour websolutions
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name of ISPConfig nor the names of its contributors
+      may be used to endorse or promote products derived from this software without
+      specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+define('SCRIPT_PATH', dirname($_SERVER["SCRIPT_FILENAME"]));
+require SCRIPT_PATH."/../lib/config.inc.php";
+require SCRIPT_PATH."/../lib/app.inc.php";
+
+ini_set('error_reporting', E_ALL & ~E_NOTICE);
+
+$server_state = 'ok';
+$retval = 0;
+$server_states = array();
+$state_list = array();
+
+$records = $app->dbmaster->queryAllRecords("SELECT DISTINCT type, state FROM monitor_data
+		WHERE server_id = ? AND state != 'no_state'", $conf['server_id']);
+
+foreach($records as $record) {
+	$server_states[$record['state']][] = $record['type'];
+}
+
+foreach ($server_states as $state => $data) {
+	if ($state == 'ok') {
+		$state_list[] = "$state: " . count($data);
+	}
+	else {
+		$state_list[] = "$state: " . join(', ', $data);
+	}
+}
+if (empty($server_states)) {
+	$server_state = 'unknown';
+	$retval = 3;
+}
+elseif (is_array($server_states['critical']) && count($server_states['critical']) > 0 || is_array($server_states['error']) && count($server_states['error']) > 0) {
+	$server_state = 'critical';
+	$retval = 2;
+}
+elseif ($server_states['warning'] > 0) {
+	$server_state = 'warning';
+	$retval = 1;
+}
+
+$status_line = strtoupper($server_state) . ': (' . join(', ', $state_list) . ')';
+
+echo $status_line . PHP_EOL;
+exit($retval);
-- 
GitLab