torrus/xmlconfig/examples/docsis-monitors.xml

   1 <?xml version="1.0"?>
   2 <!--
   3    Copyright (C) 2005  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: docsis-monitors.xml,v 1.1 2010-12-27 00:04:28 ivan Exp $
  20   Stanislav Sinyagin <ssinyagin@yahoo.com>
  21
  22    Example monitors that may be applied to DOCSIS CMTS monitoring
  23
  24 -->
  25
  26
  27 <configuration>
  28
  29 <token-sets>
  30
  31   <token-set name="docs-warnings">
  32     <param name="comment" value="DOCSIS Warnings" />
  33   </token-set>
  34
  35   <token-set name="docs-minor">
  36     <param name="comment" value="DOCSIS Minor failures" />
  37   </token-set>
  38
  39   <token-set name="docs-major">
  40     <param name="comment" value="DOCSIS Major failures" />
  41   </token-set>
  42
  43 </token-sets>
  44
  45 <monitors>
  46
  47   <!-- **********************************************************
  48         Three levels of actions for different severity levels
  49        ********************************************************** -->
  50   <action name="docs-tset-warnings">
  51     <param name="action-type" value="tset" />
  52     <param name="tset-name" value="docs-warnings" />
  53   </action>
  54
  55   <action name="docs-tset-minor">
  56     <param name="action-type" value="tset" />
  57     <param name="tset-name" value="docs-minor" />
  58   </action>
  59
  60   <action name="docs-tset-major">
  61     <param name="action-type" value="tset" />
  62     <param name="tset-name" value="docs-major" />
  63   </action>
  64
  65
  66   <!-- ==========================================================
  67        ==                  RFC2670 monitors                    ==
  68        ========================================================== -->
  69
  70
  71   <!-- **********************************************************
  72         SNR monitors
  73        ********************************************************** -->
  74   <monitor name="docsis-snr-1">
  75     <param name="monitor-type"  value="expression" />
  76     <param name="rpn-expr"
  77              value="DUP,0,GT,EXC,DUP,24.5,LT,EXC,22,GE,AND,AND" />
  78     <param name="action"        value="docs-tset-warnings" />
  79     <param name="expires"       value="1800" />
  80     <param name="comment">
  81       Signal/Noise-Ratio lower than 30dB
  82     </param>
  83   </monitor>
  84
  85   <monitor name="docsis-snr-2">
  86     <param name="monitor-type"  value="expression" />
  87     <param name="rpn-expr"
  88              value="DUP,0,GT,EXC,DUP,22,LT,EXC,18,GE,AND,AND" />
  89     <param name="action"        value="docs-tset-minor" />
  90     <param name="expires"       value="21600" />
  91     <param name="comment">
  92       Signal/Noise-Ratio lower than 25dB
  93     </param>
  94   </monitor>
  95
  96   <monitor name="docsis-snr-3">
  97     <param name="monitor-type"  value="expression" />
  98     <param name="rpn-expr"      value="DUP,0,GT,EXC,18,LT,AND" />
  99     <param name="action"        value="docs-tset-major" />
 100     <param name="expires"       value="21600" />
 101     <param name="comment">
 102       Signal/Noise-Ratio lower than 18dB
 103     </param>
 104   </monitor>
 105
 106
 107   <!-- **********************************************************
 108         Correctable FEC error rate monitors
 109        ********************************************************** -->
 110   <monitor name="docsis-feccor-1">
 111     <param name="monitor-type"  value="expression" />
 112     <param name="rpn-expr">
 113     DUP,
 114     {Error-Free},{Uncorrectable},+,+,
 115     /,100,*,DUP,
 116     10,GT,EXC,20,LE,AND
 117     </param>
 118     <param name="action"        value="docs-tset-warnings" />
 119     <param name="expires"       value="1800" />
 120     <param name="comment">
 121       FEC correctable error rate more than 10%
 122     </param>
 123   </monitor>
 124
 125   <monitor name="docsis-feccor-2">
 126     <param name="monitor-type"  value="expression" />
 127     <param name="rpn-expr">
 128     DUP,
 129     {Error-Free},{Uncorrectable},+,+,
 130     /,100,*,
 131     20,GT
 132     </param>
 133     <param name="action"        value="docs-tset-minor" />
 134     <param name="expires"       value="21600" />
 135     <param name="comment">
 136       FEC correctable error rate more than 20%
 137     </param>
 138   </monitor>
 139
 140
 141   <!-- **********************************************************
 142         Uncorrectable FEC error rate monitors
 143        ********************************************************** -->
 144   <monitor name="docsis-fecuncor-1">
 145     <param name="monitor-type"  value="expression" />
 146     <param name="rpn-expr">
 147     DUP,
 148     {Error-Free},{Correctable},+,+,
 149     /,100,*,DUP,
 150     0.5,GT,EXC,1,LE,AND
 151     </param>
 152     <param name="action"        value="docs-tset-warnings" />
 153     <param name="expires"       value="1800" />
 154     <param name="comment">
 155       FEC uncorrectable error rate more than 0.5%
 156     </param>
 157   </monitor>
 158
 159   <monitor name="docsis-fecuncor-2">
 160     <param name="monitor-type"  value="expression" />
 161     <param name="rpn-expr">
 162     DUP,
 163     {Error-Free},{Correctable},+,+,
 164     /,100,*,DUP,
 165     1,GT,2,EXC,LE,AND
 166     </param>
 167     <param name="action"        value="docs-tset-minor" />
 168     <param name="expires"       value="21600" />
 169     <param name="comment">
 170       FEC uncorrectable error rate more than 1%
 171     </param>
 172   </monitor>
 173
 174   <monitor name="docsis-fecuncor-3">
 175     <param name="monitor-type"  value="expression" />
 176     <param name="rpn-expr">
 177     DUP,
 178     {Error-Free},{Correctable},+,+,
 179     /,100,*,
 180     2,GT
 181     </param>
 182     <param name="action"        value="docs-tset-major" />
 183     <param name="expires"       value="21600" />
 184     <param name="comment">
 185       FEC uncorrectable error rate more than 2%
 186     </param>
 187   </monitor>
 188
 189
 190   <!-- **********************************************************
 191         Downstream utilization monitors
 192        ********************************************************** -->
 193   <monitor name="docsis-downutl-1">
 194     <param name="monitor-type"  value="expression" />
 195     <param name="rpn-expr">
 196     {TotalBytes},/,100,*,
 197     DUP,
 198     75,GT,EXC,80,LE,AND
 199     </param>
 200     <param name="action"        value="docs-tset-warnings" />
 201     <param name="expires"       value="1800" />
 202     <param name="comment">
 203       DOCSIS downstream utilization more than 75%
 204     </param>
 205   </monitor>
 206
 207   <monitor name="docsis-downutl-2">
 208     <param name="monitor-type"  value="expression" />
 209     <param name="rpn-expr">
 210     {TotalBytes},/,100,*,
 211     DUP,
 212     80,GT,EXC,85,LE,AND
 213     </param>
 214     <param name="action"        value="docs-tset-minor" />
 215     <param name="expires"       value="21600" />
 216     <param name="comment">
 217       DOCSIS downstream utilization more than 80%
 218     </param>
 219   </monitor>
 220
 221   <monitor name="docsis-downutl-3">
 222     <param name="monitor-type"  value="expression" />
 223     <param name="rpn-expr">
 224     {TotalBytes},/,100,*,
 225     85,GT
 226     </param>
 227     <param name="action"        value="docs-tset-minor" />
 228     <param name="expires"       value="21600" />
 229     <param name="comment">
 230       DOCSIS downstream utilization more than 85%
 231     </param>
 232   </monitor>
 233
 234
 235
 236   <!-- ==========================================================
 237        ==                  Cisco-specific monitors             ==
 238        ========================================================== -->
 239    <!-- **********************************************************
 240           Upstream utilization monitors
 241         ********************************************************** -->
 242
 243   <monitor name="docsis-uputil-1">
 244     <param name="monitor-type"  value="expression" />
 245     <param name="rpn-expr">
 246     DUP,
 247     75,GT,EXC,80,LE,AND
 248     </param>
 249     <param name="action"        value="docs-tset-warnings" />
 250     <param name="expires"       value="1800" />
 251     <param name="comment">
 252       DOCSIS upstream utilization more than 75%
 253     </param>
 254   </monitor>
 255
 256   <monitor name="docsis-uputil-2">
 257     <param name="monitor-type"  value="expression" />
 258     <param name="rpn-expr">
 259     DUP,
 260     80,GT,EXC,85,LE,AND
 261     </param>
 262     <param name="action"        value="docs-tset-minor" />
 263     <param name="expires"       value="21600" />
 264     <param name="comment">
 265       DOCSIS upstream utilization more than 80%
 266     </param>
 267   </monitor>
 268
 269   <monitor name="docsis-uputil-3">
 270     <param name="monitor-type"  value="expression" />
 271     <param name="rpn-expr">
 272     85,GT
 273     </param>
 274     <param name="action"        value="docs-tset-major" />
 275     <param name="expires"       value="21600" />
 276     <param name="comment">
 277       DOCSIS upstream utilization more than 85%
 278     </param>
 279   </monitor>
 280
 281
 282    <!-- **********************************************************
 283           Upstream free contention slots monitors
 284         ********************************************************** -->
 285
 286   <monitor name="docsis-upslots-1">
 287     <param name="monitor-type"  value="expression" />
 288     <param name="rpn-expr">
 289     DUP,
 290     17,LT,EXC,12,GE,AND
 291     </param>
 292     <param name="action"        value="docs-tset-warnings" />
 293     <param name="expires"       value="1800" />
 294     <param name="comment">
 295       free DOCSIS upstream minislots less than 17%
 296     </param>
 297   </monitor>
 298
 299   <monitor name="docsis-upslots-2">
 300     <param name="monitor-type"  value="expression" />
 301     <param name="rpn-expr">
 302     DUP,
 303     12,LT,EXC,7,GE,AND
 304     </param>
 305     <param name="action"        value="docs-tset-minor" />
 306     <param name="expires"       value="21600" />
 307     <param name="comment">
 308       free DOCSIS upstream minislots less than 12%
 309     </param>
 310   </monitor>
 311
 312   <monitor name="docsis-upslots-3">
 313     <param name="monitor-type"  value="expression" />
 314     <param name="rpn-expr">
 315     7,LT
 316     </param>
 317     <param name="action"        value="docs-tset-major" />
 318     <param name="expires"       value="21600" />
 319     <param name="comment">
 320       free DOCSIS upstream minislots less than 7%
 321     </param>
 322   </monitor>
 323
 324    <!-- **********************************************************
 325           Modems online monitors
 326         ********************************************************** -->
 327
 328   <!-- If Modems_Total < 100, then
 329          Active < 10% ===> warning
 330        If Modems_Total >= 100, then
 331          Active < 50% ===> minor
 332          Active < 10% ===> major  -->
 333
 334   <monitor name="docsis-modems-1">
 335     <param name="monitor-type"  value="expression" />
 336     <param name="rpn-expr">
 337     {Modems_Total},/,100,*,10,LT,
 338     {Modems_Total},100,LT,AND
 339     </param>
 340     <param name="action"        value="docs-tset-warnings" />
 341     <param name="expires"       value="1800" />
 342     <param name="comment">
 343       Less than 10% of DOCSIS modems online on a low-loaded interface
 344     </param>
 345   </monitor>
 346
 347   <monitor name="docsis-modems-2">
 348     <param name="monitor-type"  value="expression" />
 349     <param name="rpn-expr">
 350     {Modems_Total},/,100,*,
 351     DUP,
 352     50,LT,EXC,10,GE,AND,
 353     {Modems_Total},100,GE,AND
 354     </param>
 355     <param name="action"        value="docs-tset-minor" />
 356     <param name="expires"       value="21600" />
 357     <param name="comment">
 358       Less than 50% of DOCSIS modems online
 359     </param>
 360   </monitor>
 361
 362   <monitor name="docsis-modems-3">
 363     <param name="monitor-type"  value="expression" />
 364     <param name="rpn-expr">
 365     {Modems_Total},/,100,*,10,LT,
 366     {Modems_Total},100,GE,AND
 367     </param>
 368     <param name="action"        value="docs-tset-major" />
 369     <param name="expires"       value="21600" />
 370     <param name="comment">
 371       Less than 10% of DOCSIS modems online
 372     </param>
 373   </monitor>
 374
 375   <!-- ==========================================================
 376        ==           IF-MIB monitors for cable interfaces       ==
 377        ========================================================== -->
 378
 379   <monitor name="docs-inerrors-1">
 380     <param name="monitor-type"  value="expression" />
 381     <param name="rpn-expr">
 382     {Packets_In},/,100,*,DUP,
 383     10,GT,EXC,50,LE,AND
 384     </param>
 385     <param name="action"        value="docs-tset-warnings" />
 386     <param name="expires"       value="21600" />
 387     <param name="comment">
 388       Input packet errors more than 10%
 389     </param>
 390   </monitor>
 391
 392   <monitor name="docs-inerrors-2">
 393     <param name="monitor-type"  value="expression" />
 394     <param name="rpn-expr">
 395     {Packets_In},/,100,*,DUP,
 396     50,GT
 397     </param>
 398     <param name="action"        value="docs-tset-minor" />
 399     <param name="expires"       value="21600" />
 400     <param name="comment">
 401       Input packet errors more than 50%
 402     </param>
 403   </monitor>
 404
 405   <monitor name="docs-outerrors-1">
 406     <param name="monitor-type"  value="expression" />
 407     <param name="rpn-expr">
 408     {Packets_Out},/,100,*,DUP,
 409     10,GT,EXC,50,LE,AND
 410     </param>
 411     <param name="action"        value="docs-tset-warnings" />
 412     <param name="expires"       value="21600" />
 413     <param name="comment">
 414       Output packet errors more than 10%
 415     </param>
 416   </monitor>
 417
 418   <monitor name="docs-outerrors-2">
 419     <param name="monitor-type"  value="expression" />
 420     <param name="rpn-expr">
 421     {Packets_Out},/,100,*,DUP,
 422     50,GT
 423     </param>
 424     <param name="action"        value="docs-tset-minor" />
 425     <param name="expires"       value="21600" />
 426     <param name="comment">
 427       Output packet errors more than 50%
 428     </param>
 429   </monitor>
 430
 431 </monitors>
 432
 433 </configuration>