Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
TORRUS_ACTION_NOTIFY(7) 	     torrus		 TORRUS_ACTION_NOTIFY(7)

NAME
     action_notify - Generic notification handler for Torrus monitor

SYNOPSIS
      <action name="notify">
	<param name="action-type" value="exec" />
	<param name="command">
	  $TORRUS_BIN/action_notify
	</param>
	<param name="launch-when" value="set" />
      </action>

DESCRIPTION
     This program is designed for usage from a monitor action only. It takes the
     arguments from environment variables, as described in action-type "exec" in
     Torrus XML Configuration Guide.

     The handler reads its configuration from <notify-siteconfig.pl>, a small
     Perl file which defines the notification paths for various conditions.

     Example:

       %Torrus::Notify::programs =
	 (
	  'mailto' => '$TORRUS_BIN/action_printemail | /usr/bin/mail $ARG1',
	  'page' => '/usr/bin/echo $TORRUS_NODEPATH:$TORRUS_MONITOR ' .
	  '>> /tmp/monitor.$ARG1.log'
	  );

       %Torrus::Notify::policies =
	 (
	  'CUST_A' => {
	      'match' => sub { $ENV{'TORRUS_P_notify_policy'} eq 'A' },
	      'severity' => {
		  '3' => [ 'mailto:aaa@domain.com',
			   'mailto:bbb@domain.com' ],
		  '5' => [ 'page:1234', 'mailto:boss@domain.com' ] } } );

     In this example, we define two message handlers: e-mail sender and a dummy
     replacement for a pager program. Then we define the notification policies.
     For the customer A, we define the policy so that the parameter "notify-pol-
     icy" should match the name "A". The parameter is defined in the datasource
     tree and marks only those leaves that belong to this customer.  Then, de-
     pending on the monitor severity, different notification paths are defined.
     For severity values higher or equal 3, aaa@domain.com and bbb@domain.com
     will receive the email notifications, and for severity higher than or equal
     5 all recipients will receive the notification.

     The "match" argument is a Perl subroutine, and can depend on various para-
     meters, such as time of day or day of the week, the tree name, and so on.

FILES
     /usr/local/etc/torrus/conf/notify-siteconfig.pl
	 Notification policies configuration

SEE ALSO
     torrus(1)

NOTES
     See more documentation at Torrus home page: http://torrus.org

AUTHOR
     Stanislav Sinyagin <ssinyagin@k-open.com>

torrus 2.09			   2026-08-30		 TORRUS_ACTION_NOTIFY(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=torrus_action_notify&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>

home | help