From a8220ab2d293bb7f4b014b79d16b2fb05090fa93 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 7 Feb 2021 12:45:55 +0100
Subject: Adding upstream version 1.29.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 collectors/charts.d.plugin/apcupsd/README.md       |  20 ++-
 .../charts.d.plugin/apcupsd/apcupsd.chart.sh       | 136 +++++++++++----------
 2 files changed, 89 insertions(+), 67 deletions(-)

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

diff --git a/collectors/charts.d.plugin/apcupsd/README.md b/collectors/charts.d.plugin/apcupsd/README.md
index 51bb6eccd..b5b41e84d 100644
--- a/collectors/charts.d.plugin/apcupsd/README.md
+++ b/collectors/charts.d.plugin/apcupsd/README.md
@@ -1,7 +1,21 @@
-# apcupsd
+<!--
+title: "APC UPS monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/apcupsd/README.md
+sidebar_label: "APC UPS"
+-->
 
-_Under construction_
+# APC UPS monitoring with Netdata
 
-Collects UPS metrics
+Monitors different APC UPS models and retrieves status information using `apcaccess` tool.
+
+## Configuration
+
+Edit the `charts.d/apcupsd.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata   # Replace this path with your Netdata config directory, if different
+sudo ./edit-config charts.d/apcupsd.conf
+```
 
 [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fcharts.d.plugin%2Fapcupsd%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
diff --git a/collectors/charts.d.plugin/apcupsd/apcupsd.chart.sh b/collectors/charts.d.plugin/apcupsd/apcupsd.chart.sh
index 31ff93160..014a9c1de 100644
--- a/collectors/charts.d.plugin/apcupsd/apcupsd.chart.sh
+++ b/collectors/charts.d.plugin/apcupsd/apcupsd.chart.sh
@@ -11,7 +11,7 @@ apcupsd_ip=
 apcupsd_port=
 
 declare -A apcupsd_sources=(
-	["local"]="127.0.0.1:3551"
+  ["local"]="127.0.0.1:3551"
 )
 
 # how frequently to collect UPS data
@@ -23,55 +23,63 @@ apcupsd_timeout=3
 apcupsd_priority=90000
 
 apcupsd_get() {
-	run -t $apcupsd_timeout apcaccess status "$1"
+  run -t $apcupsd_timeout apcaccess status "$1"
+}
+
+is_ups_alive() {
+  local status
+  status="$(apcupsd_get "$1" | sed -e 's/STATUS.*: //' -e 't' -e 'd')"
+  case "$status" in
+    "" | "COMMLOST" | "SHUTTING DOWN") return 1 ;;
+    *) return 0 ;;
+  esac
 }
 
 apcupsd_check() {
 
-	# this should return:
-	#  - 0 to enable the chart
-	#  - 1 to disable the chart
-
-	require_cmd apcaccess || return 1
-
-	# backwards compatibility
-	if [ "${apcupsd_ip}:${apcupsd_port}" != ":" ]; then
-		apcupsd_sources["local"]="${apcupsd_ip}:${apcupsd_port}"
-	fi
-
-	local host working=0 failed=0
-	for host in "${!apcupsd_sources[@]}"; do
-		run apcupsd_get "${apcupsd_sources[${host}]}" >/dev/null
-		# shellcheck disable=2181
-		if [ $? -ne 0 ]; then
-			error "cannot get information for apcupsd server ${host} on ${apcupsd_sources[${host}]}."
-			failed=$((failed + 1))
-		else
-			apcupsd_status="$(apcupsd_get ${apcupsd_sources[${host}]} | awk '/^STATUS.*/{ print $3 }')"
-			if [ "${apcupsd_status}" != "ONLINE" ]  && [ "${apcupsd_status}" != "ONBATT" ]; then
-				error "APC UPS ${host} on ${apcupsd_sources[${host}]} is not online."
-				failed=$((failed + 1))
-			else
-				working=$((working + 1))
-			fi
-		fi
-	done
-
-	if [ ${working} -eq 0 ]; then
-		error "No APC UPSes found available."
-		return 1
-	fi
-
-	return 0
+  # this should return:
+  #  - 0 to enable the chart
+  #  - 1 to disable the chart
+
+  require_cmd apcaccess || return 1
+
+  # backwards compatibility
+  if [ "${apcupsd_ip}:${apcupsd_port}" != ":" ]; then
+    apcupsd_sources["local"]="${apcupsd_ip}:${apcupsd_port}"
+  fi
+
+  local host working=0 failed=0
+  for host in "${!apcupsd_sources[@]}"; do
+    run apcupsd_get "${apcupsd_sources[${host}]}" > /dev/null
+    # shellcheck disable=2181
+    if [ $? -ne 0 ]; then
+      error "cannot get information for apcupsd server ${host} on ${apcupsd_sources[${host}]}."
+      failed=$((failed + 1))
+    else
+      if ! is_ups_alive ${apcupsd_sources[${host}]}; then
+        error "APC UPS ${host} on ${apcupsd_sources[${host}]} is not online."
+        failed=$((failed + 1))
+      else
+        working=$((working + 1))
+      fi
+    fi
+  done
+
+  if [ ${working} -eq 0 ]; then
+    error "No APC UPSes found available."
+    return 1
+  fi
+
+  return 0
 }
 
 apcupsd_create() {
-	local host src
-	for host in "${!apcupsd_sources[@]}"; do
-		src=${apcupsd_sources[${host}]}
+  local host src
+  for host in "${!apcupsd_sources[@]}"; do
+    src=${apcupsd_sources[${host}]}
 
-		# create the charts
-		cat <<EOF
+    # create the charts
+    cat << EOF
 CHART apcupsd_${host}.charge '' "UPS Charge for ${host} on ${src}" "percentage" ups apcupsd.charge area $((apcupsd_priority + 1)) $apcupsd_update_every
 DIMENSION battery_charge charge absolute 1 100
 
@@ -104,21 +112,21 @@ CHART apcupsd_${host}.online '' "UPS ONLINE flag for ${host} on ${src}" "boolean
 DIMENSION online online absolute 0 1
 
 EOF
-	done
-	return 0
+  done
+  return 0
 }
 
 apcupsd_update() {
-	# the first argument to this function is the microseconds since last update
-	# pass this parameter to the BEGIN statement (see bellow).
+  # 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
+  # do all the work to collect / calculate the values
+  # for each dimension
+  # remember: KEEP IT SIMPLE AND SHORT
 
-	local host working=0 failed=0
-	for host in "${!apcupsd_sources[@]}"; do
-		apcupsd_get "${apcupsd_sources[${host}]}" | awk "
+  local host working=0 failed=0
+  for host in "${!apcupsd_sources[@]}"; do
+    apcupsd_get "${apcupsd_sources[${host}]}" | awk "
 
 BEGIN {
 	battery_charge = 0;
@@ -190,16 +198,16 @@ END {
 		print \"END\"
 	}
 }"
-		# shellcheck disable=SC2181
-		if [ $? -ne 0 ]; then
-			failed=$((failed + 1))
-			error "failed to get values for APC UPS ${host} on ${apcupsd_sources[${host}]}" && return 1
-		else
-			working=$((working + 1))
-		fi
-	done
-
-	[ $working -eq 0 ] && error "failed to get values from all APC UPSes" && return 1
-
-	return 0
+    # shellcheck disable=SC2181
+    if [ $? -ne 0 ]; then
+      failed=$((failed + 1))
+      error "failed to get values for APC UPS ${host} on ${apcupsd_sources[${host}]}" && return 1
+    else
+      working=$((working + 1))
+    fi
+  done
+
+  [ $working -eq 0 ] && error "failed to get values from all APC UPSes" && return 1
+
+  return 0
 }
-- 
cgit v1.2.3