Page History

...

# su - uptime
$ /opt/uptime-agent/my-scripts/show_temp.sh 
temp 74 
rh 30

...

1. Ensure that a file named .uptmpasswd is created in the Uptime Infrastructure Monitor agent bin directory -- either /opt/SPYNuptm/bin/ or /opt/uptime-agent/bin, depending the version of your agent. This file must be owned and readable by the user that the agent is run as (ex. uptimeagent or uptime users).
2. Open the file .uptmpasswd in a text editor.
3. Enter a password and command pair for each command that you want to run on the agent system. The following is the example format and an example of a agent-side commands:

   Format: [password] [command path, no arguments]

   Example file contents:

    

   Code Block
   language powershell
   secretpassword /opt/uptime -agent /my -scripts /show_temp.sh $%^& /usr/local/bin/appstatus.sh

...

[HKEY_LOCAL_MACHINE\SOFTWARE\uptime software\up.time agent]
"CmdsTimeout"=dword:00000014
"Port"=dword:0000270e
"MaxClients"=dword:00000005
"Debug"=dword:00000000
"CmdsPassword"="secretpassword"
"LogFile"="log.txt"

[HKEY_LOCAL_MACHINE\SOFTWARE\uptime software\up.time agent\rexec_commands] 
"dir"= cmd.exe /c "dir c:"
"show-temp"= cmd.exe /c "C:\scripts\show_temp.pl"

...

• To get started with custom scripts, or for implementations with only a handful of custom monitor instances, use agentcmd. The agentcmd utility is commonly called in the format listed below to execute a command on the agent side system. Please note that this utility is a helper tool, if you are using many custom monitor instances we recommend using an alternate tool.
  This example uses the settings that were configured above to execute the agent side script:

  Format:

   

  Code Block
  language text
  /usr/local/uptime/scripts/agentcmd [-s/+s] -p [agent port] [agent hostname] rexec [password] [path]

   

  Example:

  Code Block
  language text
  /usr/local/uptime/scripts/agentcmd -p 9998 my-agent rexec secretpassword /opt/uptime-agent/my-scripts/show_temp.sh my-arguments

  For more information, click on Using the agentcmd Utility.

• If you plan on implementing a number of custom monitor instances, use netcat. netcat must be downloaded and installed on the monitoring station if it isn't already installed as part of your operating system. The netcat utility is commonly called in the format listed below to execute a command on the agent side system. This example uses the settings that were configured above to execute the agent side script:

  Format:

  Code Block
  language text
  echo -n rexec [password] [path] | /usr/local/uptime/bin/netcat [agent hostname] [agent port]

  Example:

  Code Block
  language text
  echo -n rexec secretpassword /opt/uptime-agent/my-scripts/show_temp.sh my-arguments | /usr/local/uptime/bin/netcat my-agent 9998

...

You will normally use netcat or agentcmd in the monitoring station script to return the results of an agent-side script, validate the status of those results, and return the status to Uptime Infrastructure Monitor. The following is an example of a monitoring station script:

#!/bin/sh

# This script takes the following arguments:
# check_temp.sh hostname port [temp|rh] wng crit
# Example execution:
# ./check_temp.sh my-agent 9998 temp 60 80
# ./check_temp.sh my-agent 9998 rh 20 30

# This script can be placed anywhere on the monitoring station system as long as it is
# executable by the uptime user.

#First, collect our arguments
AGENT=$1
PORT=$2
TYPE=$3
WNG=$4
CRIT=$5

TMPFILE=/tmp/$$.temp

# now use the info above to contact our agent, store the output in a file for parsing

`echo -n rexec secretpassword /opt/uptime-agent/my-scripts/show_temp.sh my-arguments | /usr/local/uptime4/bin/netcat $AGENT $PORT > $TMPFILE`

...

When using agentcmd, the above netcat example would look like this:

'/usr/local/uptime/scripts/agentcmd my-agent -p 9998 rexec secretpassword /opt/uptime-agent/my-scripts/show_temp.sh my-arguments > $TMPFILE'

# we have the output from the agent. If it is ERR that means there was a problem running the script on the agent
`grep ERR $TMPFILE`
if [ $? -eq 0 ]
then
echo "Could not execute agent side script!" 
# by exiting with a 2 we are forcing a CRIT service outage
exit 2
fi

# given our parameters we can now extract the correct value from the agent output
if [ $TYPE -eq "temp" ]
then
VALUE=`head -1 $TMPFILE | awk '{print $2}'`
MSG="temperature"
else
VALUE=`tail -1 $TMPFILE | awk '{print $2}'`
MSG="humidity"
fi

# now lets check our values to see if they are over the thresholds and set our status message
RET="OK - $msg is $VALUE on $AGENT"

if [ $VALUE -ge "$WNG" ]
then
# this is our warning message
# include WARNING for use in the web interface thresholds
RET="WARNING - $MSG is $VALUE on $AGENT"
fi
if [ $VALUE -ge "$CRIT" ]
then
# this is our critical message
# include CRITICAL for use in the web interface thresholds
echo "CRITICAL - $MSG is $VALUE on $AGENT"
fi

# here we simply print our status message to the console and exit with a 0, 
# the thresholds provided in the up.time web interface will be used to set the monitor status
rm $TMPFILE
echo "$RET"
exit 0

...

The image below illustrates a sample monitor configuration. This service monitor will indicate a WARN or CRIT whenever the monitoring station custom script returns WARNING or CRITICAL in its output.

Save

Save