EPICSWIKI - User contributions [en]

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2011-12-02T15:02:42Z

MauroGiacchini: /* Save the original Nagios setup and replace it */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on RedHat Enterprise 5 x86 Linux box ==

===Nagios default installation===

Nagios application is provided by rpmforge repository, so you have to install it to configure yum properly.

root>'' wget http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

To install the package, you have to install DAG's GPG key:

root>'' rpm --import http://apt.sw.be/RPM-GPG-KEY.dag.txt ''

(Optional) Verify the package you have downloaded

root>'' rpm -K rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

'''NB''' (Security warning): The rpmforge-release package imports GPG keys into your RPM database. As long as you have verified the md5sum of the key injection package, and trust Dag, et al., then it should be as safe as your trust of them extends.

Install the package

root>'' rpm -i rpmforge-release-0.5.2-2.el5.rf.i386.rpm''

At this point it is possible to install the Nagios application. For the "server side", you need these following packages:
::1) '''nagios''': the main application package
::2) '''nagios-plugins''': provides all the command scripts used by users to define nagios services. In some cases there is also nagios-plugins-all (that's better)
::3) '''nagios-plugins-nrpe''': provides the check_nrpe script used to communicate with nagios clients and run remote services

root>'' yum install -y nagios''

root>'' yum install -y nagios-plugins''

root>'' yum install -y nagios-plugins-nrpe''

With that I've installed Nagios 3.2.3 version.

== Nagios: configuration ==

When you install Nagios by yum, all the apache configuration are done by default.

To check the web interface you must define the password for '''nagiosadmin''' user (default nagios administrator). This passsword must be encrypted. you can use '''htpasswd''' command to set that an save in

''/etc/nagios/htpasswd.users''

Start the apache and nagios services

root>'' service httpd start'' (restart)
root>'' service nagios start''

and check the nagios webpage at '''http://localhost.localdomain/nagios''' . If it is all correct, you have to see the authentication popup. When you are in the main page, you can monitor the localhost machine (nagios provides some information about hosts and services); all the services should be OK, but in some case you have to check some permissions/configurations.

The main configuration file is '''/etc/nagios/nagios.cfg'''

in this file you can configure every feature of nagios. We use most of the default options, the only parameters enabled are:

* enable servers directory: you can define all the servers' cfg files into this directory (cleaner job)

'''cfg_dir=/etc/nagios/servers'''

:and create the folder:

# mkdir /etc/nagios/servers

In the servers folder you have to define all the hosts you want to monitor. For a correct management, you have to define 2 different files:

* '''HOST.cfg''': define the specifics that nagios uses to monitor the host desired. You must define one file per host!
* '''groups.cfg''': indicate all the different groups of hosts. It is very useful to manage and monitor a large number of machines

Example:
* File '''''servers/example.cfg''''':

define host{
use linux-server
host_name '''example'''
alias '''example display in web interface'''
address '''10.6.0.1'''
notification_period '''24x7'''
icon_image '''example.jpg'''
}
define service{
use local-service
host_name example
service_description '''PING'''
check_command '''check_ping!100.0,20%!500.0,60%'''
}
define service{
use local-service
host_name example
service_description '''SSH'''
check_command '''check_ssh'''
}

:in this code:
::1) '''notification_period''' is defined in /etc/nagios/objects/timeperiods.cfg --> you can edit this file to add/set different time periods
::2) '''icon_image''' is situated in '''/usr/share/nagios/images/logos/'''. if you want to add new images you must save them in this place
::3) '''service_description''' is the service name displayed in the web interface
::4) '''check_command''' define the command desired and situated in '''/usr/lib/nagios/plugins'''

* File '''''servers/groups.cfg''''':

define hostgroup{
hostgroup_name example ; The name of the hostgroup
alias example @ MyLab ; Long name of the group
members localhost, '''example'''
}

You have to define the '''host_name''' used before in '''members''' variable.

After these changes, verify the configuration files through

# nagios -v /etc/nagios/nagios.cfg

and then, if there aren't any error, restart the service

# service nagios restart

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/nagios.log - Nagios log
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/nagios.conf - Nagios Apache folder files

===Insert the EPICS Nagios Plugins===

What you did in the chapters above was a generic Nagios installation/setup.

Going to [http://www.lnl.infn.it/~epics/NAL/LNL/ here]. You will find the nagios plugin to EPICS _and_ a complete tra ball of a nagios configuration. Download the pkugin and save into the

''/usr/lib/nagios/plugins/''

Change the permission to check_caget.sh

root> ''chmod +x check_caget.sh
''

now verify that is usable with:

> ''./check_caget.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to broadcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

Download the epics.gif image available from the same [http://www.lnl.infn.it/~epics/NAL/LNL/ place]

and install that:

root> ''mv epics,gif /usr/share/nagios/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same [http://www.lnl.infn.it/~epics/NAL/LNL/ place]

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===SELinux setup===

For the first test: set it permissive by

root> ''system-config-securitylevel''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

NB. If you are using my etc.nagios.tar the passwd to login is "nagiosadmin"

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind. Acknowledgments to Maurizio Montis, who made a kickstart script to deploy a RHEL5 box equipped with Nagios ready to use, and, adjust and fix the old notes on FC7 to the new OS: RHEL5.

More information about NAL could be found [http://www.lnl.infn.it/~epics/joomla/nal.html here].
A special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use [http://www.lnl.infn.it/~epics/LivEPICS/Slackware/Slax6.0/ here] .

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 15.54, 2 Dec 2011

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2011-12-02T15:02:18Z

MauroGiacchini: /* Now install the EPICS logos images */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on RedHat Enterprise 5 x86 Linux box ==

===Nagios default installation===

Nagios application is provided by rpmforge repository, so you have to install it to configure yum properly.

root>'' wget http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

To install the package, you have to install DAG's GPG key:

root>'' rpm --import http://apt.sw.be/RPM-GPG-KEY.dag.txt ''

(Optional) Verify the package you have downloaded

root>'' rpm -K rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

'''NB''' (Security warning): The rpmforge-release package imports GPG keys into your RPM database. As long as you have verified the md5sum of the key injection package, and trust Dag, et al., then it should be as safe as your trust of them extends.

Install the package

root>'' rpm -i rpmforge-release-0.5.2-2.el5.rf.i386.rpm''

At this point it is possible to install the Nagios application. For the "server side", you need these following packages:
::1) '''nagios''': the main application package
::2) '''nagios-plugins''': provides all the command scripts used by users to define nagios services. In some cases there is also nagios-plugins-all (that's better)
::3) '''nagios-plugins-nrpe''': provides the check_nrpe script used to communicate with nagios clients and run remote services

root>'' yum install -y nagios''

root>'' yum install -y nagios-plugins''

root>'' yum install -y nagios-plugins-nrpe''

With that I've installed Nagios 3.2.3 version.

== Nagios: configuration ==

When you install Nagios by yum, all the apache configuration are done by default.

To check the web interface you must define the password for '''nagiosadmin''' user (default nagios administrator). This passsword must be encrypted. you can use '''htpasswd''' command to set that an save in

''/etc/nagios/htpasswd.users''

Start the apache and nagios services

root>'' service httpd start'' (restart)
root>'' service nagios start''

and check the nagios webpage at '''http://localhost.localdomain/nagios''' . If it is all correct, you have to see the authentication popup. When you are in the main page, you can monitor the localhost machine (nagios provides some information about hosts and services); all the services should be OK, but in some case you have to check some permissions/configurations.

The main configuration file is '''/etc/nagios/nagios.cfg'''

in this file you can configure every feature of nagios. We use most of the default options, the only parameters enabled are:

* enable servers directory: you can define all the servers' cfg files into this directory (cleaner job)

'''cfg_dir=/etc/nagios/servers'''

:and create the folder:

# mkdir /etc/nagios/servers

In the servers folder you have to define all the hosts you want to monitor. For a correct management, you have to define 2 different files:

* '''HOST.cfg''': define the specifics that nagios uses to monitor the host desired. You must define one file per host!
* '''groups.cfg''': indicate all the different groups of hosts. It is very useful to manage and monitor a large number of machines

Example:
* File '''''servers/example.cfg''''':

define host{
use linux-server
host_name '''example'''
alias '''example display in web interface'''
address '''10.6.0.1'''
notification_period '''24x7'''
icon_image '''example.jpg'''
}
define service{
use local-service
host_name example
service_description '''PING'''
check_command '''check_ping!100.0,20%!500.0,60%'''
}
define service{
use local-service
host_name example
service_description '''SSH'''
check_command '''check_ssh'''
}

:in this code:
::1) '''notification_period''' is defined in /etc/nagios/objects/timeperiods.cfg --> you can edit this file to add/set different time periods
::2) '''icon_image''' is situated in '''/usr/share/nagios/images/logos/'''. if you want to add new images you must save them in this place
::3) '''service_description''' is the service name displayed in the web interface
::4) '''check_command''' define the command desired and situated in '''/usr/lib/nagios/plugins'''

* File '''''servers/groups.cfg''''':

define hostgroup{
hostgroup_name example ; The name of the hostgroup
alias example @ MyLab ; Long name of the group
members localhost, '''example'''
}

You have to define the '''host_name''' used before in '''members''' variable.

After these changes, verify the configuration files through

# nagios -v /etc/nagios/nagios.cfg

and then, if there aren't any error, restart the service

# service nagios restart

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/nagios.log - Nagios log
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/nagios.conf - Nagios Apache folder files

===Insert the EPICS Nagios Plugins===

What you did in the chapters above was a generic Nagios installation/setup.

