Data coll graphing

From OpenNMS

Contents 1 Introduction 2 Standard Graphs 2.1 Top level properties 2.1.1 command.prefix 2.1.2 default.report 2.1.3 output.mime 2.1.4 reports 2.2 Per graph properties 2.2.1 name 2.2.2 columns 2.2.3 type 2.2.4 command

Introduction

Graphs can be configured in two places. Standard reports are configured in the snmp-graph.properties text file, where-as ad-hoc reports can be created through the web interface.

Standard Graphs

Standard graphs are configured in the snmp-graph.properties file. It is in the Java "properties" format, which consists of a set of name/value pairs. There are some "top level" properties that need to be configured, then a set of properties per graph, with names in the form of report.<graphname%gt;.<propertyname>

Top level properties

command.prefix

The generic command prefix (rrdtool) to use for all reports.

default.report

The default report to display if none is specified.

output.mime

The mime type that should be returned by to the browser.

reports

A comma separated list of the reports specified in the remainder of this file. All reports you wish to use must be listed in this property value. This is inevitably split across multiple lines using a backslash at the end of each line to indicate continuation, e.g.:

reports=mib2.HCbits, mib2.bits, mib2.percentdiscards, mib2.percenterrors, \
mib2.discards, mib2.errors, mib2.packets, \
mib2.tcpopen, mib2.tcpcurrent, mib2.tcperrs, mib2.tcpsegs

Per graph properties

There are 4 named attributes needed per report:

name

An arbitary name, for the use of humans only

columns

The data elements (from the RRD or JRB files) that are used as data for the graph.

type

One of:

1. nodeSNMP for node level data (e.g. memory usage),
2. interfaceSNMP for SNMP interface level data (e.g. ifInOctets, ifOutOctets), or
3. Some other "resourceType" as configured in the SNMP data collection, (e.g. hrStorageIndex)

command

An RRDTool format command to generate the graph. Tokens of the form {rrd<num>} are used in the DEF sections to refer to the columns defined for this graph, where <num> is a number indicating which entry in the columns attribute should be used. All the rest of the command is a single line rrdtool format command (using a backslash at the end of each line to indicate continuation). If your data is stored in JRobin format, this command will be translated automatically into a JRobin graph