.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "TORRUS_ACTION_NOTIFY 7"
.TH TORRUS_ACTION_NOTIFY 7 "2015-07-14" "torrus 2.08" "torrus"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
action_notify \- Generic notification handler for Torrus monitor
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&
\&
\&
\& $TORRUS_BIN/action_notify
\&
\&
\&
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This program is designed for usage from a monitor action only. It takes
the arguments from environment variables, as described in action-type
\&\f(CW\*(C`exec\*(C'\fR in \fBTorrus \s-1XML\s0 Configuration Guide\fR.
.PP
The handler reads its configuration from , a small
Perl file which defines the notification paths for various conditions.
.PP
Example:
.PP
.Vb 6
\& %Torrus::Notify::programs =
\& (
\& \*(Aqmailto\*(Aq => \*(Aq$TORRUS_BIN/action_printemail | /usr/bin/mail $ARG1\*(Aq,
\& \*(Aqpage\*(Aq => \*(Aq/usr/bin/echo $TORRUS_NODEPATH:$TORRUS_MONITOR \*(Aq .
\& \*(Aq>> /tmp/monitor.$ARG1.log\*(Aq
\& );
\&
\& %Torrus::Notify::policies =
\& (
\& \*(AqCUST_A\*(Aq => {
\& \*(Aqmatch\*(Aq => sub { $ENV{\*(AqTORRUS_P_notify_policy\*(Aq} eq \*(AqA\*(Aq },
\& \*(Aqseverity\*(Aq => {
\& \*(Aq3\*(Aq => [ \*(Aqmailto:aaa@domain.com\*(Aq,
\& \*(Aqmailto:bbb@domain.com\*(Aq ],
\& \*(Aq5\*(Aq => [ \*(Aqpage:1234\*(Aq, \*(Aqmailto:boss@domain.com\*(Aq ] } } );
.Ve
.PP
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 \fIA\fR, we define the policy so that
the parameter \f(CW\*(C`notify\-policy\*(C'\fR should match the name \f(CW\*(C`A\*(C'\fR. The parameter
is defined in the datasource tree and marks only those leaves
that belong to this customer.
Then, depending 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.
.PP
The \f(CW\*(C`match\*(C'\fR argument is a Perl subroutine, and can depend on various
parameters, such as time of day or day of the week, the tree name, and so on.
.SH "FILES"
.IX Header "FILES"
.IP "\fI/etc/torrus/conf/notify\-siteconfig.pl\fR" 4
.IX Item "/etc/torrus/conf/notify-siteconfig.pl"
Notification policies configuration
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fItorrus\fR\|(8)
.SH "NOTES"
.IX Header "NOTES"
See more documentation at Torrus home page: http://torrus.org
.SH "AUTHOR"
.IX Header "AUTHOR"
Stanislav Sinyagin