Going to [http://www.lnl.infn.it/~epics/NAL/LNL/ here]. You will find the nagios plugin to EPICS _and_ a complete tra ball of a nagios configuration. Download the pkugin and save into the

''/usr/lib/nagios/plugins/''

Change the permission to check_caget.sh

root> ''chmod +x check_caget.sh
''

now verify that is usable with:

> ''./check_caget.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to broadcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

Download the epics.gif image available from the same [http://www.lnl.infn.it/~epics/NAL/LNL/ place]

and install that:

root> ''mv epics,gif /usr/share/nagios/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same [place http://www.lnl.infn.it/~epics/NAL/LNL/]

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===SELinux setup===

For the first test: set it permissive by

root> ''system-config-securitylevel''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

NB. If you are using my etc.nagios.tar the passwd to login is "nagiosadmin"

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind. Acknowledgments to Maurizio Montis, who made a kickstart script to deploy a RHEL5 box equipped with Nagios ready to use, and, adjust and fix the old notes on FC7 to the new OS: RHEL5.

More information about NAL could be found [http://www.lnl.infn.it/~epics/joomla/nal.html here].
A special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use [http://www.lnl.infn.it/~epics/LivEPICS/Slackware/Slax6.0/ here] .

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 15.54, 2 Dec 2011

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2011-12-02T15:01:53Z

MauroGiacchini: /* Insert the EPICS Nagios Plugins */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on RedHat Enterprise 5 x86 Linux box ==

===Nagios default installation===

Nagios application is provided by rpmforge repository, so you have to install it to configure yum properly.

root>'' wget http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

To install the package, you have to install DAG's GPG key:

root>'' rpm --import http://apt.sw.be/RPM-GPG-KEY.dag.txt ''

(Optional) Verify the package you have downloaded

root>'' rpm -K rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

'''NB''' (Security warning): The rpmforge-release package imports GPG keys into your RPM database. As long as you have verified the md5sum of the key injection package, and trust Dag, et al., then it should be as safe as your trust of them extends.

Install the package

root>'' rpm -i rpmforge-release-0.5.2-2.el5.rf.i386.rpm''

At this point it is possible to install the Nagios application. For the "server side", you need these following packages:
::1) '''nagios''': the main application package
::2) '''nagios-plugins''': provides all the command scripts used by users to define nagios services. In some cases there is also nagios-plugins-all (that's better)
::3) '''nagios-plugins-nrpe''': provides the check_nrpe script used to communicate with nagios clients and run remote services

root>'' yum install -y nagios''

root>'' yum install -y nagios-plugins''

root>'' yum install -y nagios-plugins-nrpe''

With that I've installed Nagios 3.2.3 version.

== Nagios: configuration ==

When you install Nagios by yum, all the apache configuration are done by default.

To check the web interface you must define the password for '''nagiosadmin''' user (default nagios administrator). This passsword must be encrypted. you can use '''htpasswd''' command to set that an save in

''/etc/nagios/htpasswd.users''

Start the apache and nagios services

root>'' service httpd start'' (restart)
root>'' service nagios start''

and check the nagios webpage at '''http://localhost.localdomain/nagios''' . If it is all correct, you have to see the authentication popup. When you are in the main page, you can monitor the localhost machine (nagios provides some information about hosts and services); all the services should be OK, but in some case you have to check some permissions/configurations.

The main configuration file is '''/etc/nagios/nagios.cfg'''

in this file you can configure every feature of nagios. We use most of the default options, the only parameters enabled are:

* enable servers directory: you can define all the servers' cfg files into this directory (cleaner job)

'''cfg_dir=/etc/nagios/servers'''

:and create the folder:

# mkdir /etc/nagios/servers

In the servers folder you have to define all the hosts you want to monitor. For a correct management, you have to define 2 different files:

* '''HOST.cfg''': define the specifics that nagios uses to monitor the host desired. You must define one file per host!
* '''groups.cfg''': indicate all the different groups of hosts. It is very useful to manage and monitor a large number of machines

Example:
* File '''''servers/example.cfg''''':

define host{
use linux-server
host_name '''example'''
alias '''example display in web interface'''
address '''10.6.0.1'''
notification_period '''24x7'''
icon_image '''example.jpg'''
}
define service{
use local-service
host_name example
service_description '''PING'''
check_command '''check_ping!100.0,20%!500.0,60%'''
}
define service{
use local-service
host_name example
service_description '''SSH'''
check_command '''check_ssh'''
}

:in this code:
::1) '''notification_period''' is defined in /etc/nagios/objects/timeperiods.cfg --> you can edit this file to add/set different time periods
::2) '''icon_image''' is situated in '''/usr/share/nagios/images/logos/'''. if you want to add new images you must save them in this place
::3) '''service_description''' is the service name displayed in the web interface
::4) '''check_command''' define the command desired and situated in '''/usr/lib/nagios/plugins'''

* File '''''servers/groups.cfg''''':

define hostgroup{
hostgroup_name example ; The name of the hostgroup
alias example @ MyLab ; Long name of the group
members localhost, '''example'''
}

You have to define the '''host_name''' used before in '''members''' variable.

After these changes, verify the configuration files through

# nagios -v /etc/nagios/nagios.cfg

and then, if there aren't any error, restart the service

# service nagios restart

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/nagios.log - Nagios log
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/nagios.conf - Nagios Apache folder files

===Insert the EPICS Nagios Plugins===

What you did in the chapters above was a generic Nagios installation/setup.

Going to [http://www.lnl.infn.it/~epics/NAL/LNL/ here]. You will find the nagios plugin to EPICS _and_ a complete tra ball of a nagios configuration. Download the pkugin and save into the

''/usr/lib/nagios/plugins/''

Change the permission to check_caget.sh

root> ''chmod +x check_caget.sh
''

now verify that is usable with:

> ''./check_caget.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to broadcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

Download the epics.gif image available from the same [place http://www.lnl.infn.it/~epics/NAL/LNL/]

and install that:

root> ''mv epics,gif /usr/share/nagios/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same [place http://www.lnl.infn.it/~epics/NAL/LNL/]

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===SELinux setup===

For the first test: set it permissive by

root> ''system-config-securitylevel''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

NB. If you are using my etc.nagios.tar the passwd to login is "nagiosadmin"

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind. Acknowledgments to Maurizio Montis, who made a kickstart script to deploy a RHEL5 box equipped with Nagios ready to use, and, adjust and fix the old notes on FC7 to the new OS: RHEL5.

More information about NAL could be found [http://www.lnl.infn.it/~epics/joomla/nal.html here].
A special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use [http://www.lnl.infn.it/~epics/LivEPICS/Slackware/Slax6.0/ here] .

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 15.54, 2 Dec 2011

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2011-12-02T14:52:54Z

MauroGiacchini: /* Conclusions */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on RedHat Enterprise 5 x86 Linux box ==

===Nagios default installation===

Nagios application is provided by rpmforge repository, so you have to install it to configure yum properly.

root>'' wget http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

To install the package, you have to install DAG's GPG key:

root>'' rpm --import http://apt.sw.be/RPM-GPG-KEY.dag.txt ''

(Optional) Verify the package you have downloaded

root>'' rpm -K rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

'''NB''' (Security warning): The rpmforge-release package imports GPG keys into your RPM database. As long as you have verified the md5sum of the key injection package, and trust Dag, et al., then it should be as safe as your trust of them extends.

Install the package

root>'' rpm -i rpmforge-release-0.5.2-2.el5.rf.i386.rpm''

At this point it is possible to install the Nagios application. For the "server side", you need these following packages:
::1) '''nagios''': the main application package
::2) '''nagios-plugins''': provides all the command scripts used by users to define nagios services. In some cases there is also nagios-plugins-all (that's better)
::3) '''nagios-plugins-nrpe''': provides the check_nrpe script used to communicate with nagios clients and run remote services

root>'' yum install -y nagios''

root>'' yum install -y nagios-plugins''

root>'' yum install -y nagios-plugins-nrpe''

With that I've installed Nagios 3.2.3 version.

== Nagios: configuration ==

When you install Nagios by yum, all the apache configuration are done by default.

To check the web interface you must define the password for '''nagiosadmin''' user (default nagios administrator). This passsword must be encrypted. you can use '''htpasswd''' command to set that an save in

''/etc/nagios/htpasswd.users''

Start the apache and nagios services

root>'' service httpd start'' (restart)
root>'' service nagios start''

and check the nagios webpage at '''http://localhost.localdomain/nagios''' . If it is all correct, you have to see the authentication popup. When you are in the main page, you can monitor the localhost machine (nagios provides some information about hosts and services); all the services should be OK, but in some case you have to check some permissions/configurations.

The main configuration file is '''/etc/nagios/nagios.cfg'''

in this file you can configure every feature of nagios. We use most of the default options, the only parameters enabled are:

* enable servers directory: you can define all the servers' cfg files into this directory (cleaner job)

'''cfg_dir=/etc/nagios/servers'''

:and create the folder:

# mkdir /etc/nagios/servers

In the servers folder you have to define all the hosts you want to monitor. For a correct management, you have to define 2 different files:

* '''HOST.cfg''': define the specifics that nagios uses to monitor the host desired. You must define one file per host!
* '''groups.cfg''': indicate all the different groups of hosts. It is very useful to manage and monitor a large number of machines

Example:
* File '''''servers/example.cfg''''':

define host{
use linux-server
host_name '''example'''
alias '''example display in web interface'''
address '''10.6.0.1'''
notification_period '''24x7'''
icon_image '''example.jpg'''
}
define service{
use local-service
host_name example
service_description '''PING'''
check_command '''check_ping!100.0,20%!500.0,60%'''
}
define service{
use local-service
host_name example
service_description '''SSH'''
check_command '''check_ssh'''
}

:in this code:
::1) '''notification_period''' is defined in /etc/nagios/objects/timeperiods.cfg --> you can edit this file to add/set different time periods
::2) '''icon_image''' is situated in '''/usr/share/nagios/images/logos/'''. if you want to add new images you must save them in this place
::3) '''service_description''' is the service name displayed in the web interface
::4) '''check_command''' define the command desired and situated in '''/usr/lib/nagios/plugins'''

* File '''''servers/groups.cfg''''':

define hostgroup{
hostgroup_name example ; The name of the hostgroup
alias example @ MyLab ; Long name of the group
members localhost, '''example'''
}

You have to define the '''host_name''' used before in '''members''' variable.

After these changes, verify the configuration files through

# nagios -v /etc/nagios/nagios.cfg

and then, if there aren't any error, restart the service

# service nagios restart

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/nagios.log - Nagios log
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/nagios.conf - Nagios Apache folder files

===Insert the EPICS Nagios Plugins===

What you did in the chapters above was a generic Nagios installation/setup.

