15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
19
18
# Stanislav Sinyagin <ssinyagin@yahoo.com>
580
584
C<collector> leaves or C<leaf-type=rrd-def> in C<rrd-file> leaves). The
581
585
parameter Specifies the RRD datasource name within a file.
585
Mandatory when a leaf refers to an RRD file (C<storage-type=rrd> in
586
C<collector> leaves or C<leaf-type=rrd-def> in C<rrd-file> leaves). The
587
parameter Specifies the RRD datasource name within a file.
589
587
=item * C<rrd-cf>
591
589
Mandatory under the same conditios as C<rrd-ds>. Defines the default
603
=item * C<graph-step>
605
Optional. If defined, it specifies the minimum step in seconds that is
606
used to draw the graph. This can be useful, for eample, if an average
607
number of events per hour needs to be displayed.
605
609
=item * C<rrd-hwpredict>
607
611
Optional. If equals to C<enabled>, then this RRD datasource
788
792
Mandatory when C<collector-type=snmp> and SNMP version is C<3>.
794
=item * C<snmp-contextname>
796
Optional SNMP context name for SNMPv3.
790
798
=item * C<snmp-authkey>
792
800
Optional authentication key for SNMPv3. If not defined, the authentication
1008
1016
Optional. When set to C<yes>, this datasource is not included in GPRINT output.
1018
=item * C<maxline-style-X> and C<maxline-color-X>
1020
Optional parameters that define the style and color for the I<maximum>
1021
line. The maxim line usually displays daily or hourly maximums, and the
1022
color needs to be contrast enough to be distinctively visible on the
1012
1027
=head2 View definitions
1183
1198
Generates the RRD Graph representation of the given I<leaf> (remember,
1184
1199
subtrees are only logical grouping of the real data).
1186
The following parameters are mandatory for this kind of view:
1201
The following parameters are recognized for this kind of view:
1190
=item * C<width>, C<height>, C<start>
1205
=item * C<width>, C<height>, C<start>, C<end>, C<imgformat>, C<border>
1192
Correspond to same parameters in RRD Graph command.
1207
These view parameters correspond to same parameters in RRD Graph command.
1193
1208
C<end> can also be given, it defaults to I<C<now>>.
1209
The following parameters are mandatory: C<width>, C<height>, and C<start>.
1210
C<border> is only supported in RRDtool version 1.3.9 or higher.
1195
1212
=item * C<line-style>
1197
Line specification in RRD graph. May be I<C<LINE1>>, I<C<LINE2>> etc.
1214
Mandatory line specification in RRD graph. May be I<C<LINE1>>, I<C<LINE2>> etc.
1198
1215
Two hashes in the beginning and a name refer to the line style from
1199
1216
the styling profile, e.g. C<##SingleGraph>.
1201
1218
=item * C<line-color>
1203
Line color. Must have the hash symbol in the beginning, like I<C<#0000FF>>.
1220
Mandatory line color. Must have the hash symbol in the beginning, like
1204
1222
Two hashes in the beginning and a name refer to the color from
1205
1223
the styling profile, e.g. C<##SingleGraph>.
1225
=item * C<graph-colors>
1227
Optional. The parameter defines the values for the C<--color> options in RRD
1228
Graph command. The value is an even number of color tags and color values,
1229
separated by colon (:). For example, "BACK:00FFFF:FONT:AA55DD" corresponds to
1230
an ugly cyan background and magenta text.
1207
1232
=item * C<rrd-hwpredict>
1209
If equals to C<disabled>, HWPREDICT display is disabled for this view.
1234
Optional. If equals to C<disabled>, HWPREDICT display is disabled for this view.
1210
1235
Note that if the datasource has C<rrd-hwpredict> parameter set to C<enabled>,
1211
1236
this emplies that the view would contain Holt-Winters boundaries and failures
1296
1321
The first one defines the starting time. C<end> may be also optionally
1299
C<print-cf> specifies oe or more consolidation functions, separated by comma.
1324
C<print-cf> specifies one or more consolidation functions, separated by comma.
1300
1325
The result of the rendering is the text line with the output values
1301
1326
separated by colon (:).
1305
1328
=item * C<disable-legend>, C<disable-title>, C<disable-vertical-label>
1307
1330
When set to C<yes>, the corresponding elements of the graph are not displayed.
1311
1335
=head3 Styling Profiles
1489
1513
This event type means that the alarm condition still persists
1490
1514
after the previous run of Monitor.
1518
If escalation times are defined with C<escalations> parameter, this
1519
event is fired if the alarm condition persists for a specified
1520
time. Each escalation event is fired only once.
1492
1522
=item * C<clear>
1494
1524
Event of this type happens when the alarm condition stops.
1526
=item * C<clear_escalation>
1528
After the C<clear> event is fired, C<clear_escalation> is also fired for
1529
every escalation that was raised before it.
1496
1531
=item * C<forget>
1498
1533
Once the alarm is cleared, this event happens after the expiration
1564
=item * C<escalations>
1566
Optional parameter with comma-separated escalation times. Each
1567
escalation time is a period in seconds. As soon as the alarm condition
1568
persists for the specified period, an C<escalate> event is fired.
1529
1570
=item * C<rpn-expr>
1531
1572
Mandatory for monitor type C<expression>. Defines the RPN expression to
1534
1575
constructs of the form C<#varname> are replaced with the variable
1535
1576
value specified in the leaf's C<monitor-vars> parameter.
1578
=item * C<time-span>
1580
Optional parameter, a positive integer specifying the time span in
1581
seconds. If defined, the data source value is calculated across the
1582
defined period with the aggregation function that is defined in
1583
C<rrd-cf> parameter. If not specified, the last available value is
1586
=item * C<time-zone>
1588
Optional parameter. If defined, it should contain a valid time zone name
1589
that is resolvable on the local server. This affects the TOD function in
1590
RPN expressions. If undefined, the local time zone is used.
1537
1592
=item * C<action>
1539
1594
Mandatory parameter, comma-separated list of action names (spaces
1598
1653
Mandatory for action type C<tset>. Defines the tokenset name
1599
1654
where the leaf is added when the monitor condition is met.
1656
=item * C<on-escalations>
1658
Optional parameter for action type C<tset>. It specifies a
1659
comma-separated list of escalation times at which the leaf would be
1660
added to the tokenset.
1601
1662
=item * C<command>
1603
1664
Mandatory for action type C<exec>. Defines the external program to launch.
1678
1743
Optional for action type C<exec>. The comma-separated list of event
1679
1744
types when the given action should be launched. If not defined,
1680
the event type C<set> is used by default.
1745
the event types C<set,escalate> are used by default.
1682
1747
=item * C<setenv-params>
added
removed
doc/xmlconfig.pod.in
