htdocs/index.html

   1 <html>
   2 <head>
   3 <title>Torrus Project</title>
   4 <link rel="stylesheet" href="torrusdoc.css" type="text/css" />
   5 <!-- $Id$ -->
   6 </head>
   7
   8 <body>
   9
  10 <h1>Torrus: The Data Series Processing Framework</h1>
  11
  12 <p>In short, Torrus is an alternative software platform to
  13 <a href="http://oss.oetiker.ch/mrtg/">MRTG</a>,
  14 <a href="http://cricket.sourceforge.net/">Cricket</a> and
  15 <a href="http://www.cacti.net/">Cacti</a>. In most cases it brings more
  16 flexibility and performance. We are able to poll
  17 <a href="http://goo.gl/tpWIx">1 million SNMP OIDs every 5 minutes
  18 from a modern server</a>.
  19 </p>
  20
  21
  22 <p>
  23 Torrus is designed to be the universal data series processing
  24 framework. Its scalable hierarchical design, application-independent core,
  25 and highly customizable architecture make Torrus an attractive choice
  26 both for small installations and for big enterprise or carrier networks.
  27 Although most of our users deploy Torrus for SNMP monitoring, it might be
  28 useful for data series of any nature. Tobi Oetiker's RRDtool is used for
  29 data storage.
  30 </p>
  31
  32 <p>
  33 See the <a href="http://demo.oetiker.torrus.net/"><strong>Torrus+SIAM+Extopus
  34 demo</strong></a> that illustrates the integration of Torrus with an ISP's
  35 service inventory and a customer self-service portal.
  36 </p>
  37
  38 <p>
  39 <strong>Torrus functional overview slideshow</strong> gives some conceptional
  40 and quick explanations (<a href="torrus-functional-overview.odp">Open Office
  41 presentation</a>, <a href="torrus-functional-overview.pdf">PDF</a>)
  42 </p>
  43
  44 <p>
  45 <strong>Torrus presentation at SwiNOG
  46 meeting</strong>:
  47 <a href="Torrus-Swinog16.odp">Open Office presentation</a>,
  48 <a href="Torrus-Swinog16.pdf">PDF</a>
  49 </p>
  50
  51
  52 <p>
  53 Currently Torrus consists of the following parts:
  54 <ul>
  55
  56 <li>
  57 <strong>Configuration compiler and validator.</strong>
  58 It processes the XML configuration files and saves the configuration
  59 into a database.
  60 </li>
  61
  62 <li>
  63 <strong>View renderer and the web interface.</strong>
  64 They generate HTML and the graphical representation of the datasources
  65 and provide user authentication and authorization.
  66 All generated output is controlled by the configuration parameters
  67 and templates.
  68 The users can easily create their own presentation of data series.
  69 </li>
  70
  71 <li>
  72 <strong>SNMP Collector.</strong>
  73 Thanks to David M. Town's
  74 <a href="http://search.cpan.org/search?module=Net::SNMP">
  75 Net::SNMP Perl module</a>, Torrus has got an extremely efficient SNMP
  76 data poller, with ability to poll dozens of thousands of SNMP variables
  77 from a single server. Modular collector core architecture allows
  78 further extension with new collector and storage types.
  79 Any datasource can have its own polling schedule.
  80 </li>
  81
  82 <li>
  83 <strong>SNMP Device Discovery Tool</strong>.
  84 <em>Devdiscover</em> is a new, modular, flexible, and expandable tool for
  85 automatic generation of Torrus configuration files. New device types
  86 and MIBs are easily added as independent Perl modules. Thanks to our
  87 contributors, the number of supported devices and vendors is constantly
  88 growing.
  89 </li>
  90
  91 <li>
  92 <strong>Billing reports generator</strong>.
  93 Torrus can be configured to store the network traffic usage in an SQL
  94 database (without RRDTools' aggregation and interpolation), and produce
  95 monthly reports on traffic volume and 95th Percentile bandwidth usage.
  96 </li>
  97
  98 <li>
  99 <strong>Threshold monitor.</strong>
 100 All data, regardless of their type and nature,
 101 can be monitored according to the user-defined rules. The rules can also
 102 include the datasource-specific parameters, e.g. boundary values etc.
 103 The following types of action may be combined for event reporting:
 104 1) Displaying the list of alarmed datasources; 2) E-mail notification;
 105 3) SNMP trap; 4) Any custom executable. Thresholds are specified by RPN
 106 expressions.
 107 </li>
 108
 109 </ul>
 110 </p>
 111
 112
 113
 114 <h2>Getting the software</h2>
 115
 116 <ul>
 117 <li>
 118 <a href="http://sourceforge.net/projects/torrus/">Project
 119 home and <strong>downloads</strong></a> at Sourceforge
 120 </li>
 121 <li>
 122 <a href="http://sourceforge.net/scm/?type=git&group_id=119282">Git
 123 repository</a> and
 124 <a href="http://sourceforge.net/apps/mediawiki/torrus/index.php?title=Working_with_Torrus_sources">usage instructions</a>
 125 </li>
 126 <li>
 127 Current <a href="http://torrus.sourceforge.net/devel/">development
 128 snapshots</a> are available for testing
 129 </li>
 130 </ul>
 131
 132
 133 <h2>Documentation</h2>
 134
 135 <ul>
 136 <li>
 137 <strong><a href="http://torrus.wiki.sourceforge.net/">Torrus Wiki</a></strong>
 138 lists some useful information and tips, as well as installation scenarios for
 139 some OS'es.
 140 </li>
 141 <li>
 142 <a href="install.pod.html">Installation Instructions</a>:
 143 system requirements and installation steps
 144 </li>
 145 <li>
 146 <a href="webintf.pod.html">Web Interface Reference</a>:
 147 installation details for the different handlers
 148 </li>
 149 <li>
 150 <a href="rrfw_torrus_migration.pod.html">RRFW to Torrus migration guide</a>:
 151 step by step guide for those having an RRFW installation.
 152 </li>
 153 <li>
 154 <a href="userguide.pod.html">User Guide</a>:
 155 explains what is where and how to start using the system.
 156 </li>
 157 <li>
 158 <a href="scalability.pod.html">Scalability Guide</a>:
 159 advanced setup guidelines for large-scale monitoring platforms.
 160 </li>
 161 <li>
 162 <a href="snmpdiscovery.pod.html">SNMP Discovery User Guide</a>:
 163 Guide to SNMP discovery tools
 164 </li>
 165 <li>
 166 <a href="xmlconfig.pod.html">Configuration Guide</a>:
 167 XML configuration reference
 168 </li>
 169 <li>
 170 <a href="vendorsupport.pod.html">Vendor Support List</a>:
 171 List of vendors and MIBs supported.
 172 </li>
 173 <li>
 174 <a href="manpages/">Manual pages</a>:
 175 all executables documented
 176 </li>
 177 <li>
 178 <a href="reporting_setup.pod.html">Reporting Setup Guide</a>:
 179 Traffic usage and 95th percentile reports
 180 </li>
 181 <li>
 182 <a href="rpnexpr.pod.html">RPN expressions in Torrus</a>:
 183 Torrus-specific features in RPN expressions, as compared to
 184 <i>rrdtool graph</i>
 185 </li>
 186 <li>
 187 <a href="stylingprofile.pod.html">Styling Profile Guide</a>:
 188 how to create your own display styles for Torrus graphs
 189 </li>
 190 <li>
 191 <a href="nodeid_usage.pod.html">Using NodeID for OSS integration</a>:
 192 guidelines for integrating Torrus with external software systems
 193 </li>
 194 <li>
 195 <a href="devdoc/">Development documentation</a>: internals documented,
 196 working drafts, and technical reqirements.
 197 </li>
 198 <li>
 199 <a href="plugins/">Plugins documentation</a>: optional features and
 200 contributions.
 201 </li>
 202 </ul>
 203
 204
 205
 206 <h2>Features of Torrus</h2>
 207
 208 <ul>
 209 <li>
 210 <em>Data-oriented design</em>. Most of the existing frontends are SNMP-centric.
 211 In Torrus, the SNMP collector is not the central part,
 212 but rather one of possible data sources. It is easy to integrate
 213 some existing RRD files that are updated by some external agents.
 214 </li>
 215 <li>
 216 <em>Multiple independent datasource trees</em> in one instance
 217 of Torrus.
 218 </li>
 219 <li>
 220 <em>User authentication and authorization</em>. Users belong to groups,
 221 and each group has privileges to browse a certain subset of trees.
 222 </li>
 223 <li>
 224 Flexible hierarchical <em>configuration in XML</em> format. Multuiple XML
 225 files are processed additively.
 226 </li>
 227 <li>
 228 Externally generated RRD files can be automatically grouped,
 229 based on the filename regular expressions.
 230 </li>
 231 <li>
 232 Flexible representation of the data. One datasource may be displayed in
 233 multiple subtrees of the hierarchy. It allows you to group them at your
 234 convenience.
 235 </li>
 236 <li>
 237 <em>Aberrant behaviour detection</em> based on <em>Holt-Winters prediction</em>
 238 is fully supported (requires rrdtool version 1.1.x). See the
 239 references below for more information.
 240 </li>
 241 <li>
 242 Support for <em>international</em> character sets (Latin1 and Unicode).
 243 </li>
 244 <li>
 245 First open-source complete
 246 <a href="plugins/tp-cisco-cbqos.pod.html">implementation</a>
 247 of
 248 <a href=
 249 "http://www.cisco.com/pcgi-bin/Support/browse/index.pl?i=Technologies&f=773">
 250 Cisco QoS</a> (CISCO-CLASS-BASED-QOS-MIB) discovery and monitoring.
 251 </li>
 252 </ul>
 253
 254
 255
 256 <h2>Product Support</h2>
 257
 258 <p>
 259 Torrus is free software. It is distributed under the
 260 <a href="http://www.gnu.org/licenses/licenses.html#GPL">GNU General
 261 Public License</a>.
 262 </p>
 263 <p>
 264 Please send all your requests, comments, and bug reports to the
 265 <strong><a href="http://lists.sourceforge.net/lists/listinfo/torrus-users">
 266 torrus-users</a></strong> mailing list. Only list subscribers are allowed to
 267 post the messages there. All new release announcements are sent to this list.
 268 </p>
 269
 270 <p>
 271 The development issues of Torrus are discussed in
 272 <strong><a href="http://lists.sourceforge.net/lists/listinfo/torrus-devel">
 273 torrus-devel</a></strong> mailing list.
 274 Copies of all CVS commits are posted to
 275 <strong><a href="http://lists.sourceforge.net/lists/listinfo/torrus-commit">
 276 torrus-commit</a></strong> mailing list.
 277 </p>
 278
 279 <p>
 280 Archives of the old mailing lists are available for
 281 <strong><a href="http://lists.sourceforge.net/lists/listinfo/rrfw-users">
 282 rrfw-users</a></strong> and
 283 <strong><a href="http://lists.sourceforge.net/lists/listinfo/rrfw-devel">
 284 rrfw-devel</a></strong> .
 285 </p>
 286
 287
 288 <p>
 289 <strong>Commercial support</strong> for Torrus is provided by:
 290 <blockquote>
 291 <a href="http://www.k-open.com/">K-Open GmbH</a><br>
 292 Switzerland<br>
 293 Direct phone: +41 79 407 0224<br>
 294 Calling from USA and Canada: 1-240-846-6039<br>
 295 </blockquote>
 296 Commercial support includes:
 297 <ul>
 298 <li>Software installation and customizing</li>
 299 <li>Development of custom user data import utilities</li>
 300 <li>Development of new Torrus features</li>
 301 <li>Software maintenance contracts</li>
 302 </ul>
 303 For more details about commercial support, please contact us
 304 <a href="mailto:info@k-open.com">by email</a>.
 305 </p>
 306
 307 <h2>SNMP MIBs</h2>
 308
 309 By courtesy of Tobi Oetiker, we are using the subtree of
 310 <a href="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/iana/">
 311 RRDtool Enterprise ID</a>.
 312
 313 Torrus is now capable of sending the SNMPv2c traps, with the variables
 314 described in the corresponding MIB file.
 315
 316 <ul>
 317 <li>
 318 <a href="RRDTOOL-SMI.txt">RRDTOOL-SMI</a>: the original file from
 319 <a href="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/iana/">
 320 RRDtool enterprise tree</a>
 321 </li>
 322 <li>
 323 <a href="TORRUS-MIB.txt">Torrus-MIB</a>: The MIB which describes the SNMPv2c
 324 traps sent by <tt>action_snmptrap</tt> (see <i>Manpages</i> for
 325 details)
 326 </li>
 327 </ul>
 328
 329
 330 <h2>References</h2>
 331
 332 <ul>
 333
 334 <li>
 335 Torrus was the new name for RRFW, the Round Robin Database
 336 Framework. The changes are summarized in the
 337 <a href="devdoc/torrus_roadmap.pod.html">transition roadmap</a>.
 338 Old RRFW documentation is available at
 339 <a href="http://rrfw.sourceforge.net/">RRFW home page</a>.
 340 </li>
 341
 342 <li>
 343 Development of RRFW releases 0.0.1 to 0.0.7, as well as development and testing
 344 of Cisco class-based QoS monitoring was sponsored by
 345 <a href="http://www.cablecom.ch/">Cablecom GmbH</a>
 346 Internet Core Routing Services Team.
 347 <br>
 348 <font size="-1">
 349 Cablecom is the leading country-wide cable-TV and Internet
 350 provider in Switzerland.
 351 </font>
 352 </li>
 353
 354 <li>
 355 This project would not even start without
 356 <a href="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/index.html">
 357 Tobi Oetiker's RRDTool</a>.
 358 <br>
 359 <font size="-1">
 360 RRD is a very efficient and popular system to store and
 361 display time-series data.
 362 </font>
 363 </li>
 364
 365 <li>
 366 Many concepts and ideas were taken from
 367 <a href="http://cricket.sourceforge.net">Cricket</a>.
 368 <br>
 369 <font size="-1">
 370 Cricket is a widely used and very efficient network monitoring system.
 371 However, its limitations were actually the reason to start this project.
 372 </font>
 373 </li>
 374
 375 <li>
 376 Jake Brutlag.
 377 <a href="http://www.usenix.org/events/lisa2000/brutlag.html">
 378 Aberrant Behavior Detection in Time Series for Network Service Monitoring</a>.
 379 <br>
 380 LISA 2000 paper.
 381 <br>
 382 <font size="-1">
 383 The article gives the basic theory overview of Holt-Winters forecasting
 384 algorithm, and describes its implementation in RRDTool.
 385 </font>
 386 </li>
 387
 388 <li>
 389 Jake Brutlag.
 390 <a href="http://cricket.sourceforge.net/aberrant/rrd_hw.htm">
 391 Notes on RRDTOOL implementation of Aberrant Behavior Detection</a>.
 392 <br>
 393 <font size="-1">
 394 The article describes the implementation of
 395 aberrant behavior detection for RRDTOOL.
 396 </font>
 397 </li>
 398
 399 </ul>
 400
 401 <h2>Credits</h2>
 402
 403 <ul>
 404
 405 <li>
 406 Chris Amley. Xylan switches SNMP discovery
 407 </li>
 408
 409 <li>
 410 <a href="mailto:sbrooks@binary-solutions.net">Scott Brooks</a>.
 411 Atmel wireless devices SNMP discovery
 412 </li>
 413
 414 <li>
 415 <a href="mailto:abush@microcenter.com">Aaron Bush</a>.
 416 Contributed APC and HP vendor templates.
 417 </li>
 418
 419 <li>
 420 Shawn Ferry &lt;sferry at sevenspace.com&gt;
 421 &lt;lalartu at obscure.org&gt;.
 422 Many contributions in various parts.
 423 </li>
 424
 425 <li>
 426 <a href="mailto:mh+torrus@zugschlus.de">Marc Haber</a>.
 427 Lots of bug reports and architecture ideas.
 428 </li>
 429
 430 <li>
 431 <a href="mailto:roman@hochu.li">Roman Hochuli</a>.
 432 Bug reports and new feature ideas.
 433 Vendor templates for Ascend and DOCSIS.
 434 </li>
 435
 436 <li>
 437 <a href="mailto:ian@holsman.net">Ian Holsman</a>
 438 &lt;<a href="http://holsman.net">http://holsman.net</a>&gt;.
 439 Adapted the <a href="http://bluerobot.com">bluerobot.com</a>
 440 HTML layout design for Torrus.
 441 </li>
 442
 443 <li>
 444 <a href="mailto:tech@gordphilpott.com">Gord Philpott</a>.
 445 Numerous bug reports.
 446 </li>
 447
 448 <li>
 449 <a href="mailto:christian.schnidrig@gmx.ch">Christian Schnidrig</a>.
 450 Architecture ideas and interface improvements.
 451 </li>
 452
 453 <li>
 454 <a href="mailto:jurij@wooyd.org">Jurij Smakov</a>.
 455 Contributed in manpages creation. Maintainer of
 456 <a href="http://pkg-torrus.alioth.debian.org/">Torrus Debian package</a>
 457 </li>
 458
 459 <li>
 460 <a href="mailto:nistor@snickers.org">Jon Nistor</a>.
 461 Bug reports and contributions for JunOS, Cisco SCE and other vendors discovery.
 462 </li>
 463
 464
 465 </ul>
 466
 467 <h2>Companies using Torrus</h2>
 468
 469 <div class="Custlogos">
 470
 471 <a href="http://www.adtaq.com/">
 472 <img class="Custlogo"
 473 src="logo/adtaq.png" width="120" height="24"
 474 alt="Adtaq Internet, LLC, Coolocation service provider in Issaquah, WA, USA"/></a>
 475
 476 <a href="http://www.binarybroadband.com/">
 477 <img class="Custlogo"
 478 src="logo/binary_solutions.png" width="120" height="30"
 479 alt="Binary Solutions Ltd., wireless technology company, Canada"/></a>
 480
 481 <a href="http://www.bluewin.ch/">
 482 <img class="Custlogo"
 483 src="logo/bluewin.png" width="100" height="19"
 484 alt="Bluewin AG, large ADSL provider in Switzerland"/></a>
 485
 486 <a href="http://www.cablecom.ch/">
 487 <img class="Custlogo"
 488 src="logo/cablecom.png" width="100" height="57"
 489 alt="upc cablecom GmbH,
 490 largest cable TV and Internet provider in Switzerland"/></a>
 491
 492 <a href="http://www.fibrenoire.ca/">
 493 <img class="Custlogo"
 494 src="logo/fibrenoire.png" width="120" height="22"
 495 alt="Fibre Noire Internet Inc., a business service provider in Montreal, Canada"/></a>
 496
 497 <a href="http://www.gpstechnik.ch/">
 498 <img class="Custlogo"
 499 src="logo/gpstechnik.png" width="100" height="54"
 500 alt="GPS Technik AG, network solution provider in Switzerland"/></a>
 501
 502 <a href="http://www.gsid.net/">
 503 <img class="Custlogo"
 504 src="logo/gsid.png" width="96" height="55"
 505 alt=
 506 "GSID.net, an international hosting provider"/></a>
 507
 508 <a href="http://www.kfn-ag.ch/">
 509 <img class="Custlogo"
 510 src="logo/kfn.png" width="98" height="33"
 511 alt="Kabelfernsehen Nidwalden AG,
 512 cable TV and Internet provider in Switzerland"/></a>
 513
 514 <a href="http://www.nexellent.ch/">
 515 <img class="Custlogo"
 516 src="logo/nexellent.png" width="120" height="41"
 517 alt="Nexellent AG,
 518 Internet services and consulting company in Switzerland"/></a>
 519
 520 <a href="http://www.prioritycolo.com/">
 521 <img class="Custlogo"
 522 src="logo/prioritycolo.png" width="100" height="38"
 523 alt=
 524 "Priority Colo Inc., large colocation services provider, Toronto, Canada"/></a>
 525
 526 <a href="http://www.quicknet.ch/">
 527 <img class="Custlogo"
 528 src="logo/quicknet.png" width="100" height="30"
 529 alt="Kabelfernsehen Boedeli AG,
 530 cable TV and Internet provider in Interlaken, Switzerland"/></a>
 531
 532 <a href="http://www.sevenspace.com/">
 533 <img class="Custlogo"
 534 src="logo/sevenspace.png" width="140" height="28"
 535 alt="SevenSpace Inc., outsourcing services provider, U.S."/></a>
 536
 537 <a href="http://www.syscovery.com/">
 538 <img class="Custlogo"
 539 src="logo/syscovery.png" width="149" height="41"
 540 alt="syscovery AG, an IT services company, Germany"/></a>
 541
 542 <a href="http://www.torix.net/">
 543 <img class="Custlogo"
 544 src="logo/torix.png" width="100" height="29"
 545 alt=
 546 "TorIX, The Toronto Internet Exchange"/>
 547 </a>
 548
 549
 550 </div>
 551 <hr>
 552 <p>Copyright &copy; 2002-2007 Stanislav Sinyagin
 553 &lt;<a href="mailto:ssinyagin@yahoo.com">ssinyagin@yahoo.com</a>&gt;</p>
 554 <A href="http://sourceforge.net">
 555 <IMG src="http://sourceforge.net/sflogo.php?group_id=119282&amp;type=1"
 556  width="88" height="31" border="0" alt="SourceForge Logo">
 557 </A>
 558
 559
 560 </body>
 561 </html>