Going to [here http://www.lnl.infn.it/~epics/NAL/LNL/]. You will find the nagios plugin to EPICS _and_ a complete tra ball of a nagios configuration. Download the pkugin and save into the

''/usr/lib/nagios/plugins/''

Change the permission to check_caget.sh

root> ''chmod +x check_caget.sh
''

now verify that is usable with:

> ''./check_caget.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to broadcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

Download the epics.gif image available from the same [place http://www.lnl.infn.it/~epics/NAL/LNL/]

and install that:

root> ''mv epics,gif /usr/share/nagios/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same [place http://www.lnl.infn.it/~epics/NAL/LNL/]

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===SELinux setup===

For the first test: set it permissive by

root> ''system-config-securitylevel''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

NB. If you are using my etc.nagios.tar the passwd to login is "nagiosadmin"

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind. Acknowledgments to Maurizio Montis, who made a kickstart script to deploy a RHEL5 box equipped with Nagios ready to use, and, adjust and fix the old notes on FC7 to the new OS: RHEL5.

More information about NAL could be found [http://www.lnl.infn.it/~epics/joomla/nal.html here].
A special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use [http://www.lnl.infn.it/~epics/LivEPICS/Slackware/Slax6.0/ here] .

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 15.54, 2 Dec 2011

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2011-12-02T14:48:51Z

MauroGiacchini: /* Insert the EPICS Nagios Plugins */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on RedHat Enterprise 5 x86 Linux box ==

===Nagios default installation===

Nagios application is provided by rpmforge repository, so you have to install it to configure yum properly.

root>'' wget http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

To install the package, you have to install DAG's GPG key:

root>'' rpm --import http://apt.sw.be/RPM-GPG-KEY.dag.txt ''

(Optional) Verify the package you have downloaded

root>'' rpm -K rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

'''NB''' (Security warning): The rpmforge-release package imports GPG keys into your RPM database. As long as you have verified the md5sum of the key injection package, and trust Dag, et al., then it should be as safe as your trust of them extends.

Install the package

root>'' rpm -i rpmforge-release-0.5.2-2.el5.rf.i386.rpm''

At this point it is possible to install the Nagios application. For the "server side", you need these following packages:
::1) '''nagios''': the main application package
::2) '''nagios-plugins''': provides all the command scripts used by users to define nagios services. In some cases there is also nagios-plugins-all (that's better)
::3) '''nagios-plugins-nrpe''': provides the check_nrpe script used to communicate with nagios clients and run remote services

root>'' yum install -y nagios''

root>'' yum install -y nagios-plugins''

root>'' yum install -y nagios-plugins-nrpe''

With that I've installed Nagios 3.2.3 version.

== Nagios: configuration ==

When you install Nagios by yum, all the apache configuration are done by default.

To check the web interface you must define the password for '''nagiosadmin''' user (default nagios administrator). This passsword must be encrypted. you can use '''htpasswd''' command to set that an save in

''/etc/nagios/htpasswd.users''

Start the apache and nagios services

root>'' service httpd start'' (restart)
root>'' service nagios start''

and check the nagios webpage at '''http://localhost.localdomain/nagios''' . If it is all correct, you have to see the authentication popup. When you are in the main page, you can monitor the localhost machine (nagios provides some information about hosts and services); all the services should be OK, but in some case you have to check some permissions/configurations.

The main configuration file is '''/etc/nagios/nagios.cfg'''

in this file you can configure every feature of nagios. We use most of the default options, the only parameters enabled are:

* enable servers directory: you can define all the servers' cfg files into this directory (cleaner job)

'''cfg_dir=/etc/nagios/servers'''

:and create the folder:

# mkdir /etc/nagios/servers

In the servers folder you have to define all the hosts you want to monitor. For a correct management, you have to define 2 different files:

* '''HOST.cfg''': define the specifics that nagios uses to monitor the host desired. You must define one file per host!
* '''groups.cfg''': indicate all the different groups of hosts. It is very useful to manage and monitor a large number of machines

Example:
* File '''''servers/example.cfg''''':

define host{
use linux-server
host_name '''example'''
alias '''example display in web interface'''
address '''10.6.0.1'''
notification_period '''24x7'''
icon_image '''example.jpg'''
}
define service{
use local-service
host_name example
service_description '''PING'''
check_command '''check_ping!100.0,20%!500.0,60%'''
}
define service{
use local-service
host_name example
service_description '''SSH'''
check_command '''check_ssh'''
}

:in this code:
::1) '''notification_period''' is defined in /etc/nagios/objects/timeperiods.cfg --> you can edit this file to add/set different time periods
::2) '''icon_image''' is situated in '''/usr/share/nagios/images/logos/'''. if you want to add new images you must save them in this place
::3) '''service_description''' is the service name displayed in the web interface
::4) '''check_command''' define the command desired and situated in '''/usr/lib/nagios/plugins'''

* File '''''servers/groups.cfg''''':

define hostgroup{
hostgroup_name example ; The name of the hostgroup
alias example @ MyLab ; Long name of the group
members localhost, '''example'''
}

You have to define the '''host_name''' used before in '''members''' variable.

After these changes, verify the configuration files through

# nagios -v /etc/nagios/nagios.cfg

and then, if there aren't any error, restart the service

# service nagios restart

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/nagios.log - Nagios log
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/nagios.conf - Nagios Apache folder files

===Insert the EPICS Nagios Plugins===

What you did in the chapters above was a generic Nagios installation/setup.

Going to [here http://www.lnl.infn.it/~epics/NAL/LNL/]. You will find the nagios plugin to EPICS _and_ a complete tra ball of a nagios configuration. Download the pkugin and save into the

''/usr/lib/nagios/plugins/''

Change the permission to check_caget.sh

root> ''chmod +x check_caget.sh
''

now verify that is usable with:

> ''./check_caget.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to broadcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

Download the epics.gif image available from the same [place http://www.lnl.infn.it/~epics/NAL/LNL/]

and install that:

root> ''mv epics,gif /usr/share/nagios/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same [place http://www.lnl.infn.it/~epics/NAL/LNL/]

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===SELinux setup===

For the first test: set it permissive by

root> ''system-config-securitylevel''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

NB. If you are using my etc.nagios.tar the passwd to login is "nagiosadmin"

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found [http://www.lnl.infn.it/~epics/joomla/nal.html here].
A special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use [http://www.lnl.infn.it/~epics/LivEPICS/Slackware/Slax6.0/ here] .

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 21:34, 30 Nov 2011

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2011-12-02T14:46:09Z

MauroGiacchini: /* Here's how to install NAL using yum on RHEL 5 x86 Linux box */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on RedHat Enterprise 5 x86 Linux box ==

===Nagios default installation===

Nagios application is provided by rpmforge repository, so you have to install it to configure yum properly.

root>'' wget http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

To install the package, you have to install DAG's GPG key:

root>'' rpm --import http://apt.sw.be/RPM-GPG-KEY.dag.txt ''

(Optional) Verify the package you have downloaded

root>'' rpm -K rpmforge-release-0.5.2-2.el5.rf.i386.rpm ''

'''NB''' (Security warning): The rpmforge-release package imports GPG keys into your RPM database. As long as you have verified the md5sum of the key injection package, and trust Dag, et al., then it should be as safe as your trust of them extends.

Install the package

root>'' rpm -i rpmforge-release-0.5.2-2.el5.rf.i386.rpm''

At this point it is possible to install the Nagios application. For the "server side", you need these following packages:
::1) '''nagios''': the main application package
::2) '''nagios-plugins''': provides all the command scripts used by users to define nagios services. In some cases there is also nagios-plugins-all (that's better)
::3) '''nagios-plugins-nrpe''': provides the check_nrpe script used to communicate with nagios clients and run remote services

root>'' yum install -y nagios''

root>'' yum install -y nagios-plugins''

root>'' yum install -y nagios-plugins-nrpe''

With that I've installed Nagios 3.2.3 version.

== Nagios: configuration ==

When you install Nagios by yum, all the apache configuration are done by default.

To check the web interface you must define the password for '''nagiosadmin''' user (default nagios administrator). This passsword must be encrypted. you can use '''htpasswd''' command to set that an save in

''/etc/nagios/htpasswd.users''

Start the apache and nagios services

root>'' service httpd start'' (restart)
root>'' service nagios start''

and check the nagios webpage at '''http://localhost.localdomain/nagios''' . If it is all correct, you have to see the authentication popup. When you are in the main page, you can monitor the localhost machine (nagios provides some information about hosts and services); all the services should be OK, but in some case you have to check some permissions/configurations.

The main configuration file is '''/etc/nagios/nagios.cfg'''

in this file you can configure every feature of nagios. We use most of the default options, the only parameters enabled are:

* enable servers directory: you can define all the servers' cfg files into this directory (cleaner job)

'''cfg_dir=/etc/nagios/servers'''

:and create the folder:

# mkdir /etc/nagios/servers

In the servers folder you have to define all the hosts you want to monitor. For a correct management, you have to define 2 different files:

* '''HOST.cfg''': define the specifics that nagios uses to monitor the host desired. You must define one file per host!
* '''groups.cfg''': indicate all the different groups of hosts. It is very useful to manage and monitor a large number of machines

Example:
* File '''''servers/example.cfg''''':

define host{
use linux-server
host_name '''example'''
alias '''example display in web interface'''
address '''10.6.0.1'''
notification_period '''24x7'''
icon_image '''example.jpg'''
}
define service{
use local-service
host_name example
service_description '''PING'''
check_command '''check_ping!100.0,20%!500.0,60%'''
}
define service{
use local-service
host_name example
service_description '''SSH'''
check_command '''check_ssh'''
}

:in this code:
::1) '''notification_period''' is defined in /etc/nagios/objects/timeperiods.cfg --> you can edit this file to add/set different time periods
::2) '''icon_image''' is situated in '''/usr/share/nagios/images/logos/'''. if you want to add new images you must save them in this place
::3) '''service_description''' is the service name displayed in the web interface
::4) '''check_command''' define the command desired and situated in '''/usr/lib/nagios/plugins'''

* File '''''servers/groups.cfg''''':

define hostgroup{
hostgroup_name example ; The name of the hostgroup
alias example @ MyLab ; Long name of the group
members localhost, '''example'''
}

You have to define the '''host_name''' used before in '''members''' variable.

After these changes, verify the configuration files through

# nagios -v /etc/nagios/nagios.cfg

and then, if there aren't any error, restart the service

# service nagios restart

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/nagios.log - Nagios log
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/nagios.conf - Nagios Apache folder files

===Insert the EPICS Nagios Plugins===

