Mirrors/Munin-Contrib
1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-21 10:39:53 +00:00
Code Issues Releases Wiki Activity

[system/linux-psi] Rename pressure plugin to linux_psi and minor improvements

Browse source 
Address several issues regarding the psi-plugin (pressure stall information).

Fixes:
- Use local for variables in functions.
- Add fetch as a valid parameter and remove auto.
- Remove double slash in path for get_pressure_value() and quote it.
- Remove line break in return value of get_printable_name().
- Quote variables to avoid splitting/globbing.
- Rename pressure plugin to linux_psi.

References:
- https://github.com/munin-monitoring/contrib/pull/1302
This commit is contained in:
HaseHarald 2022-03-29 21:43:10 +02:00 • committed by Lars Kruse
parent 5389b09abe
commit bdec9c4a33
1 changed files with 108 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

187
plugins/system/pressure → plugins/system/linux_psi
View file

@ -5,7 +5,7 @@
=head1 NAME =head1 NAME
pressure - Plugin to monitor the pressure stall information for CPU, Memory and linux_psi - Plugin to monitor the pressure stall information for CPU, Memory and
IO as reported by the Linux kernel. IO as reported by the Linux kernel.
This plugin monitors the pressure stall information (psi) as reported by the This plugin monitors the pressure stall information (psi) as reported by the
@ -38,7 +38,7 @@ internal name.
Optional configuration examples: Optional configuration examples:
[pressure] [linux_psi]
env.resources cpu io memory - Specify the resources to monitor. Leave one env.resources cpu io memory - Specify the resources to monitor. Leave one
out if you don't want this one to be out if you don't want this one to be
monitored. monitored.
@ -95,34 +95,43 @@ resource_defaults=('cpu' 'io' 'memory')
interval_defaults=('avg10' 'avg60' 'avg300') interval_defaults=('avg10' 'avg60' 'avg300')
scope_defaults=('some' 'full') scope_defaults=('some' 'full')
pressure_dir=${pressure_dir:-'/proc/pressure/'} pressure_dir=${pressure_dir:-'/proc/pressure/'}
pressure_resources=${resources[@]:-${resource_defaults[@]}} pressure_resources=( "${resources[@]:-${resource_defaults[@]}}" )
pressure_intervals=${intervals[@]:-${interval_defaults[@]}} pressure_intervals=( "${intervals[@]:-${interval_defaults[@]}}" )
pressure_scopes=${scopes[@]:-${scope_defaults[@]}} pressure_scopes=( "${scopes[@]:-${scope_defaults[@]}}" )
summary_interval=${summary_interval:-avg300} summary_interval="${summary_interval:-avg300}"
check_autoconf() { check_autoconf() {
if [ -d "${pressure_dir}" ]; then if [ -d "${pressure_dir}" ]; then
printf "yes\n" printf "yes\n"
else else
printf "no (%s not found)\n" ${pressure_dir} printf "no (%s not found)\n" "${pressure_dir}"
fi fi
} }
get_pressure_value() { get_pressure_value() {
resource=$1 local resource
interval=$2 local interval
scope=${3:-some} local scope
grep "$scope" ${pressure_dir}//${resource} | grep -o -E "${interval}=[0-9]{1,}(\.[0-9]{1,}){0,1}" | cut -d '=' -f 2
resource="$1"
interval="$2"
scope="${3:-some}"
grep "$scope" "${pressure_dir}/${resource}" | grep -o -E "${interval}=[0-9]{1,}(\.[0-9]{1,}){0,1}" | cut -d '=' -f 2
} }
get_printable_name() { get_printable_name() {
kind=$1 local kind
value=$2 local value
local printable_name
kind="$1"
value="$2"
printable_name=""
case $kind in case "$kind" in
interval) interval)
case $interval in case "$interval" in
avg10) avg10)
printable_name="10sec" printable_name="10sec"
;; ;;
@ -136,14 +145,14 @@ get_printable_name() {
printable_name="Total" printable_name="Total"
;; ;;
*) *)
printf "ERROR: Could not determine interval %s ! Must be one of 'avg10' 'avg60' 'avg300' 'total'\n" $value >&2 printf "ERROR: Could not determine interval %s ! Must be one of 'avg10' 'avg60' 'avg300' 'total'\n" "$value" >&2
exit 2 exit 2
;; ;;
esac esac
;; ;;
scope) scope)
case $value in case "$value" in
some) some)
printable_name="Some" printable_name="Some"
;; ;;
@ -151,14 +160,14 @@ get_printable_name() {
printable_name="Full" printable_name="Full"
;; ;;
*) *)
printf "ERROR: Could not determine scope %s ! Must be one of 'full' 'some'.\n" $value >&2 printf "ERROR: Could not determine scope %s ! Must be one of 'full' 'some'.\n" "$value" >&2
exit 2 exit 2
;; ;;
esac esac
;; ;;
resource) resource)
case $value in case "$value" in
cpu) cpu)
printable_name="CPU" printable_name="CPU"
;; ;;
@ -169,133 +178,150 @@ get_printable_name() {
printable_name="Memory" printable_name="Memory"
;; ;;
*) *)
printf "ERROR: Could not determine resource-type %s ! Must be one of 'cpu' 'io' 'memory'.\n" $value >&2 printf "ERROR: Could not determine resource-type %s ! Must be one of 'cpu' 'io' 'memory'.\n" "$value" >&2
exit 2 exit 2
;; ;;
esac esac
;; ;;
*) *)
printf "ERROR: Could not determine kind %s ! Must be one of 'interval' 'scope' 'resource'\n" $kind >&2 printf "ERROR: Could not determine kind %s ! Must be one of 'interval' 'scope' 'resource'\n" "$kind" >&2
exit 2 exit 2
;; ;;
esac esac
printf "%s\n" $printable_name printf "%s" "$printable_name"
} }
iterate_config() { iterate_config() {
for resource in ${pressure_resources[@]}; do for resource in "${pressure_resources[@]}"; do
printable_resource=$( get_printable_name resource $resource ) local printable_resource
printf "multigraph pressure.%s_avg\n" $resource printable_resource=$( get_printable_name resource "$resource" )
printf "graph_title %s Pressure Stall Information - Average\n" $printable_resource printf "multigraph linux_psi.%s_avg\n" "$resource"
printf "graph_title %s Pressure Stall Information - Average\n" "$printable_resource"
printf "graph_category system\n" printf "graph_category system\n"
printf "graph_info Average PSI based latency caused by lack of %s resources.\n" $printable_resource printf "graph_info Average PSI based latency caused by lack of %s resources.\n" "$printable_resource"
printf "graph_vlabel %%\n" printf "graph_vlabel %%\n"
printf "graph_scale no\n" printf "graph_scale no\n"
for interval in ${pressure_intervals[@]}; do for interval in "${pressure_intervals[@]}"; do
printable_interval=$( get_printable_name interval $interval ) local printable_interval
output_config $resource $interval printable_interval=$( get_printable_name interval "$interval" )
output_config "$resource" "$interval"
done done
echo "" echo ""
done done
for resource in ${pressure_resources[@]}; do for resource in "${pressure_resources[@]}"; do
printable_resource=$( get_printable_name resource $resource ) local interval
printf "multigraph pressure.%s_total\n" $resource local printable_resource
printf "graph_title %s Pressure Stall Information - Rate\n" $printable_resource
printf "graph_category system\n"
printf "graph_info Total PSI based latency rate caused by lack of %s resources.\n" $printable_resource
printf "graph_vlabel rate\n"
interval="total" interval="total"
output_config $resource $interval printable_resource=$( get_printable_name resource "$resource" )
printf "multigraph linux_psi.%s_total\n" "$resource"
printf "graph_title %s Pressure Stall Information - Rate\n" "$printable_resource"
printf "graph_category system\n"
printf "graph_info Total PSI based latency rate caused by lack of %s resources.\n" "$printable_resource"
printf "graph_vlabel rate\n"
output_config "$resource" "$interval"
echo "" echo ""
done done
printf "multigraph pressure\n" printf "multigraph linux_psi\n"
printf "graph_title Pressure Stall Information - Average\n" printf "graph_title Pressure Stall Information - Average\n"
printf "graph_vlabel %%\n" printf "graph_vlabel %%\n"
printf "graph_scale no\n" printf "graph_scale no\n"
printf "graph_category system\n" printf "graph_category system\n"
printf "graph_info Average PSI based latency caused by lack of resources.\n" printf "graph_info Average PSI based latency caused by lack of resources.\n"
for resource in ${pressure_resources[@]}; do for resource in "${pressure_resources[@]}"; do
output_config $resource $summary_interval output_config "$resource" "$summary_interval"
done done
echo "" echo ""
} }
iterate_values() { iterate_values() {
for resource in ${pressure_resources[@]}; do for resource in "${pressure_resources[@]}"; do
printf "multigraph pressure.%s_avg\n" $resource printf "multigraph linux_psi.%s_avg\n" "$resource"
for interval in ${pressure_intervals[@]}; do for interval in "${pressure_intervals[@]}"; do
output_values $resource $interval output_values "$resource" "$interval"
done done
echo "" echo ""
done done
for resource in ${pressure_resources[@]}; do for resource in "${pressure_resources[@]}"; do
printf "multigraph pressure.%s_total\n" $resource local interval
interval="total" interval="total"
output_values $resource $interval printf "multigraph linux_psi.%s_total\n" "$resource"
output_values "$resource" "$interval"
echo "" echo ""
done done
printf "multigraph pressure\n" printf "multigraph linux_psi\n"
for resource in ${pressure_resources[@]}; do for resource in "${pressure_resources[@]}"; do
output_values $resource $summary_interval output_values "$resource" "$summary_interval"
done done
echo "" echo ""
} }
output_config() { output_config() {
resource=$1 local resource
interval=$2 local interval
local printable_resource
local printable_interval
resource="$1"
interval="$2"
printable_resource=$( get_printable_name resource "$resource" )
printable_interval=$( get_printable_name interval "$interval" )
printable_resource=$( get_printable_name resource $resource ) for scope in "${pressure_scopes[@]}"; do
printable_interval=$( get_printable_name interval $interval ) if [ "${resource}" == "cpu" ] && [ "${scope}" != "some" ]; then
for scope in ${pressure_scopes[@]}; do
if [ ${resource} == "cpu" ] && [ ${scope} != "some" ]; then
continue continue
else else
printable_scope=$( get_printable_name scope $scope ) local printable_scope
printf "psi_%s_%s_%s.min 0\n" $resource $interval $scope local this_warn_var
printf "psi_%s_%s_%s.label %s %s %s\n" $resource $interval $scope $printable_resource $printable_interval $printable_scope local this_crit_var
printable_scope=$( get_printable_name scope "$scope" )
this_warn_var=$( echo "warn_psi_${resource}_${interval}_${scope}" | sed 's/[^A-Za-z0-9_]/_/g' ) this_warn_var=$( echo "warn_psi_${resource}_${interval}_${scope}" | sed 's/[^A-Za-z0-9_]/_/g' )
if [ -n "${!this_warn_var}" ]; then
printf "psi_%s_%s_%s.warning %s\n" $resource $interval $scope ${!this_warn_var}
fi
this_crit_var=$( echo "crit_psi_${resource}_${interval}_${scope}" | sed 's/[^A-Za-z0-9_]/_/g' ) this_crit_var=$( echo "crit_psi_${resource}_${interval}_${scope}" | sed 's/[^A-Za-z0-9_]/_/g' )
if [ -n "${!this_crit_var}" ]; then
printf "psi_%s_%s_%s.critical %s\n" $resource $interval $scope ${!this_crit_var} printf "psi_%s_%s_%s.min 0\n" "$resource" "$interval" "$scope"
printf "psi_%s_%s_%s.label %s %s %s\n" "$resource" "$interval" "$scope" "$printable_resource" "$printable_interval" "$printable_scope"
if [ -n "${!this_warn_var}" ]; then
printf "psi_%s_%s_%s.warning %s\n" "$resource" "$interval" "$scope" "${!this_warn_var}"
fi fi
if [ $interval == "total" ]; then if [ -n "${!this_crit_var}" ]; then
printf "psi_%s_%s_%s.type DERIVE\n" $resource $interval $scope printf "psi_%s_%s_%s.critical %s\n" "$resource" "$interval" "$scope" "${!this_crit_var}"
fi
if [ "$interval" == "total" ]; then
printf "psi_%s_%s_%s.type DERIVE\n" "$resource" "$interval" "$scope"
fi fi
fi fi
done done
} }
output_values() { output_values() {
resource=$1 local resource
interval=$2 local interval
resource="$1"
interval="$2"
for scope in ${pressure_scopes[@]}; do for scope in "${pressure_scopes[@]}"; do
if [ ${resource} == "cpu" ] && [ ${scope} != "some" ]; then if [ "${resource}" == "cpu" ] && [ "${scope}" != "some" ]; then
continue continue
else else
printf "psi_%s_%s_%s.value %s\n" $resource $interval $scope $(get_pressure_value $resource $interval $scope) printf "psi_%s_%s_%s.value %s\n" "$resource" "$interval" "$scope" "$(get_pressure_value "$resource" "$interval" "$scope")"
fi fi
done done
} }
output_usage() { output_usage() {
printf >&2 "%s - munin plugin to graph pressure stall information for CPU, Memory and IO as reported by the Linux kernel.\n" ${0##*/} printf >&2 "%s - munin plugin to graph pressure stall information for CPU, Memory and IO as reported by the Linux kernel.\n" "${0##*/}"
printf >&2 "Usage: %s [config]\n" ${0##*/} printf >&2 "Usage: %s [config]\n" "${0##*/}"
printf >&2 "You may use environment settings in a plugin-config file, used by munin (for example /etc/munin/plugin-conf.d/munin-node) to further adjust settings.\n" printf >&2 "You may use environment settings in a plugin-config file, used by munin (for example /etc/munin/plugin-conf.d/munin-node) to further adjust settings.\n"
printf >&2 "You can use these settings to configure which resources, intervals or scopes are monitored or to configure warning and critical levels.\n" printf >&2 "You can use these settings to configure which resources, intervals or scopes are monitored or to configure warning and critical levels.\n"
printf >&2 "To do so use a syntax like this:\n" printf >&2 "To do so use a syntax like this:\n"
printf >&2 "[pressure]\n" printf >&2 "[linux_psi]\n"
printf >&2 "env.resources cpu io memory\n" printf >&2 "env.resources cpu io memory\n"
printf >&2 "env.intervals avg10 avg60 avg300\n" printf >&2 "env.intervals avg10 avg60 avg300\n"
printf >&2 "env.scopes some full\n" printf >&2 "env.scopes some full\n"
@ -304,19 +330,22 @@ output_usage() {
printf >&2 "env.crit_psi_io_total_full 2000\n" printf >&2 "env.crit_psi_io_total_full 2000\n"
} }
case $# in case "$#" in
0) 0)
iterate_values iterate_values
;; ;;
1) 1)
case $1 in case "$1" in
auto|autoconf) autoconf)
check_autoconf check_autoconf
;; ;;
config) config)
iterate_config iterate_config
;; ;;
fetch)
iterate_values
;;
*) *)
output_usage output_usage
exit 1 exit 1