torrus/xmlconfig/snmp-defs.xml

   1 <?xml version="1.0"?>
   2 <!--
   3    Copyright (C) 2002  Stanislav Sinyagin
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  18
  19   $Id: snmp-defs.xml,v 1.1 2010-12-27 00:04:06 ivan Exp $
  20   Stanislav Sinyagin <ssinyagin@yahoo.com>
  21
  22 -->
  23
  24 <!-- These are the basic definitions for the SNMP collector
  25
  26   WARNING: This file is overwritten by "make install"
  27 -->
  28
  29 <configuration>
  30
  31 <param-properties>
  32   <!-- Parameters which need to be expanded accorrding
  33        to $defs and %paramrefs% -->
  34
  35   <prop param="ifindex-table"       prop="expand" value="1"/>
  36   <prop param="snmp-host"           prop="expand" value="1"/>
  37   <prop param="snmp-object"         prop="expand" value="1"/>
  38
  39   <!-- Parameters which are included in search DB -->
  40   <prop param="snmp-host"               prop="search" value="1"/>
  41
  42 </param-properties>
  43
  44
  45 <datasources>
  46
  47   <template name="snmp-defaults">
  48     <param name="ds-type" value="collector" />
  49     <param name="collector-type" value="snmp" />
  50
  51     <!-- Two mandatory parameters define the collector schedule.
  52          The collector runs at moments defined by formula:
  53            time + period - (time mod period) + timeoffset -->
  54     <param name="collector-period" value="300" />
  55     <param name="collector-timeoffset" value="10" />
  56
  57     <param name="storage-type" value="rrd" />
  58
  59     <!-- Unique host identifier, normally same as hostname -->
  60     <param name="system-id" value="%snmp-host%" />
  61
  62     <!-- Host-specific part of nodeid -->
  63     <param name="nodeid-device" value="%system-id%" />
  64
  65     <!-- Host-level nodeid -->
  66     <param name="nodeid" value="device//%nodeid-device%" />
  67
  68     <!-- SNMP Parameters -->
  69
  70     <!--
  71       The following parameters must be defined elsewhere:
  72
  73       snmp-host
  74
  75       snmp-version
  76          Valid values are: 1, 2c.
  77          Version 3 will be supported in the future.
  78
  79       snmp-port: UDP port to use (usually 161)
  80
  81       snmp-community
  82
  83       domain-name: will be appended to hostname if it contains no dots
  84
  85       data-dir
  86       data-file
  87     -->
  88
  89     <!-- Mandatory transport protocol -->
  90     <param name="snmp-ipversion" value="4" />
  91     <param name="snmp-transport" value="udp" />
  92
  93     <!-- Mandatory session timeout and no. of retries -->
  94     <param name="snmp-timeout" value="10" />
  95     <param name="snmp-retries" value="2" />
  96
  97     <!-- Number of SNMP OIDs per one UDP packet -->
  98     <param name="snmp-oids-per-pdu" value="40" />
  99
 100     <!-- RRD Parameters -->
 101
 102     <!-- Round-robin arrays to be created, separated by space.
 103      By default we keep 5-minute details for 2 weeks,
 104      30-minute average and maximum details for 6 weeks,
 105      and 1-day aggregated stats for 2 years.
 106      In 30-minute average one missing sample is allowed.
 107      In daily average one hour of missing samples are allowed.
 108       -->
 109     <param name="rrd-create-rra">
 110       RRA:AVERAGE:0:1:4032
 111       RRA:AVERAGE:0.17:6:2016      RRA:MAX:0.17:6:2016
 112       RRA:AVERAGE:0.042:288:732    RRA:MAX:0.042:288:732
 113     </param>
 114
 115     <!-- if no updates are received for 8 minutes, consider the datasource
 116          unknown, i.e. dead -->
 117     <param name="rrd-create-heartbeat" value="500"/>
 118
 119     <param name="rrd-create-min" value="0"/>
 120     <param name="rrd-create-max" value="U"/>
 121
 122     <param name="leaf-type" value="rrd-def" />
 123     <param name="rrd-cf"    value="AVERAGE" />
 124
 125     <!-- Default schedule for the monitor -->
 126     <param name="monitor-period"     value="300" />
 127     <param name="monitor-timeoffset" value="75" />
 128
 129     <param name="searchable" value="yes" />
 130   </template>
 131
 132   <!-- Optional Holt-Winters algorithm parameters
 133        Default values are:
 134         alpha=0.1, beta=0.0035, gamma=0.1,
 135         window_length=9, failure_threshold=6 -->
 136
 137   <template name="holt-winters-defaults">
 138     <param name="rrd-hwpredict" value="enabled" />
 139
 140     <param name="rrd-create-hw-alpha" value="0.1" />
 141     <param name="rrd-create-hw-beta" value="0.0035" />
 142     <param name="rrd-create-hw-gamma" value="0.1" />
 143     <param name="rrd-create-hw-winlen" value="9" />
 144     <param name="rrd-create-hw-failth" value="6" />
 145
 146     <!-- Optional Holt-Winters season length.
 147          Default is one-day (288 5-minute intervals) -->
 148     <param name="rrd-create-hw-season" value="288" />
 149
 150     <!-- Mandatory length of the Holt-Winters archives.
 151          Recommended same length as main 5-minutes RRA -->
 152     <param name="rrd-create-hw-rralen" value="4032" />
 153   </template>
 154
 155   <!-- Template for read-only access to RRD files -->
 156
 157   <template name="viewonly-defaults">
 158     <param name="ds-type" value="rrd-file" />
 159     <param name="leaf-type" value="rrd-def" />
 160     <param name="rrd-cf"    value="AVERAGE" />
 161     <param name="system-id" value="%snmp-host%" />
 162   </template>
 163
 164
 165 </datasources>
 166
 167 </configuration>