Going to [here http://www.lnl.infn.it/~epics/NAL/LNL/]. You will find the nagios plugin to EPICS _and_ a complete tra ball of a nagios configuration. Download the pkugin and save into the

''/usr/lib/nagios/plugins/''

Change the permission to check_caget.sh

root> ''chmod +x check_caget.sh
''

now verify that is usable with:

> ''./check_caget.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to broadcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

Download the epics.gif image available from the same [place http://www.lnl.infn.it/~epics/NAL/LNL/]

and install that:

root> ''mv epics,gif /usr/share/nagios/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same [place http://www.lnl.infn.it/~epics/NAL/LNL/]

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===SELinux setup===

For the first test: set it permissive by

root> ''system-config-securitylevel''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

NB. If you are using my etc.nagios.tar the passwd to login is "nagiosadmin"

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found [http://www.lnl.infn.it/~epics/joomla/nal.html here].
A special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use [http://www.lnl.infn.it/~epics/LivEPICS/Slackware/Slax6.0/ here] .

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 21:34, 30 Nov 2011

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2011-11-30T20:42:13Z

MauroGiacchini: /* Conclusions */ site link update

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===SELinux setup===

For the first test: set it permissive by

root> ''system-config-securitylevel''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

NB. If you are using my etc.nagios.tar the passwd to login is "nagiosadmin"

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found [http://www.lnl.infn.it/~epics/joomla/nal.html here].
A special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use [http://www.lnl.infn.it/~epics/LivEPICS/Slackware/Slax6.0/ here] .

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 21:34, 30 Nov 2011

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-24T10:28:44Z

MauroGiacchini: /* Conclusions */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===SELinux setup===

For the first test: set it permissive by

root> ''system-config-securitylevel''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

NB. If you are using my etc.nagios.tar the passwd to login is "nagiosadmin"

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 23 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-24T09:05:35Z

MauroGiacchini: /* NAGIOS as a Linux service */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===SELinux setup===

For the first test: set it permissive by

root> ''system-config-securitylevel''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

NB. If you are using my etc.nagios.tar the passwd to login is "nagiosadmin"

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-24T09:02:56Z

MauroGiacchini:

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===SELinux setup===

For the first test: set it permissive by

root> ''system-config-securitylevel''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-24T07:27:57Z

MauroGiacchini: /* See my nagios screen shots in action: */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

Nagios Status Map

[[Image:NagiosStatusMap.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

File:NagiosStatusMap.jpg

2007-11-24T07:26:26Z

MauroGiacchini: NagiosStatusMap

NagiosStatusMap

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-17T06:07:13Z

MauroGiacchini: /* Save the original Nagios setup and replace it */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements. You will find an epicsExample.cfg which contains a pre-setted PV names, please adjust that to meet the yours.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-17T06:04:13Z

MauroGiacchini: /* Insert the EPICS Nagios Plugins */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-17T06:03:39Z

MauroGiacchini: /* Insert the EPICS Nagios Plugins */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Note: After the version 1.3 the plugin assume the presence of caget into the /usr/bin if that is not true to your site please fix it making a symbolic link like (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-17T06:00:51Z

MauroGiacchini: /* The Plugin Script */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>

#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 17-11-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# CAGET LOCATION
# This option determines where the caget executable is located.
# The default /usr/bin/caget should be made with a symbolic link
# made by root (i.e.): ln -s /opt/epics/base-3.14.9/bin/linux-x86/caget /usr/bin/caget

CAGET_LOCATION=/usr/bin/caget

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.3"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget_dev_gw -pv <PV name> "
echo "Usage: check_caget_dev_gw -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget_dev_gw -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget_dev_gw -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget_dev_gw [-h] [--help]"
echo "Usage: check_caget_dev_gw [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the caget presence.

verify_caget_presence() {

if ! type $CAGET_LOCATION >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn? _or_ caget not found!)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

#CAGET_REPLY=`caget -a $PVNAME`
CAGET_REPLY=`$CAGET_LOCATION -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-16T15:42:21Z

MauroGiacchini:

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>
#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 25-08-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.2"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget -pv <PV name> "
echo "Usage: check_caget -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget [-h] [--help]"
echo "Usage: check_caget [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the EPICS_BASE variable, and caget presence.

verify_caget_presence() {

if ! type caget >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn?)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

CAGET_REPLY=`caget -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-16T14:39:18Z

MauroGiacchini: /* Now install the EPICS logos images */

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

download the epics.logo.images.tar available from the same place in http://www.nagiosexchange.org that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

and install that:

root> ''tar -xvf epics.logo.images.tar''
root> ''mv EPICSlogo* /usr/share/nagios/html/images/logos/''

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>
#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 25-08-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.2"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget -pv <PV name> "
echo "Usage: check_caget -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget [-h] [--help]"
echo "Usage: check_caget [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the EPICS_BASE variable, and caget presence.

verify_caget_presence() {

if ! type caget >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn?)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

CAGET_REPLY=`caget -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-16T14:23:11Z

MauroGiacchini:

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

Using the EPICS follows variables you should avoid to bradcast the network, for me the variblese were:

EPICS_CA_AUTO_ADDR_LIST=NO
EPICS_CA_ADDR_LIST=127.0.0.1

therefore may I test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 127.0.0.1''
> ''STATE_OK: giacchinHost:aiExample 5 2007-11-16 15:23:18.560231 ; te: 0 sec.''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

> ''cd /usr/share/nagios/html/images/logos''

download there the usr.share.nagios.html.images.logo.tar available at same place in nagiosexchange.org
that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>
#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 25-08-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.2"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget -pv <PV name> "
echo "Usage: check_caget -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget [-h] [--help]"
echo "Usage: check_caget [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the EPICS_BASE variable, and caget presence.

verify_caget_presence() {

if ! type caget >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn?)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

CAGET_REPLY=`caget -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-16T05:58:01Z

MauroGiacchini:

''This is a Wiki: Please add or correct things as you find them wrong, misleading or out-of date.''

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

if everything is good, now discover which is the IP number (for me it was 192.168.0.47) of your linux box by

root> ''ifconfig''

and test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 192.168.0.47''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

> ''cd /usr/share/nagios/html/images/logos''

download there the usr.share.nagios.html.images.logo.tar available at same place in nagiosexchange.org
that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself. There is a cool Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607 which give you the possibility to continuous monitoring the PVs during the regular usage of the browser.

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS version (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>
#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 25-08-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.2"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget -pv <PV name> "
echo "Usage: check_caget -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget [-h] [--help]"
echo "Usage: check_caget [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the EPICS_BASE variable, and caget presence.

verify_caget_presence() {

if ! type caget >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn?)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

CAGET_REPLY=`caget -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-16T05:48:55Z

MauroGiacchini:

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

if everything is good, now discover which is the IP number (for me it was 192.168.0.47) of your linux box by

root> ''ifconfig''

and test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 192.168.0.47''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

> ''cd /usr/share/nagios/html/images/logos''

download there the usr.share.nagios.html.images.logo.tar available at same place in nagiosexchange.org
that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself (i.e. a Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607).

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 06:40, 16 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>
#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 25-08-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.2"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget -pv <PV name> "
echo "Usage: check_caget -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget [-h] [--help]"
echo "Usage: check_caget [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the EPICS_BASE variable, and caget presence.

verify_caget_presence() {

if ! type caget >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn?)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

CAGET_REPLY=`caget -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-16T05:45:48Z

MauroGiacchini:

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

===Nagios default installation===

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recommended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

===Nagios Default Folder Locations===

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

===Insert the EPICS Nagios Plugins===

Going to http://www.nagiosexchange.org ; using the "search" button, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

if everything is good, now discover which is the IP number (for me it was 192.168.0.47) of your linux box by

root> ''ifconfig''

and test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 192.168.0.47''

if that reply correctly the status of your PV you can continue the installation.

===Now install the EPICS logos images===

> ''cd /usr/share/nagios/html/images/logos''

download there the usr.share.nagios.html.images.logo.tar available at same place in nagiosexchange.org
that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

===Save the original Nagios setup and replace it===

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

===NAGIOS check configuration file===

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

===HTTPD configuration===

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

===NAGIOS as a Linux service===

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favorite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

===See my nagios screen shots in action:===

Nagios Service Details

[[Image:NagiosServicesDetail.jpg]]

Nagios Alert Histogram

[[Image:NagiosAlertHistogram.jpg]]

----

== Conclusions ==

There are a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself (i.e. a Firefox plugin https://addons.mozilla.org/it/firefox/addon/3607).

At this time Ralph Lange has realized a test to NAL at Bessy. A great acknowledgments to him, he has supported me since the idea of use Nagios born in my mind.

More information about NAL could be found at : http://www.lnl.infn.it/~epics/NAL.html
You should find there a special LivEPICS (Linux Live CD EPICS fully equipped) with NAGIOS pre-setted and ready to use.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someone is interested to use it.

[mailto:Mauro.Giacchini_at_lnl.infn.it Mauro Giacchini (INFN-LNL)]

--[[User:MauroGiacchini|MauroGiacchini]] 00:40, 15 Nov 2007 (CST)

----

== The Plugin Script ==

<tt>/usr/lib/nagios/plugins/check_caget_dev_gw.sh</tt> script for Nagios

<pre>
#!/bin/sh
#
#####################################################################################
#####################################################################################
## Nagios plugin to check EPICS PV Status ##
#####################################################################################
#####################################################################################
#
# Script to retrieve EPICS PV Name status using the "caget" command.
# Written by Mauro Giacchini (mauro.giacchini@lnl.infn.it)
# Last Modified: 25-08-2007
#
# Usage: ./check_caget.sh -pv <PV name>
#
# Description:
# This script uses caget command to retrieve the PV status.
#
# Limitations:
# This script has been tested on Linux Fedora Core 6.
#
# Output:
# The output contains the "te" time elapsed calculated like a difference from PV's
# timestamp and the linux "date" command (suggestion: use ntp common server
# to IOCs and Nagios server box). The STATUS of the service (..of the PV)
# follow the severity rules:
#
# Severity (none) >>>> STATE_OK # OK = green
#
# Severity MINOR >>>> STATE_WARNING # WARNING = yellow
#
# Severity MAJOR >>>> STATE_CRITICAL # CRITICAL = red
#
# PV not found >>>> STATE_UNKNOWN # UNKNOWNN = orange
#
# In case of Severity (none) it show the stdout of "caget -a" with appended the "te".
#
# Other notes:
# Firefox Plugin : A FireFox extension is avilable to monitor Nagios server.
# https://addons.mozilla.org/it/firefox/addon/3607
#
# Nagios configuration setup:
# You need to add the command to commands.cfg
#
# define command{
# command_name check_caget
# command_line $USER1$/check_caget.sh -pv $ARG1$
# }
#
# And, you need to add the service to services.cfg
#
# define service{
# use generic-service ;
# host_name IOC_Example ;
# service_description aiExample ;
# is_volatile 0 ;
# check_period 24x7 ;
# max_check_attempts 3 ;
# normal_check_interval 3 ;
# retry_check_interval 1 ;
# contact_groups admins ;
# notification_interval 120 ;
# notification_period 24x7 ;
# notification_options w,u,c,r ;
# check_command check_caget!rootHost:aiExample ;
# }
#
# then place this script in the /usr/lib/nagios/plugins/ on the Nagios box server.
# Don't forget to set the right execution permission to this file.
#
# Threshold and ranges: please, have a look at:
# http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT
#
# Last: This script still needs debugging and fixups (exercise for reader) :-)
#
#####################################################################################
# DEBUGGING OPTION
# This option determines whether or not debugging messages are showed
# Values: 0=debugging off, 1=debugging on

DEBUG="0"

#####################################################################################
# Script exit status

STATE_OK=0 # OK = green

STATE_WARNING=1 # WARNING = yellow

STATE_CRITICAL=2 # CRITICAL = red

STATE_UNKNOWN=3 # UNKNOWNN = orange

VERSION="v1.2"

#####################################################################################
# print_revision() function

print_revision (){

echo "Check_caget (nagios-plugins 1.4 to nagios 2.9) (EPICS base 3.14.9) $VERSION"
}

#####################################################################################
# print_usage() function

print_usage() {

echo ""
echo "Usage: check_caget -pv <PV name> "
echo "Usage: check_caget -pv <PV name> -H <EPICS_CA_ADDR_LIST>"
echo "Usage: check_caget -pv <PV name> -p <EPICS_CA_SERVER_PORT>"
echo "Usage: check_caget -pv <PV name> -expval <EXPECTED VALUE>"
echo "Usage: check_caget [-h] [--help]"
echo "Usage: check_caget [-V]"
echo ""
}

#####################################################################################
# print_help() function

print_help() {
echo ""
print_usage
echo ""
echo "Script to retrieve the PV status for EPICS control systems."
echo ""
echo "This plugin not developped by the Nagios Plugin group."
echo "Please do not e-mail them for support on this plugin, since"
echo "they won't know what you're talking about :P"
echo ""
echo "For contact info: mauro.giacchini@lnl.infn.it"
echo "Download : http://www.lnl.infn.it/~epics/"
echo ""
}

#####################################################################################
# Check the EPICS_BASE variable, and caget presence.

verify_caget_presence() {

if ! type caget >/dev/null 2>&1; then

echo "STATUS CRITICAL: caget not found (Did you set up the rigth one Nagios USERn?)"
exit $STATE_CRITICAL
fi
}

#####################################################################################
# Control caget plugin input parameters

EXPVAL=""
EPICS_CA_ADDR_LIST="" # Default YES
EPICS_CA_SERVER_PORT="" # Default 5064 _and_ value > 5000
EPICS_CA_SERVER_PORT_MIN="5000"

while test -n "$1"; do

case "$1" in

--help)
print_help
exit $STATE_OK
;;

-h)
print_help
exit $STATE_OK
;;

-V)
print_revision
exit $STATE_OK
;;

-pv)
PVNAME=$2
shift
;;

-expval)
EXPVAL=$2
if [ -z $EXPVAL ]; then
echo "STATUS CRITICAL: Expected value absent"
exit $STATE_CRITICAL
fi
shift
;;

-H)
EPICS_CA_ADDR_LIST=$2
if [ -z $EPICS_CA_ADDR_LIST ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_ADDR_LIST absent"
exit $STATE_CRITICAL
fi
export EPICS_CA_ADDR_LIST
EPICS_CA_AUTO_ADDR_LIST="NO"
export EPICS_CA_AUTO_ADDR_LIST
shift
;;

-p)
EPICS_CA_SERVER_PORT=$2
if [ -z $EPICS_CA_SERVER_PORT ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT absent"
exit $STATE_CRITICAL
fi
if [ $EPICS_CA_SERVER_PORT -le $EPICS_CA_SERVER_PORT_MIN ]; then
echo "STATUS CRITICAL: Expected EPICS_CA_SERVER_PORT minor than allowed (5001)"
exit $STATE_CRITICAL
fi
export EPICS_CA_SERVER_PORT
shift
;;

*)
echo ""
echo "Unknow argument: $1"
print_usage
exit $STATE_UNKNOWN
;;

esac
shift
done

verify_caget_presence

if [ -z $PVNAME ]; then

echo "STATUS CRITICAL: PV Name not specified"
exit $STATE_CRITICAL
fi

#####################################################################################
# FINALLY... RETRIEVING THE VALUES (caget)

CAGET_REPLY=`caget -a $PVNAME`

IFS=" "
read pvname date time value status severity<<END
$CAGET_REPLY
END

if [ -z $pvname ]; then

echo "STATE_UNKNOWN: $PVNAME not found"
exit $STATE_UNKNOWN
fi

#####################################################################################
# Calculus difference between the PV timestamp and the actual time

SPACE=" "
dte1=$(date --date "$date$SPACE$time" +%s)
dte2=$(date +%s)
diffSec=$((dte2-dte1))
if ((diffSec < 0)); then abs=-1; else abs=1; fi
te=$((diffSec/abs))
# echo "Time elapsed (sec.): $te"

#####################################################################################
# Output the NAGIOS status using an expected value

if [ $EXPVAL ]; then

if [[ $value -eq $EXPVAL ]] ;
then echo "STATE_OK: Expected value ($EXPVAL) to $pvname match; te: $te sec."
exit $STATE_OK;
else echo "STATUS CRITICAL: Expected value ($EXPVAL) to $pvname didn't match"
exit $STATE_CRITICAL;
fi
fi

#####################################################################################
# Output the NAGIOS status using the Severity field
case $severity in

MAJOR)
echo "STATUS CRITICAL: $pvname in MAJOR severity status; te: $te sec."
exit $STATE_CRITICAL
;;

MINOR)
echo "STATE_WARNING: $pvname in MINOR severity status; te: $te sec."
exit $STATE_WARNING
;;

*)
echo "STATE_OK: $pvname $value $date $time $status ; te: $te sec."
exit $STATE_OK
;;
esac

</pre>

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-15T07:18:01Z

MauroGiacchini:

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-15T07:16:53Z

MauroGiacchini:

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-15T06:53:12Z

MauroGiacchini:

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

'''Nagios default installation'''

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last
stable version (the 3.0 is under development).

Optional, but recomended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

'''Nagios Default Folder Locations'''

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

'''Insert the EPICS Nagios Plugins'''

Going to http://www.nagiosexchange.org ; using the "search" botton, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

if everithings is good, now discover which is the IP number (for me it was 192.168.0.47) of your linux box by

root> ''ifconfig''

and test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 192.168.0.47''

if that reply correctly the status of your PV you can continue the installation.

'''Now install the EPICS logos images'''

> ''cd /usr/share/nagios/html/images/logos''

download there the usr.share.nagios.html.images.logo.tar availabe at same place in nagiosexchange.org
that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

'''Save the original Nagios setup and replace it'''

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

'''NAGIOS check configuration file'''

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''

The above command would show you for any erroneous lines frin Nagios config file.

'''HTTPD configuration'''

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into
/usr/lib/nagios/cgi-bin/
and
/usr/share/nagios/html/

which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

'''NAGIOS as a Linux service'''

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favourite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

'''See my nagios screenshots in action:'''

NagiosServiceDetails

[[Image:NagiosServicesDetail.jpg]]

NagiosAlertHistogram

[[Image:NagiosAlertHistogram.jpg]]

----

Theare a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself.

At this time Ralph Lange has realized a test to NAL at Bessy. A great aknowlegment to him, he has supported me since the idea of use Nagios born in my mind.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someome is interested to use it.

--[[User:MauroGiacchini|MauroGiacchini]] 00:40, 15 Nov 2007 (CST)

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-15T06:50:32Z

MauroGiacchini:

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

'''Nagios default installation'''

The default nagios installation can be done by doing like so

root>'' yum -y install nagios''

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last stable version (the 3.0 is under development).

Optional, but recomended if you have enough disk space: install more Nagios plugins and addons.

root> ''yum -y install nagios-plugins nagios-plugins-all
''

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

'''Nagios Default Folder Locations'''

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

'''Insert the EPICS Nagios Plugins'''

Going to http://www.nagiosexchange.org ; using the "search" botton, look to "epics". You will find a project named "Nagios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

root> ''chmod +x check_caget_dev_gw.sh
''

now verify that is usable with:

> ''./check_caget_dev_gw.sh --help''

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> ''camonitor giacchinHost:aiExample
''

if everithings is good, now discover which is the IP number (for me it was 192.168.0.47) of your linux box by

root> ''ifconfig''

and test the plugin with the follow command:

> ''./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 192.168.0.47''

if that reply correctly the status of your PV you can continue the installation.

'''Now install the EPICS logos images'''

> ''cd /usr/share/nagios/html/images/logos''

download there the usr.share.nagios.html.images.logo.tar availabe at same place in nagiosexchange.org
that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

'''Save the original Nagios setup and replace it'''

Go to /etc folder and save the original setup

root> ''tar cvf nagios.or.tar ./nagios/''

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

root> ''tar xvf ./etc.nagios.tar''

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

'''NAGIOS check configuration file'''

For sanity checking, make sure you verify Nagios config files. This can be done like so

root> ''nagios -v /etc/nagios/nagios.cfg
''
The above command would show you for any erroneous lines frin Nagios config file.

'''HTTPD configuration'''

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into /usr/lib/nagios/cgi-bin/ and /usr/share/nagios/html/
which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

root> ''htpasswd -c /etc/nagios/passwd nagiosadmin
''

'''NAGIOS as a Linux service'''

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

root> ''service httpd restart''
root> ''service Nagios stop''
root> ''service Nagios start''
root> ''service Nagios status''

Open your favourite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

'''See my nagios screenshots in action:'''

NagiosServiceDetails

[[Image:NagiosServicesDetail.jpg]]

NagiosAlertHistogram

[[Image:NagiosAlertHistogram.jpg]]

----

Theare a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself.

At this time Ralph Lange has realized a test to NAL at Bessy. A great aknowlegment to him, he has supported me since the idea of use Nagios born in my mind.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someome is interested to use it.

--[[User:MauroGiacchini|MauroGiacchini]] 00:40, 15 Nov 2007 (CST)

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-15T06:40:58Z

MauroGiacchini:

== Here's how to install NAL using yum on Fedora Core 7 Linux box ==

'''Nagios default installation'''

The default nagios installation can be done by doing like so

# yum -y install nagios

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last stable version (the 3.0 is under development).

Optional, but recomended if you have enough disk space: install more Nagios plugins and addons.
# yum -y install nagios-plugins nagios-plugins-all

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

'''Nagios Default Folder Locations'''

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

'''Insert the EPICS Nagios Plugins'''

Going to http://www.nagiosexchange.org ; using the "search" botton, look to "epics". You will find a project named "NAgios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

> chmod +x check_caget_dev_gw.sh

now verify that is usable with:

> ./check_caget_dev_gw.sh --help

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> camonitor giacchinHost:aiExample

if everithings is good, now discover which is the IP number (for me it was 192.168.0.47) of your linux box by

#ifconfig

and test the plugin with the follow command:

> ./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 192.168.0.47

if that reply correctly the status of your PV you can continue the installation.

'''Now install the EPICS logos images'''

# cd /usr/share/nagios/html/images/logos

download there the usr.share.nagios.html.images.logo.tar availabe at same place in nagiosexchange.org
that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

'''Save the original Nagios setup and replace it'''

Go to /etc folder and save the original setup

# tar cvf nagios.or.tar ./nagios/

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

# tar xvf ./etc.nagios.tar

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

'''NAGIOS check configuration file'''

For sanity checking, make sure you verify Nagios config files. This can be done like so

# nagios -v /etc/nagios/nagios.cfg

The above command would show you for any erroneous lines frin Nagios config file.

'''HTTPD configuration'''

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into /usr/lib/nagios/cgi-bin/ and /usr/share/nagios/html/
which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

#htpasswd -c /etc/nagios/passwd nagiosadmin

'''NAGIOS as a Linux service'''

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

# service httpd restart
# service Nagios stop
# service Nagios start
# service Nagios status

Open your favourite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

See my nagios screenshots in action:

NagiosServiceDetails

[[Image:NagiosServicesDetail.jpg]]

NagiosAlertHistogram

[[Image:NagiosAlertHistogram.jpg]]

Theare a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself.

At this time Ralph Lange has realized a test to NAL at Bessy. A great aknowlegment to him, he has supported me since the idea of use Nagios born in my mind.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someome is interested to use it.

--[[User:MauroGiacchini|MauroGiacchini]] 00:40, 15 Nov 2007 (CST)

File:NagiosServicesDetail.jpg

2007-11-15T06:37:08Z

MauroGiacchini: NagiosServiceDetails

NagiosServiceDetails

File:NagiosAlertHistogram.jpg

2007-11-15T06:31:54Z

MauroGiacchini: NagiosAlertHistogram

NagiosAlertHistogram

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-15T06:23:31Z

MauroGiacchini:

(HOWTO install and setup NAL on Fedora Core 7)

Here's how to install NAL using yum

NAGIOS INSTALLATION
'''Nagios default installation'''

The default nagios installation can be done by doing like so

# yum -y install nagios

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last stable version (the 3.0 is under development).

Optional, but recomended if you have enough disk space: install more Nagios plugins and addons.
# yum -y install nagios-plugins nagios-plugins-all

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

'''Nagios Default Folder Locations'''

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

'''Insert the EPICS Nagios Plugins'''

Going to www.nagiosexchange.org ; using the "search" botton, look to "epics". You will find a project named "NAgios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

> chmod +x check_caget_dev_gw.sh

now verify that is usable with:

> ./check_caget_dev_gw.sh --help

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> camonitor giacchinHost:aiExample

if everithings is good, now discover which is the IP number (for me it was 192.168.0.47) of your linux box by

#ifconfig

and test the plugin with the follow command:

> ./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 192.168.0.47

if that reply correctly the status of your PV you can continue the installation.

'''Now install the EPICS logos images'''

# cd /usr/share/nagios/html/images/logos

download there the usr.share.nagios.html.images.logo.tar availabe at same place in nagiosexchange.org
that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

'''Save the original Nagios setup and replace it'''

Go to /etc folder and save the original setup

# tar cvf nagios.or.tar ./nagios/

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

# tar xvf ./etc.nagios.tar

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

'''NAGIOS check configuration file'''

For sanity checking, make sure you verify Nagios config files. This can be done like so

# nagios -v /etc/nagios/nagios.cfg

The above command would show you for any erroneous lines frin Nagios config file.

'''HTTPD configuration'''

====================

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into /usr/lib/nagios/cgi-bin/ and /usr/share/nagios/html/
which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

#htpasswd -c /etc/nagios/passwd nagiosadmin

NAGIOS as a Linux service
==========================

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

# service httpd restart
# service Nagios stop
# service Nagios start
# service Nagios status

Open your favourite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

See my nagios screenshots in action:

NagiosServiceDetails

NagiosAlertHistogram

Theare a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself.

At this time Ralph Lange has realized a test to NAL at Bessy. A great aknowlegment to him, he has supported me since the idea of use Nagios born in my mind.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someome is interested to use it.

Mauro.

How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network

2007-11-15T06:19:04Z

MauroGiacchini:

(HOWTO install and setup NAL on Fedora Core 7)

Here's how to install NAL using yum

NAGIOS INSTALLATION
====================

The default nagios installation can be done by doing like so

# yum -y install nagios

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last stable version (the 3.0 is under development).

Optional, but recomended if you have enough disk space: install more Nagios plugins and addons.

# yum -y install nagios-plugins nagios-plugins-all

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

Nagios Default Folder Locations
================================

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

Insert the EPICS Nagios Plugins
================================

Going to www.nagiosexchange.org ; using the "search" botton, look to "epics". You will find a project named "NAgios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

> chmod +x check_caget_dev_gw.sh

now verify that is usable with:

> ./check_caget_dev_gw.sh --help

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> camonitor giacchinHost:aiExample

if everithings is good, now discover which is the IP number (for me it was 192.168.0.47) of your linux box by

#ifconfig

and test the plugin with the follow command:

> ./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 192.168.0.47

if that reply correctly the status of your PV you can continue the installation.

Now install the EPICS logos images
===================================

# cd /usr/share/nagios/html/images/logos

download there the usr.share.nagios.html.images.logo.tar availabe at same place in nagiosexchange.org
that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

Save the original Nagios setup and replace it
==============================================

Go to /etc folder and save the original setup

# tar cvf nagios.or.tar ./nagios/

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

# tar xvf ./etc.nagios.tar

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

NAGIOS check configuration file
================================

For sanity checking, make sure you verify Nagios config files. This can be done like so

# nagios -v /etc/nagios/nagios.cfg

The above command would show you for any erroneous lines frin Nagios config file.

HTTPD configuration
====================

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into /usr/lib/nagios/cgi-bin/ and /usr/share/nagios/html/
which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

#htpasswd -c /etc/nagios/passwd nagiosadmin

NAGIOS as a Linux service
==========================

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

# service httpd restart
# service Nagios stop
# service Nagios start
# service Nagios status

Open your favourite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

See my nagios screenshots in action:

NagiosServiceDetails

NagiosAlertHistogram

Theare a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself.

At this time Ralph Lange has realized a test to NAL at Bessy. A great aknowlegment to him, he has supported me since the idea of use Nagios born in my mind.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someome is interested to use it.

Mauro.

HowTo Documents

2007-11-15T05:58:54Z

MauroGiacchini: /* Infrastructure and Other Stuff */

This is a directory of various How-To documents written by members of the EPICS collaboration. Contributions to this page are most welcome!

=== EPICS Base on Different Architectures and Operating Systems ===

* [http://www.aps.anl.gov/epics/base/RTEMS/tutorial/ Getting Started with EPICS on RTEMS]
* [[HowToPC104|Getting Started with R3.14.7 on a PC104 running Linux]]
* [[How To Port EPICS to a new OS/Architecture]]

=== Drivers and Device Support ===

* [http://www.aps.anl.gov/epics/modules/soft/asyn/R4-8/tutorial.html How To Do Serial (using Asyn Driver)]
* [http://www.aps.anl.gov/epics/modules/soft/asyn/BeginnerGuideToASYN-VXI11.pdf Beginners Guide to using VXI-11 (with Asyn Driver)]
* [[How to make your EPICS driver operating system independent]]
* [[How To Write Device Support that uses Asyn Driver]] ''(Incomplete!)''

=== Applications ===

* [[How To Install Channel Archiver On Scientific Linux]]
* [[What PV Save and Restore Tools are available]]

=== Infrastructure and Other Stuff ===

* [[How To Set Up a Linux Box as an IOC Boot Server]]
* [[How To Set Up a Mirror of the EPICS Web Site]]
* [[How to Set Up a Soft IOC Framework on Linux]]
* [[How to Set Up Console Access and Logging for VME and Soft IOCs]]
* [[How to Set Up NAL (Nagios Alarm Handler) to monitor an EPICS network]]

How to Set Up Nagios to monitor an EPICS network

2007-11-15T05:57:25Z

MauroGiacchini:

HOWTO install and setup NAL (Nagios Alarm Handler) on Fedora Core 7

Here's how to install NAL using yum

NAGIOS INSTALLATION
===================

The default nagios installation can be done by doing like so

# yum -y install nagios

With that I've installed nagios.i386 0:2.9-1.fc7 version; this is the last stable version (the 3.0 is under development).

Optional, but recomended if you have enough disk space: install more Nagios plugins and addons.

# yum -y install nagios-plugins nagios-plugins-all

That is not necessary but should be useful if you use NAL like a regular NAGIOS server more than only NAL (to monitor EPICS PVs network).

Nagios Default Folder Locations
================================

By default Nagios yum installation, Nagios stores the following file location into your harddisk

* /etc/nagios/ - Nagios configuration folder locations
* /var/log/nagios/ - Nagios log and messages folder locations
* /usr/share/nagios/ - Nagios, docs, sounds, and image folder locations
* /usr/lib/nagios/cgi-bin/ - Nagios CGI folder location
* /usr/bin - Nagios binaries
* /etc/httpd/conf.d/ - Nagios Apache folder files
* /etc/logrotate.d/nagios/ - Nagios log rotation file

Insert the EPICS Nagios Plugins
==========================

Going to www.nagiosexchange.org ; using the "search" botton, look to "epics". You will find a project named "NAgios plugins for EPICS". Scroll down that page, click over "check_caget_dev_gw.sh". Download it and save into the
/usr/lib/nagios/plugins/
Change the permission to check_caget_dev_gw.sh

> chmod +x check_caget_dev_gw.sh

now verify that is usable with:

> ./check_caget_dev_gw.sh --help

verfing using camonitor a PV, ie for me giacchinHost:aiExample

> camonitor giacchinHost:aiExample

if everithings is good, now discover which is the IP number (for me it was 192.168.0.47) of your linux box by

#ifconfig

and test the plugin with the follow command:

> ./check_caget_dev_gw.sh -pv giacchinHost:aiExample -H 192.168.0.47

if that reply correctly the status of your PV you can continue the installation.

Now install the EPICS logos images.
==========================

# cd /usr/share/nagios/html/images/logos

download there the usr.share.nagios.html.images.logo.tar availabe at same place in nagiosexchange.org
that contains : EPICSlogo.gd2 EPICSlogo.gif EPICSlogoSmall.gif

Save the original Nagios setup and replace it.
==========================

Go to /etc folder and save the original setup

# tar cvf nagios.or.tar ./nagios/

download there the etc.nagios.tar available at same place at nagiosexchange.org

and restore the nagios folder with that:

# tar xvf ./etc.nagios.tar

Note: Now looking around the files into /etc/nagios and adjust that to meet your network setup requirements.

NAGIOS CONFIG VERIFICATION
==========================

For sanity checking, make sure you verify Nagios config files. This can be done like so

# nagios -v /etc/nagios/nagios.cfg

The above command would show you for any erroneous lines frin Nagios config file.

HTTPD configuration
==========================

Check the presence of line: "include conf.d/*.conf"
in /etc/httpd/conf/httpd.conf

Check the paths into the file : /etc/httpd/conf.d/nagios.conf

Make a file named .htaccess into /usr/lib/nagios/cgi-bin/ and /usr/share/nagios/html/
which will contains:

AuthName "Nagios Access"
AuthType Basic
AuthUserFile /etc/nagios/passwd
require valid-user

Now create a nagios user with the following command:

#htpasswd -c /etc/nagios/passwd nagiosadmin

NAGIOS LINUX SERVICE
==========================

Basically, at this point of basic Nagios configuration, restarting Nagios should be successful.

Reload your apache service together with your Nagios service like so

# service httpd restart
# service Nagios stop
# service Nagios start
# service Nagios status

Open your favourite web-browser on http://localhost/nagios/

login like "nagiosadmin", give your password and enjoy!

See my nagios screenshots in action:

NagiosServiceDetails

NagiosAlertHistogram

Theare a lot of other interesting feature that comes from free using NAGIOS, looking around you should find a lot yourself.

At this time Ralph Lange has realized a test to NAL at Bessy. A great aknowlegment to him, he has supported me since the idea of use Nagios born in my mind.

Thank you for your attention!
Please, give me a your feedback, and fell free to drop me an email, I'll be happy to continue to work on this idea if someome is interested to use it.

Mauro.

HowTo Documents

2007-11-15T05:56:08Z

MauroGiacchini: /* Infrastructure and Other Stuff */

HowToPC104

2005-04-13T06:20:34Z

MauroGiacchini:

'''''This is an internal note of my lab (INFN-LNL ITALY) showing results of my first experience with running EPICS on an embedded PC104 to control a Camac Crate Controller by Serial-over-Ethernet and a Rockwell Micrologix 1500 PLC by serial line. Both Devices Support was written using Asyn in collaboration with Ralph Lange.'''''

= 1 Building R3.14.7 Base on a Linux Box =
# The following was performed on a workstation type Slackware 7.0 linux box (equipped with an old PentiumIII, 500Mhz, 512MB RAM). I ran into a sync problem on HD using the “BigSlack” distro, so I created the ISO image of version 7.0 and installed it using a CD-ROM.
# Download baseR3.14.7.tar.gz from http://www.aps.anl.gov/epics/base/R3-14/7.php
# Create a working directory: /usr/src/R3.14.7
# cd /usr/src/R3.14.7
# tar -zxvf baseR3.14.7.tar.gz
# cd base
# Edit configure/CONFIG_SITE, look for the following variables and change them to what is shown below:
#* CROSS_COMPILER_TARGET_ARCHS=
#* STATIC_BUILD=YES
# Edit startup/Site.cshrc or define EPICS_BASE in your shell:
#* setenv EPICS_BASE /usr/src/R3.14.7/base
# Source startup/Site.cshrc (or restart your shell)
# Type ``make'' in /usr/src/R3.14.7/base and go brew a pot of coffee.
# Check for binaries in bin/linux-x86

= 2 Building the Example Application =
# cd /home/giacchin/ (or wherever you want to build the example)
# mkdir testIOC
# cd testIOC
# $EPICS_BASE/bin/linux-x86/makeBaseApp.pl -i example
# $EPICS_BASE/bin/linux-x86/makeBaseApp.pl -i -t example example
# make
# cd ../iocBoot/iocexample
# Start your IOC with ../../exampleApp/src/O.linux-x86/example st.cmd
# List the existing records using dbl

At this point you will be in the “iocSh” (aka ioc shell). You can use the CA commandline tools from base to access your IOC through Channel Access: “caget yourHost:aiExample1” (in the same net or after you point EPICS_CA_ADDR_LIST to your linux box). The values of that example record should change between 0 and 9.

= 3 Migrating exampleApp Code to your PC104 =
Once you've established working binaries on your linux box, it's time to move them to the PC104 card. I try to mimic the directory structure of the linux host on the PC104 card, so that you do not have to modify anything. The IOC boot structure should be portable without any changes, though.
# Log onto the pc104
# Create /home/giacchin (or wherever you want to put stuff) and the directory structure:
## mkdir /home/giacchin; cd /home/giacchin/
## mkdir testIOC; cd testIOC
## mkdir bin dbd db iocBoot iocBoot/iocexample
# Back on the host: cd /home/giacchin/testIOC/iocBoot/iocexample
# ftp from your linux box to your pc104
# cd /home/giacchin/testIOC/iocBoot/iocexample; lcd <same directory>
# put st.cmd
# cd /home/giacchin/testIOC/db; lcd <same directory>
# put dbExample1.db dbExample2.db dbsubExample.db
# cd /home/giacchin/testIOC/dbd ; lcd <same directory>
# put example.dbd
# cd /home/giacchin/testIOC/bin/linux-x86
# put caRepeater example

I used the TMZ104 (a PC104 starter kit made by [http://www.tri-m.com TRI-M ENGINEERING]). The Linux environment of the starter kit isn't equipped with all the libs necessary to use the caRepeater, therefore I copied the libraries from my host PC (with Slackware7.0) to the PC104 into the same directory. The missing libs were:
* libpthread
* libstdc++-libc6.1
* libreadline.so

Now we are ready to start our application on the PC104
# Log onto the pc104 card
# cd /home/giacchin/testIOC/bin/limux-x86
# chmod +x caRepeater example
# cd /home/giacchin/testIOC/iocBoot/iocexample
# Start the caRepeater: ../../bin/linux-x86/caRepeater &
# Start the example: ../../bin/linux-x86/example st.cmd

At this point you can access your PC104 through Channel Access from your host or another unix machine with EPICS: camonitor giacchinHost:dbExample1 
(Don't forget to set EPICS_CA_ADDR_LIST to the PC104 IP address if you're on a different subnet.)

-- [mailto:mauro.giacchini@lnl.infn.it Mauro Giacchini (INFN-LNL)]
7:35, 13 Apr 2005 (CDT)

''Credits: This document was derived from the original version done by Arne Freyberger (JLAB), sent to me by Stephen Wood (JLAB). Thanks a lot to both of you and to Ralph Lange (BESSY) and Glen Write (CLS) for additional help.''

HowToPC104

2005-04-13T06:15:31Z

MauroGiacchini:

'''''This is an internal note of my lab (INFN-LNL ITALY) showing results of my first experience with running EPICS on an embedded PC104 to control a Camac Crate Controller by Serial-over-Ethernet and a Rockwell Micrologix 1500 PLC by serial line. P.S. Both new Devices Support was written using Asyn by M.Kraimer'''''

= 1 Building R3.14.7 Base on a Linux Box =
# The following was performed on a workstation type Slackware 7.0 linux box (equipped with an old PentiumIII, 500Mhz, 512MB RAM). I ran into a sync problem on HD using the “BigSlack” distro, so I created the ISO image of version 7.0 and installed it using a CD-ROM.
# Download baseR3.14.7.tar.gz from http://www.aps.anl.gov/epics/base/R3-14/7.php
# Create a working directory: /usr/src/R3.14.7
# cd /usr/src/R3.14.7
# tar -zxvf baseR3.14.7.tar.gz
# cd base
# Edit configure/CONFIG_SITE, look for the following variables and change them to what is shown below:
#* CROSS_COMPILER_TARGET_ARCHS=
#* STATIC_BUILD=YES
# Edit startup/Site.cshrc or define EPICS_BASE in your shell:
#* setenv EPICS_BASE /usr/src/R3.14.7/base
# Source startup/Site.cshrc (or restart your shell)
# Type ``make'' in /usr/src/R3.14.7/base and go brew a pot of coffee.
# Check for binaries in bin/linux-x86

= 2 Building the Example Application =
# cd /home/giacchin/ (or wherever you want to build the example)
# mkdir testIOC
# cd testIOC
# $EPICS_BASE/bin/linux-x86/makeBaseApp.pl -i example
# $EPICS_BASE/bin/linux-x86/makeBaseApp.pl -i -t example example
# make
# cd ../iocBoot/iocexample
# Start your IOC with ../../exampleApp/src/O.linux-x86/example st.cmd
# List the existing records using dbl

At this point you will be in the “iocSh” (aka ioc shell). You can use the CA commandline tools from base to access your IOC through Channel Access: “caget yourHost:aiExample1” (in the same net or after you point EPICS_CA_ADDR_LIST to your linux box). The values of that example record should change between 0 and 9.

= 3 Migrating exampleApp Code to your PC104 =
Once you've established working binaries on your linux box, it's time to move them to the PC104 card. I try to mimic the directory structure of the linux host on the PC104 card, so that you do not have to modify anything. The IOC boot structure should be portable without any changes, though.
# Log onto the pc104
# Create /home/giacchin (or wherever you want to put stuff) and the directory structure:
## mkdir /home/giacchin; cd /home/giacchin/
## mkdir testIOC; cd testIOC
## mkdir bin dbd db iocBoot iocBoot/iocexample
# Back on the host: cd /home/giacchin/testIOC/iocBoot/iocexample
# ftp from your linux box to your pc104
# cd /home/giacchin/testIOC/iocBoot/iocexample; lcd <same directory>
# put st.cmd
# cd /home/giacchin/testIOC/db; lcd <same directory>
# put dbExample1.db dbExample2.db dbsubExample.db
# cd /home/giacchin/testIOC/dbd ; lcd <same directory>
# put example.dbd
# cd /home/giacchin/testIOC/bin/linux-x86
# put caRepeater example

I used the TMZ104 (a PC104 starter kit made by [http://www.tri-m.com TRI-M ENGINEERING]). The Linux environment of the starter kit isn't equipped with all the libs necessary to use the caRepeater, therefore I copied the libraries from my host PC (with Slackware7.0) to the PC104 into the same directory. The missing libs were:
* libpthread
* libstdc++-libc6.1
* libreadline.so

Now we are ready to start our application on the PC104
# Log onto the pc104 card
# cd /home/giacchin/testIOC/bin/limux-x86
# chmod +x caRepeater example
# cd /home/giacchin/testIOC/iocBoot/iocexample
# Start the caRepeater: ../../bin/linux-x86/caRepeater &
# Start the example: ../../bin/linux-x86/example st.cmd

At this point you can access your PC104 through Channel Access from your host or another unix machine with EPICS: camonitor giacchinHost:dbExample1 
(Don't forget to set EPICS_CA_ADDR_LIST to the PC104 IP address if you're on a different subnet.)

-- [mailto:mauro.giacchini@lnl.infn.it Mauro Giacchini (INFN-LNL)]
7:35, 13 Apr 2005 (CDT)

''Credits: This document was derived from the original version done by Arne Freyberger (JLAB), sent to me by Stephen Wood (JLAB). Thanks a lot to both of you and to Ralph Lange (BESSY) and Glen Write (CLS) for additional help.''

HowToPC104

2005-04-13T06:14:16Z

MauroGiacchini:

'''''This is an internal note of my lab (INFN-LNL ITALY) showing results of my first experience with running EPICS on an embedded PC104 to control a Camac Crate Controller by Serial-over-Ethernet and a Rockwell Micrologix 1500 PLC by serial line. P.S. Both new Devices Support was written using Asyn by M.Kraimer'''''

= 1 Building R3.14.7 Base on a Linux Box =
# The following was performed on a workstation type Slackware 7.0 linux box (equipped with an old PentiumIII, 500Mhz, 512MB RAM). I ran into a sync problem on HD using the “BigSlack” distro, so I created the ISO image of version 7.0 and installed it using a CD-ROM.
# Download baseR3.14.7.tar.gz from http://www.aps.anl.gov/epics/base/R3-14/7.php
# Create a working directory: /usr/src/R3.14.7
# cd /usr/src/R3.14.7
# tar -zxvf baseR3.14.7.tar.gz
# cd base
# Edit configure/CONFIG_SITE, look for the following variables and change them to what is shown below:
#* CROSS_COMPILER_TARGET_ARCHS=
#* STATIC_BUILD=YES
# Edit startup/Site.cshrc or define EPICS_BASE in your shell:
#* setenv EPICS_BASE /usr/src/R3.14.7/base
# Source startup/Site.cshrc (or restart your shell)
# Type ``make'' in /usr/src/R3.14.7/base and go brew a pot of coffee.
# Check for binaries in bin/linux-x86

= 2 Building the Example Application =
# cd /home/giacchin/ (or wherever you want to build the example)
# mkdir testIOC
# cd testIOC
# $EPICS_BASE/bin/linux-x86/makeBaseApp.pl -i example
# $EPICS_BASE/bin/linux-x86/makeBaseApp.pl -i -t example example
# make
# cd ../iocBoot/iocexample
# Start your IOC with ../../exampleApp/src/O.linux-x86/example st.cmd
# List the existing records using dbl

At this point you will be in the “iocSh” (aka ioc shell). You can use the CA commandline tools from base to access your IOC through Channel Access: “caget yourHost:aiExample1” (in the same net or after you point EPICS_CA_ADDR_LIST to your linux box). The values of that example record should change between 0 and 9.

= 3 Migrating exampleApp Code to your PC104 =
Once you've established working binaries on your linux box, it's time to move them to the PC104 card. I try to mimic the directory structure of the linux host on the PC104 card, so that you do not have to modify anything. The IOC boot structure should be portable without any changes, though.
# Log onto the pc104
# Create /home/giacchin (or wherever you want to put stuff) and the directory structure:
## mkdir /home/giacchin; cd /home/giacchin/
## mkdir testIOC; cd testIOC
## mkdir bin dbd db iocBoot iocBoot/iocexample
# Back on the host: cd /home/giacchin/testIOC/iocBoot/iocexample
# ftp from your linux box to your pc104
# cd /home/giacchin/testIOC/iocBoot/iocexample; lcd <same directory>
# put st.cmd
# cd /home/giacchin/testIOC/db; lcd <same directory>
# put dbExample1.db dbExample2.db dbsubExample.db
# cd /home/giacchin/testIOC/dbd ; lcd <same directory>
# put example.dbd
# cd /home/giacchin/testIOC/bin/linux-x86
# put caRepeater example

I used the TMZ104 (a PC104 starter kit made by [http://www.tri-m.com TRI-M ENGINEERING]). The Linux environment of the starter kit isn't equipped with all the libs necessary to use the caRepeater, therefore I copied the libraries from my host PC (with Slackware7.0) to the PC104 into the same directory. The missing libs were:
* libpthread
* libstdc++-libc6.1
* libreadline.so

Now we are ready to start our application on the PC104
# Log onto the pc104 card
# cd /home/giacchin/testIOC/bin/limux-x86
# chmod +x caRepeater example
# cd /home/giacchin/testIOC/iocBoot/iocexample
# Start the caRepeater: ../../bin/linux-x86/caRepeater &
# Start the example: ../../bin/linux-x86/example st.cmd

At this point you can access your PC104 through Channel Access from your host or another unix machine with EPICS: camonitor giacchinHost:dbExample1 
(Don't forget to set EPICS_CA_ADDR_LIST to the PC104 IP address if you're on a different subnet.)

-- [mailto:mauro.giacchini@lnl.infn.it Mauro Giacchini (INFN-LNL)]

7:35, 13 Apr 2005 (CDT)

''Credits: This document was derived from the original version done by Arne Freyberger (JLAB), sent to me by Stephen Wood (JLAB). Thanks a lot to both of you and to Ralph Lange (BESSY) and Glen Write (CLS) for additional help.''

HowToPC104

2005-04-13T06:10:54Z

MauroGiacchini:

'''''This is an internal note of my lab (INFN-LNL ITALY) showing results of my first experience with running EPICS on an embedded PC104 to control a Camac Crate Controller by Serial-over-Ethernet and a Rockwell Micrologix 1500 PLC by serial line. P.S. Both new Devices Support was written using Asyn by M.Kraimer'''''

= 1 Building R3.14.7 Base on a Linux Box =
# The following was performed on a workstation type Slackware 7.0 linux box (equipped with an old PentiumIII, 500Mhz, 512MB RAM). I ran into a sync problem on HD using the “BigSlack” distro, so I created the ISO image of version 7.0 and installed it using a CD-ROM.
# Download baseR3.14.7.tar.gz from http://www.aps.anl.gov/epics/base/R3-14/7.php
# Create a working directory: /usr/src/R3.14.7
# cd /usr/src/R3.14.7
# tar -zxvf baseR3.14.7.tar.gz
# cd base
# Edit configure/CONFIG_SITE, look for the following variables and change them to what is shown below:
#* CROSS_COMPILER_TARGET_ARCHS=
#* STATIC_BUILD=YES
# Edit startup/Site.cshrc or define EPICS_BASE in your shell:
#* setenv EPICS_BASE /usr/src/R3.14.7/base
# Source startup/Site.cshrc (or restart your shell)
# Type ``make'' in /usr/src/R3.14.7/base and go brew a pot of coffee.
# Check for binaries in bin/linux-x86

= 2 Building the Example Application =
# cd /home/giacchin/ (or wherever you want to build the example)
# mkdir testIOC
# cd testIOC
# $EPICS_BASE/bin/linux-x86/makeBaseApp.pl -i example
# $EPICS_BASE/bin/linux-x86/makeBaseApp.pl -i -t example example
# make
# cd ../iocBoot/iocexample
# Start your IOC with ../../exampleApp/src/O.linux-x86/example st.cmd
# List the existing records using dbl

At this point you will be in the “iocSh” (aka ioc shell). You can use the CA commandline tools from base to access your IOC through Channel Access: “caget yourHost:aiExample1” (in the same net or after you point EPICS_CA_ADDR_LIST to your linux box). The values of that example record should change between 0 and 9.

= 3 Migrating exampleApp Code to your PC104 =
Once you've established working binaries on your linux box, it's time to move them to the PC104 card. I try to mimic the directory structure of the linux host on the PC104 card, so that you do not have to modify anything. The IOC boot structure should be portable without any changes, though.
# Log onto the pc104
# Create /home/giacchin (or wherever you want to put stuff) and the directory structure:
## mkdir /home/giacchin; cd /home/giacchin/
## mkdir testIOC; cd testIOC
## mkdir bin dbd db iocBoot iocBoot/iocexample
# Back on the host: cd /home/giacchin/testIOC/iocBoot/iocexample
# ftp from your linux box to your pc104
# cd /home/giacchin/testIOC/iocBoot/iocexample; lcd <same directory>
# put st.cmd
# cd /home/giacchin/testIOC/db; lcd <same directory>
# put dbExample1.db dbExample2.db dbsubExample.db
# cd /home/giacchin/testIOC/dbd ; lcd <same directory>
# put example.dbd
# cd /home/giacchin/testIOC/bin/linux-x86
# put caRepeater example

I used the TMZ104 (a PC104 starter kit made by [http://www.tri-m.com TRI-M ENGINEERING]). The Linux environment of the starter kit isn't equipped with all the libs necessary to use the caRepeater, therefore I copied the libraries from my host PC (with Slackware7.0) to the PC104 into the same directory. The missing libs were:
* libpthread
* libstdc++-libc6.1
* libreadline.so

Now we are ready to start our application on the PC104
# Log onto the pc104 card
# cd /home/giacchin/testIOC/bin/limux-x86
# chmod +x caRepeater example
# cd /home/giacchin/testIOC/iocBoot/iocexample
# Start the caRepeater: ../../bin/linux-x86/caRepeater &
# Start the example: ../../bin/linux-x86/example st.cmd

At this point you can access your PC104 through Channel Access from your host or another unix machine with EPICS: camonitor giacchinHost:dbExample1 
(Don't forget to set EPICS_CA_ADDR_LIST to the PC104 IP address if you're on a different subnet.)

-- [mailto:mauro.giacchini@lnl.infn.it Mauro Giacchini (INFN-LNL)]

''Credits: This document was derived from the original version done by Arne Freyberger (JLAB), sent to me by Stephen Wood (JLAB). Thanks a lot to both of you and to Ralph Lange (BESSY) and Glen Write (CLS) for additional help.''

HowToPC104

2005-04-13T06:09:45Z

MauroGiacchini:

'''''This is an internal note of my lab (INFN-LNL ITALY) showing results of my first experience with running EPICS on an embedded PC104 to control a Camac Crate Controller by Serial-over-Ethernet and a Rockwell Micrologix 1500 PLC by serial line. P.S. Both new Device Supports was written using Asyn by M.Kraimer'''''

= 1 Building R3.14.7 Base on a Linux Box =
# The following was performed on a workstation type Slackware 7.0 linux box (equipped with an old PentiumIII, 500Mhz, 512MB RAM). I ran into a sync problem on HD using the “BigSlack” distro, so I created the ISO image of version 7.0 and installed it using a CD-ROM.
# Download baseR3.14.7.tar.gz from http://www.aps.anl.gov/epics/base/R3-14/7.php
# Create a working directory: /usr/src/R3.14.7
# cd /usr/src/R3.14.7
# tar -zxvf baseR3.14.7.tar.gz
# cd base
# Edit configure/CONFIG_SITE, look for the following variables and change them to what is shown below:
#* CROSS_COMPILER_TARGET_ARCHS=
#* STATIC_BUILD=YES
# Edit startup/Site.cshrc or define EPICS_BASE in your shell:
#* setenv EPICS_BASE /usr/src/R3.14.7/base
# Source startup/Site.cshrc (or restart your shell)
# Type ``make'' in /usr/src/R3.14.7/base and go brew a pot of coffee.
# Check for binaries in bin/linux-x86

= 2 Building the Example Application =
# cd /home/giacchin/ (or wherever you want to build the example)
# mkdir testIOC
# cd testIOC
# $EPICS_BASE/bin/linux-x86/makeBaseApp.pl -i example
# $EPICS_BASE/bin/linux-x86/makeBaseApp.pl -i -t example example
# make
# cd ../iocBoot/iocexample
# Start your IOC with ../../exampleApp/src/O.linux-x86/example st.cmd
# List the existing records using dbl

At this point you will be in the “iocSh” (aka ioc shell). You can use the CA commandline tools from base to access your IOC through Channel Access: “caget yourHost:aiExample1” (in the same net or after you point EPICS_CA_ADDR_LIST to your linux box). The values of that example record should change between 0 and 9.

= 3 Migrating exampleApp Code to your PC104 =
Once you've established working binaries on your linux box, it's time to move them to the PC104 card. I try to mimic the directory structure of the linux host on the PC104 card, so that you do not have to modify anything. The IOC boot structure should be portable without any changes, though.
# Log onto the pc104
# Create /home/giacchin (or wherever you want to put stuff) and the directory structure:
## mkdir /home/giacchin; cd /home/giacchin/
## mkdir testIOC; cd testIOC
## mkdir bin dbd db iocBoot iocBoot/iocexample
# Back on the host: cd /home/giacchin/testIOC/iocBoot/iocexample
# ftp from your linux box to your pc104
# cd /home/giacchin/testIOC/iocBoot/iocexample; lcd <same directory>
# put st.cmd
# cd /home/giacchin/testIOC/db; lcd <same directory>
# put dbExample1.db dbExample2.db dbsubExample.db
# cd /home/giacchin/testIOC/dbd ; lcd <same directory>
# put example.dbd
# cd /home/giacchin/testIOC/bin/linux-x86
# put caRepeater example

I used the TMZ104 (a PC104 starter kit made by [http://www.tri-m.com TRI-M ENGINEERING]). The Linux environment of the starter kit isn't equipped with all the libs necessary to use the caRepeater, therefore I copied the libraries from my host PC (with Slackware7.0) to the PC104 into the same directory. The missing libs were:
* libpthread
* libstdc++-libc6.1
* libreadline.so

Now we are ready to start our application on the PC104
# Log onto the pc104 card
# cd /home/giacchin/testIOC/bin/limux-x86
# chmod +x caRepeater example
# cd /home/giacchin/testIOC/iocBoot/iocexample
# Start the caRepeater: ../../bin/linux-x86/caRepeater &
# Start the example: ../../bin/linux-x86/example st.cmd

At this point you can access your PC104 through Channel Access from your host or another unix machine with EPICS: camonitor giacchinHost:dbExample1 
(Don't forget to set EPICS_CA_ADDR_LIST to the PC104 IP address if you're on a different subnet.)

-- [mailto:mauro.giacchini@lnl.infn.it Mauro Giacchini (INFN-LNL)]

''Credits: This document was derived from the original version done by Arne Freyberger (JLAB), sent to me by Stephen Wood (JLAB). Thanks a lot to both of you and to Ralph Lange (BESSY) and Glen Write (CLS) for additional help.''