From 8fbf817ef83b3524b15f908251909d9d6feb5532 Mon Sep 17 00:00:00 2001
From: Costa Tsaousis <costa@tsaousis.gr>
Date: Mon, 15 Oct 2018 23:16:42 +0300
Subject: modularized all source code (#4391)

* modularized all external plugins

* added README.md in plugins

* fixed title

* fixed typo

* relative link to external plugins

* external plugins configuration README

* added plugins link

* remove plugins link

* plugin names are links

* added links to external plugins

* removed unecessary spacing

* list to table

* added language

* fixed typo

* list to table on internal plugins

* added more documentation to internal plugins

* moved python, node, and bash code and configs into the external plugins

* added statsd README

* fix bug with corrupting config.h every 2nd compilation

* moved all config files together with their code

* more documentation

* diskspace info

* fixed broken links in apps.plugin

* added backends docs

* updated plugins readme

* move nc-backend.sh to backends

* created daemon directory

* moved all code outside src/

* fixed readme identation

* renamed plugins.d.plugin to plugins.d

* updated readme

* removed linux- from linux plugins

* updated readme

* updated readme

* updated readme

* updated readme

* updated readme

* updated readme

* fixed README.md links

* fixed netdata tree links

* updated codacy, codeclimate and lgtm excluded paths

* update CMakeLists.txt

* updated automake options at top directory

* libnetdata slit into directories

* updated READMEs

* updated READMEs

* updated ARL docs

* updated ARL docs

* moved /plugins to /collectors

* moved all external plugins outside plugins.d

* updated codacy, codeclimate, lgtm

* updated README

* updated url

* updated readme

* updated readme

* updated readme

* updated readme

* moved api and web into webserver

* web/api web/gui web/server

* modularized webserver

* removed web/gui/version.txt
---
 collectors/charts.d.plugin/nut/README.md    |  59 +++++++
 collectors/charts.d.plugin/nut/nut.chart.sh | 241 ++++++++++++++++++++++++++++
 collectors/charts.d.plugin/nut/nut.conf     |  33 ++++
 3 files changed, 333 insertions(+)
 create mode 100644 collectors/charts.d.plugin/nut/README.md
 create mode 100644 collectors/charts.d.plugin/nut/nut.chart.sh
 create mode 100644 collectors/charts.d.plugin/nut/nut.conf

(limited to 'collectors/charts.d.plugin/nut')

diff --git a/collectors/charts.d.plugin/nut/README.md b/collectors/charts.d.plugin/nut/README.md
new file mode 100644
index 0000000000..71906f55a5
--- /dev/null
+++ b/collectors/charts.d.plugin/nut/README.md
@@ -0,0 +1,59 @@
+# nut
+
+The plugin will collect UPS data for all UPSes configured in the system.
+
+The following charts will be created:
+
+1. **UPS Charge**
+
+ * percentage changed
+
+2. **UPS Battery Voltage**
+
+ * current voltage
+ * high voltage
+ * low voltage
+ * nominal voltage
+
+3. **UPS Input Voltage**
+
+ * current voltage
+ * fault voltage
+ * nominal voltage
+
+4. **UPS Input Current**
+
+ * nominal current
+
+5. **UPS Input Frequency**
+
+ * current frequency
+ * nominal frequency
+
+6. **UPS Output Voltage**
+
+ * current voltage
+
+7. **UPS Load**
+
+ * current load
+
+8. **UPS Temperature**
+
+ * current temperature
+
+
+### configuration
+
+This is the internal default for `/etc/netdata/nut.conf`
+
+```sh
+# a space separated list of UPS names
+# if empty, the list returned by 'upsc -l' will be used
+nut_ups=
+
+# how frequently to collect UPS data
+nut_update_every=2
+```
+
+---
diff --git a/collectors/charts.d.plugin/nut/nut.chart.sh b/collectors/charts.d.plugin/nut/nut.chart.sh
new file mode 100644
index 0000000000..7e252f325e
--- /dev/null
+++ b/collectors/charts.d.plugin/nut/nut.chart.sh
@@ -0,0 +1,241 @@
+# shellcheck shell=bash
+# no need for shebang - this file is loaded from charts.d.plugin
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# netdata
+# real-time performance and health monitoring, done right!
+# (C) 2016-2017 Costa Tsaousis <costa@tsaousis.gr>
+#
+
+# a space separated list of UPS names
+# if empty, the list returned by 'upsc -l' will be used
+nut_ups=
+
+# how frequently to collect UPS data
+nut_update_every=2
+
+# how much time in seconds, to wait for nut to respond
+nut_timeout=2
+
+# set this to 1, to enable another chart showing the number
+# of UPS clients connected to upsd
+nut_clients_chart=0
+
+# the priority of nut related to other charts
+nut_priority=90000
+
+declare -A nut_ids=()
+declare -A nut_names=()
+
+nut_get_all() {
+	run -t $nut_timeout upsc -l
+}
+
+nut_get() {
+	run -t $nut_timeout upsc "$1"
+
+	if [ "${nut_clients_chart}" -eq "1" ]
+		then
+		printf "ups.connected_clients: "
+		run -t $nut_timeout upsc -c "$1" | wc -l
+	fi
+}
+
+nut_check() {
+
+	# this should return:
+	#  - 0 to enable the chart
+	#  - 1 to disable the chart
+
+	local x
+
+	require_cmd upsc || return 1
+
+	[ -z "$nut_ups" ] && nut_ups="$( nut_get_all )"
+
+	for x in $nut_ups
+	do
+		nut_get "$x" >/dev/null
+		# shellcheck disable=SC2181
+		if [ $? -eq 0 ]
+		then
+			if [ ! -z "${nut_names[${x}]}" ]
+			then
+				nut_ids[$x]="$( fixid "${nut_names[${x}]}" )"
+			else
+				nut_ids[$x]="$( fixid "$x" )"
+			fi
+			continue
+		fi
+		error "cannot get information for NUT UPS '$x'."
+	done
+
+	if [ ${#nut_ids[@]} -eq 0 ]
+	then
+		# shellcheck disable=SC2154
+		error "Cannot find UPSes - please set nut_ups='ups_name' in $confd/nut.conf"
+		return 1
+	fi
+
+	return 0
+}
+
+nut_create() {
+	# create the charts
+	local x
+
+	for x in "${nut_ids[@]}"
+	do
+		cat <<EOF
+CHART nut_$x.charge '' "UPS Charge" "percentage" ups nut.charge area $((nut_priority + 1)) $nut_update_every
+DIMENSION battery_charge charge absolute 1 100
+
+CHART nut_$x.runtime '' "UPS Runtime" "seconds" ups nut.runtime area $((nut_priority + 2)) $nut_update_every
+DIMENSION battery_runtime runtime absolute 1 100
+
+CHART nut_$x.battery_voltage '' "UPS Battery Voltage" "Volts" ups nut.battery.voltage line $((nut_priority + 3)) $nut_update_every
+DIMENSION battery_voltage voltage absolute 1 100
+DIMENSION battery_voltage_high high absolute 1 100
+DIMENSION battery_voltage_low low absolute 1 100
+DIMENSION battery_voltage_nominal nominal absolute 1 100
+
+CHART nut_$x.input_voltage '' "UPS Input Voltage" "Volts" input nut.input.voltage line $((nut_priority + 4)) $nut_update_every
+DIMENSION input_voltage voltage absolute 1 100
+DIMENSION input_voltage_fault fault absolute 1 100
+DIMENSION input_voltage_nominal nominal absolute 1 100
+
+CHART nut_$x.input_current '' "UPS Input Current" "Ampere" input nut.input.current line $((nut_priority + 5)) $nut_update_every
+DIMENSION input_current_nominal nominal absolute 1 100
+
+CHART nut_$x.input_frequency '' "UPS Input Frequency" "Hz" input nut.input.frequency line $((nut_priority + 6)) $nut_update_every
+DIMENSION input_frequency frequency absolute 1 100
+DIMENSION input_frequency_nominal nominal absolute 1 100
+
+CHART nut_$x.output_voltage '' "UPS Output Voltage" "Volts" output nut.output.voltage line $((nut_priority + 7)) $nut_update_every
+DIMENSION output_voltage voltage absolute 1 100
+
+CHART nut_$x.load '' "UPS Load" "percentage" ups nut.load area $((nut_priority)) $nut_update_every
+DIMENSION load load absolute 1 100
+
+CHART nut_$x.temp '' "UPS Temperature" "temperature" ups nut.temperature line $((nut_priority + 8)) $nut_update_every
+DIMENSION temp temp absolute 1 100
+EOF
+
+	if [ "${nut_clients_chart}" = "1" ]
+		then
+		cat <<EOF2
+CHART nut_$x.clients '' "UPS Connected Clients" "clients" ups nut.clients area $((nut_priority + 9)) $nut_update_every
+DIMENSION clients '' absolute 1 1
+EOF2
+	fi
+
+	done
+
+	return 0
+}
+
+
+nut_update() {
+	# the first argument to this function is the microseconds since last update
+	# pass this parameter to the BEGIN statement (see bellow).
+
+	# do all the work to collect / calculate the values
+	# for each dimension
+	# remember: KEEP IT SIMPLE AND SHORT
+
+	local i x
+	for i in "${!nut_ids[@]}"
+	do
+		x="${nut_ids[$i]}"
+		nut_get "$i" | awk "
+BEGIN {
+	battery_charge = 0;
+    battery_runtime = 0;
+	battery_voltage = 0;
+	battery_voltage_high = 0;
+	battery_voltage_low = 0;
+	battery_voltage_nominal = 0;
+	input_voltage = 0;
+	input_voltage_fault = 0;
+	input_voltage_nominal = 0;
+	input_current_nominal = 0;
+	input_frequency = 0;
+	input_frequency_nominal = 0;
+	output_voltage = 0;
+	load = 0;
+	temp = 0;
+	client = 0;
+	do_clients = ${nut_clients_chart};
+}
+/^battery.charge: .*/			{ battery_charge = \$2 * 100 };
+/^battery.runtime: .*/          { battery_runtime = \$2 * 100 };
+/^battery.voltage: .*/			{ battery_voltage = \$2 * 100 };
+/^battery.voltage.high: .*/		{ battery_voltage_high = \$2 * 100 };
+/^battery.voltage.low: .*/		{ battery_voltage_low = \$2 * 100 };
+/^battery.voltage.nominal: .*/	{ battery_voltage_nominal = \$2 * 100 };
+/^input.voltage: .*/			{ input_voltage = \$2 * 100 };
+/^input.voltage.fault: .*/		{ input_voltage_fault = \$2 * 100 };
+/^input.voltage.nominal: .*/	{ input_voltage_nominal = \$2 * 100 };
+/^input.current.nominal: .*/	{ input_current_nominal = \$2 * 100 };
+/^input.frequency: .*/			{ input_frequency = \$2 * 100 };
+/^input.frequency.nominal: .*/	{ input_frequency_nominal = \$2 * 100 };
+/^output.voltage: .*/			{ output_voltage = \$2 * 100 };
+/^ups.load: .*/					{ load = \$2 * 100 };
+/^ups.temperature: .*/			{ temp = \$2 * 100 };
+/^ups.connected_clients: .*/	{ clients = \$2 };
+END {
+	print \"BEGIN nut_$x.charge $1\";
+	print \"SET battery_charge = \" battery_charge;
+	print \"END\"
+
+    print \"BEGIN nut_$x.runtime $1\";
+    print \"SET battery_runtime = \" battery_runtime;
+    print \"END\"
+
+	print \"BEGIN nut_$x.battery_voltage $1\";
+	print \"SET battery_voltage = \" battery_voltage;
+	print \"SET battery_voltage_high = \" battery_voltage_high;
+	print \"SET battery_voltage_low = \" battery_voltage_low;
+	print \"SET battery_voltage_nominal = \" battery_voltage_nominal;
+	print \"END\"
+
+	print \"BEGIN nut_$x.input_voltage $1\";
+	print \"SET input_voltage = \" input_voltage;
+	print \"SET input_voltage_fault = \" input_voltage_fault;
+	print \"SET input_voltage_nominal = \" input_voltage_nominal;
+	print \"END\"
+
+	print \"BEGIN nut_$x.input_current $1\";
+	print \"SET input_current_nominal = \" input_current_nominal;
+	print \"END\"
+
+	print \"BEGIN nut_$x.input_frequency $1\";
+	print \"SET input_frequency = \" input_frequency;
+	print \"SET input_frequency_nominal = \" input_frequency_nominal;
+	print \"END\"
+
+	print \"BEGIN nut_$x.output_voltage $1\";
+	print \"SET output_voltage = \" output_voltage;
+	print \"END\"
+
+	print \"BEGIN nut_$x.load $1\";
+	print \"SET load = \" load;
+	print \"END\"
+
+	print \"BEGIN nut_$x.temp $1\";
+	print \"SET temp = \" temp;
+	print \"END\"
+
+	if(do_clients) {
+		print \"BEGIN nut_$x.clients $1\";
+		print \"SET clients = \" clients;
+		print \"END\"
+	}
+}"
+		# shellcheck disable=2181
+		[ $? -ne 0 ] && unset "nut_ids[$i]" && error "failed to get values for '$i', disabling it."
+	done
+
+	[ ${#nut_ids[@]} -eq 0 ] && error "no UPSes left active." && return 1
+	return 0
+}
diff --git a/collectors/charts.d.plugin/nut/nut.conf b/collectors/charts.d.plugin/nut/nut.conf
new file mode 100644
index 0000000000..b95ad9048c
--- /dev/null
+++ b/collectors/charts.d.plugin/nut/nut.conf
@@ -0,0 +1,33 @@
+# no need for shebang - this file is loaded from charts.d.plugin
+
+# netdata
+# real-time performance and health monitoring, done right!
+# (C) 2018 Costa Tsaousis <costa@tsaousis.gr>
+# GPL v3+
+
+# a space separated list of UPS names
+# if empty, the list returned by 'upsc -l' will be used
+#nut_ups=
+
+# each line represents an alias for one UPS
+# if empty, the FQDN will be used
+#nut_names["FQDN1"]="alias"
+#nut_names["FQDN2"]="alias"
+
+# how much time in seconds, to wait for nut to respond
+#nut_timeout=2
+
+# set this to 1, to enable another chart showing the number
+# of UPS clients connected to upsd
+#nut_clients_chart=1
+
+# the data collection frequency
+# if unset, will inherit the netdata update frequency
+#nut_update_every=2
+
+# the charts priority on the dashboard
+#nut_priority=90000
+
+# the number of retries to do in case of failure
+# before disabling the module
+#nut_retries=10
-- 
cgit v1.2.3