check_asterisk_peers

I do not know what the correct way is here to publish/suggest patches.
I implemented pjsip for this plugin:

--- check_asterisk_peers 2025-04-10 08:45:57.319369355 +0200
+++ check_asterisk_peers_pjsip 2025-04-10 09:11:59.703011415 +0200
@@ -3,6 +3,8 @@
# Check asterisk peers plugin for Nagios.
# Written by Chad Phillips ([email protected])
# Last Modified: 2009-05-02
+# modified by Paul Neuwirth ([email protected]) to include pjsip
+# 2025-04-10

ASTERISK=/usr/sbin/asterisk

@@ -13,7 +15,7 @@

print_usage() {
echo "
-Usage: check_asterisk_peers [--type | -t ] [--peers | -p ] [--registrations | -r ] [--verify-peers] [--verify-registrations] [--config-file ]
+Usage: check_asterisk_peers [--type | -t ] [--peers | -p ] [--registrations | -r ] [--verify-peers] [--verify-registrations] [--config-file ]
Usage: check_asterisk_peers --help | -h

Description:
@@ -62,6 +64,7 @@
Default value is based on the --type setting:

sip: /etc/asterisk/sip.conf
+ pjsip: /etc/asterisk/pjsip.conf
iax: /etc/asterisk/iax.conf

--help | -h Print this help and exit.
@@ -227,12 +230,14 @@
done

# Make sure we have a valid peer type.
-if [ "$peer_type" != "" ] && [ "$peer_type" != "sip" ] && [ "$peer_type" != "iax" ]; then
- echo "Peer type must be one of: sip, iax."
+if [ "$peer_type" != "" ] && [ "$peer_type" != "sip" ] && [ "$peer_type" != "pjsip" ] && [ "$peer_type" != "iax" ]; then
+ echo "Peer type must be one of: sip, iax, pjsip."
exit $STATE_UNKNOWN
# Convert iax type into internal iax2 type for the Asterisk executable.
elif [ "$peer_type" = "iax" ]; then
peer_type=iax2
+elif [ "$peer_type" = "pjsip" ]; then
+ peer_type=pjsip
# Default type is SIP.
else
peer_type=sip
@@ -247,6 +252,8 @@
if [ "$conf_file" = "" ]; then
if [ "$peer_type" = "iax2" ]; then
conf_file=/etc/asterisk/iax.conf
+ elif [ "$peer_type" = "pjsip" ]; then
+ conf_file=/etc/asterisk/pjsip.conf
else
conf_file=/etc/asterisk/sip.conf
fi
@@ -258,10 +265,15 @@
if [ "$registrations" ]; then
for r in $registrations
do
- REGISTRATION_FORMAT_CORRECT=`echo "$r" | grep ".+@.+"`
- if [ ! "$REGISTRATION_FORMAT_CORRECT" ]; then
- echo "Registration $r is not in the valid username@uri format."
- exit $STATE_UNKNOWN
+ if [ "$peer_type" != "pjsip" ]; then
+ REGISTRATION_FORMAT_CORRECT=`echo "$r" | grep ".+@.+"`
+ if [ ! "$REGISTRATION_FORMAT_CORRECT" ]; then
+ echo "Registration $r is not in the valid username@uri format."
+ exit $STATE_UNKNOWN
+ fi
+ else
+ #no limitations for pjsip registrations, afaik
+ REGISTRATION_FORMAT_CORRECT=1
fi
done
fi
@@ -277,31 +289,55 @@
for p in $peers
do
if [ "$verify_peers" ]; then
- peer_verified=`echo "$all_config" | grep "^[${p}]$"`
+ peer_verified=`echo "$all_config" | grep "^[${p}].*$"`
else
peer_verified=1
fi
if [ "$peer_verified" ]; then
# Fetch the data from asterisk.
- command_output=`$ASTERISK -rx "$peer_type show peer $p" 2>&1`
- check_asterisk_result $? "$command_output"
- status=`echo "$command_output" | grep "^[[:space:]]*Status[[:space:]]*:" | awk '{print $3;}'`
- if [ "$status" = "OK" ]; then
- if [ "$test_ok" ]; then
- test_ok="${test_ok}, $p"
+ if [ "$peer_type" = "pjsip" ]; then
+ command_output=`$ASTERISK -rx "$peer_type show endpoint $p" 2>&1`
+ check_asterisk_result $? "$command_output"
+ status=`echo "$command_output" | grep "^sEndpoint:s*$p.*" | awk -F' +' '{print $3;}'`
+ if [ "$status" = "Not in use" ] || [ "$status" = "In use" ]; then
+ if [ "$test_ok" ]; then
+ test_ok="${test_ok}, $p"
+ else
+ test_ok="$p"
+ fi
else
- test_ok="$p"
+ if [ "$status" ]; then
+ status_error="$status"
+ else
+ status_error="Not found"
+ fi
+ if [ "$test_errors" ]; then
+ test_errors="${test_errors}, ${p}: $status_error"
+ else
+ test_errors="${p}: $status_error"
+ fi
fi
else
- if [ "$status" ]; then
- status_error="$status"
- else
- status_error="Not found"
- fi
- if [ "$test_errors" ]; then
- test_errors="${test_errors}, ${p}: $status_error"
+ command_output=`$ASTERISK -rx "$peer_type show peer $p" 2>&1`
+ check_asterisk_result $? "$command_output"
+ status=`echo "$command_output" | grep "^[[:space:]]*Status[[:space:]]*:" | awk '{print $3;}'`
+ if [ "$status" = "OK" ]; then
+ if [ "$test_ok" ]; then
+ test_ok="${test_ok}, $p"
+ else
+ test_ok="$p"
+ fi
else
- test_errors="${p}: $status_error"
+ if [ "$status" ]; then
+ status_error="$status"
+ else
+ status_error="Not found"
+ fi
+ if [ "$test_errors" ]; then
+ test_errors="${test_errors}, ${p}: $status_error"
+ else
+ test_errors="${p}: $status_error"
+ fi
fi
fi
else
@@ -314,8 +350,8 @@
done
fi

-# Check registrations.
-if [ "$registrations" ]; then
+# Check registrations. not pjsip
+if [ "$peer_type" != "pjsip" ] && [ "$registrations" ]; then
# Fetch the data from asterisk.
command_output=`$ASTERISK -rx "$peer_type show registry" 2>&1`
check_asterisk_result $? "$command_output"
@@ -364,6 +400,50 @@
done
fi

+# Check registrations. pjsip
+if [ "$peer_type" = "pjsip" ] && [ "$registrations" ]; then
+ # Fetch the data from asterisk.
+ command_output=`$ASTERISK -rx "$peer_type show registrations" 2>&1`
+ check_asterisk_result $? "$command_output"
+ for r in $registrations
+ do
+ if [ "$verify_registrations" ]; then
+ # best what can be done without getting too deep into config file (type=registration might be part of a template...)
+ registration_verified=`echo "$all_config" | grep "^[${r}].*$"`
+ else
+ registration_verified=1
+ fi
+ if [ "$registration_verified" ]; then
+ # This regex isn't perfect, but it does the trick ok.
+ status=`echo "$command_output" | grep "^s$r/.*" | awk -F' +' '{ print $3;}'`
+ if [ "$status" = "Registered" ]; then
+ if [ "$test_ok" ]; then
+ test_ok="${test_ok}, $r"
+ else
+ test_ok="$r"
+ fi
+ else
+ if [ "$status" ]; then
+ status_error="$status"
+ else
+ status_error="Not found"
+ fi
+ if [ "$test_errors" ]; then
+ test_errors="${test_errors}, ${r}: $status_error"
+ else
+ test_errors="${r}: $status_error"
+ fi
+ fi
+ else
+ if [ "$test_ok" ]; then
+ test_ok="${test_ok}, $r (not active)"
+ else
+ test_ok="$r (not active)"
+ fi
+ fi
+ done
+fi
+
if [ "$test_errors" ]; then
output="$output ERROR: $test_errors"
set_exit_status $STATE_CRITICAL
@@ -379,4 +459,4 @@
fi

echo "$output"
-exit $exitstatus
No newline at end of file
+exit $exitstatus

Hello, please help me. This script locally works fine, but i have issue with arguments on nagios monitoring server

Client side with asterisk is working fine. After entering command ./check_asterisk_peers -t sip -p 10
i get
ERROR: 10: Not found
It's ok because extension 10 is not registered

In /etc/nagios/nrpe.conf command is defined as:
command[check_asterisk_peers]=/usr/lib/nagios/plugins/check_asterisk_peers -t sip -p sip channel

-------
Command line on nagios monitoring server:./check_nrpe -H 192.168.1.109 -c check_asterisk_peers -a "-p 10"

i get this:
ERROR: sipchannel: Not found

Argument with -p 10 is ignored. Please help me with correct syntax in nrpe.conf

Another question... How to define service with checking extension 10 in nagios?

had problems with your script, so i modified it. Especially the register part was not working for me under 1.6.2 ($ character after {uri}).

Not sure why the user was cut off at 12 chars, removed that, because didnt work.

I included also checking delay because the trunk should not go under 100ms if you want to have a reliable jitter free phone connection.

http://pastebin.com/6XxU5k0w

--- check_asterisk_peers 2011-11-05 11:56:16.352105211 +0100
+++ check_asterisk_peers.sh 2011-11-05 11:56:11.376105311 +0100
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash

# Check asterisk peers plugin for Nagios.
# Written by Chad Phillips ([email protected])
@@ -7,6 +7,7 @@
ASTERISK=/usr/sbin/asterisk

PROGPATH=`dirname $0`
+PROGPATH="/usr/lib/nagios/plugins"
REVISION=`echo '$Revision: 2 $' | sed -e 's/[^0-9.]//g'`

. $PROGPATH/utils.sh
@@ -333,9 +334,11 @@
if [ "$registration_verified" ]; then
# Have to cut off registration name at 12 characters, so let's hope
# it's still unique!
- cut_user=${user:0:12}
+ #cut_user=${user:0:12}
+ cut_user=${r:0:12}
# This regex isn't perfect, but it does the trick ok.
- status=`echo "$command_output" | grep "^${uri}:[[:digit:]].+[[:space:]].+${cut_user}[[:space:]].+" | awk '{print $4;}'`
+ #status=`echo "$command_output" | grep "^${uri}:[[:digit:]].+[[:space:]].+${cut_user}[[:space:]].+" | awk '{print $4;}'`
+ status=`echo "$command_output" | grep "^${uri}:[[:digit:]].+[[:space:]].+[[:alpha:]].+${cut_user}[[:space:]].+" | awk '{print $5;}'`
if [ "$status" = "Registered" ]; then
if [ "$test_ok" ]; then
test_ok="${test_ok}, $r"

Couple things about this

1) - It is outdated for the newer releases of asterisk

2) - the config files portion doesn't add in the absolute path to the files (it just grabs whatever is in the sip.conf - which usually doesn't have the /etc/asterisk)

Can anyone mention how to install it. I failed in finding instructions to install this plugin and other plugins

Hi,

This is an excellent plugin.
But it can be great if it can also check the latency of the peer which is reported by asterisk via the "iax2 show peers" command and set warning/critical threshold, like check_iax does.

Yuval