RRD description file

From GEANT2-JRA1 Wiki

Here we explain how to create your own XML file describing measurement data stored in RRD files. This configuration file is used by RRD Measurement Archive. Values necessary to change while describing the content of RRD archives are marked red. Values shown here are just for demonstration.

Do not change anything here. This is a file header: 

<?xml version="1.0" encoding="UTF-8"?>
<nmwg:store 
 xmlns="http://ggf.org/ns/nmwg/base/2.0/"
 xmlns:nmwg="http://ggf.org/ns/nmwg/base/2.0/"
 xmlns:netutil="http://ggf.org/ns/nmwg/characteristic/utilization/2.0/"
 xmlns:nmwgt="http://ggf.org/ns/nmwg/topology/2.0/">

Metadata section

Metadata section describes the interface. Each section has unique metadata and subject identifiers. For configuration simplicity start with number 1 incrementing id value each time you add next metadata/data block for next interfaces monitored. 

<nmwg:metadata id="meta1">
 <netutil:subject id="subj1">
  <nmwgt:interface>

Network element hostname. Can be a loopback interface name: 

  <nmwgt:hostName>router.domain.name</nmwgt:hostName>

Interface IPv4 address: 

  <nmwgt:ifAddress type="ipv4">10.1.1.1</nmwgt:ifAddress>

Interface name, as specified in the network element: 

  <nmwgt:ifName>if-1/0/0.0</nmwgt:ifName>

Textual description of interface for which data is collected: 

  <nmwgt:ifDescription>Interface between network A and network B</nmwgt:ifDescription>

Traffic direction. Two possibilities only: in or out: 

  <nmwgt:direction>in</nmwgt:direction>

Authentication realm to indicate who can access the RRD file. Not in use currently. You may enter your NREN name here: 

  <nmwgt:authRealm>NREN-public</nmwgt:authRealm>
 </nmwgt:interface>
</netutil:subject>

Measurement characteristic collected in the given RRD file: 

  <nmwg:parameters>
    <nmwg:parameter name="supportedEventType">utilization</nmwg:parameter>
  </nmwg:parameters>
</nmwg:metadata>

Data section

Data block references to above metadata section using metadataIdRef value. Make sure you reference to proper section. 

<nmwg:data id="data1" metadataIdRef="meta1">
<nmwg:key>
 <nmwg:parameters>

Path to RRD file storing characteristic described in metadata section: 

  <nmwg:parameter name="file">/path/to/rrd/file.rrd</nmwg:parameter>

Name of data source (DS) parameter as specified in RRD file and corresponding to the above traffic direction. One can extract it executing rrdtool info filename.rrd command on one's RRD measurement server: 

  <nmwg:parameter name="dataSource">ds0</nmwg:parameter>

Unit of data stored in RRD file: 

  <nmwg:parameter name="unit">bps</nmwg:parameter>

 </nmwg:parameters>
</nmwg:key>
</nmwg:data>


Following the above section are one or more of metadata/data block pairs describing other interfaces. Individual sections should have unique, consecutive identifiers (meta2/data2,..., metaN/dataN). 

<nmwg:metadata id="metaN">
...
</nmwg:metadata>
<nmwg:data id="dataN" metadataIdRef="metaN">
...
</nmwg:data>


End of file 

</nmwg:store>


[edit]

Big picture


<?xml version="1.0" encoding="UTF-8"?>
 
  <nmwg:store xmlns:nmwgt="http://ggf.org/ns/nmwg/topology/2.0/"
                      xmlns:nmwg="http://ggf.org/ns/nmwg/base/2.0/"
                      xmlns:netutil="http://ggf.org/ns/nmwg/characteristic/utilization/2.0/"
                      xmlns="http://ggf.org/ns/nmwg/base/2.0/">
 
    <nmwg:metadata id="meta1">
        <netutil:subject id="subj1">
            <nmwgt:interface>
                <nmwgt:hostName>router.domain.name</nmwgt:hostName>
                <nmwgt:ifAddress type="ipv4">10.1.1.1</nmwgt:ifAddress>
                <nmwgt:ifName>if-1/0/0.0</nmwgt:ifName>
                <nmwgt:ifDescription>Interface between network A and network B</nmwgt:ifDescription>
                <nmwgt:direction>in</nmwgt:direction>
                <nmwgt:authRealm>NREN-public</nmwgt:authRealm>
            </nmwgt:interface>
        </netutil:subject>
        <nmwg:parameters>
            <nmwg:parameter name="supportedEventType">utilization</nmwg:parameter>
        </nmwg:parameters>
    </nmwg:metadata>
 
    <nmwg:data id="data1" metadataIdRef="meta1">
        <nmwg:key>
            <nmwg:parameters>
                <nmwg:parameter name="file">/path/to/rrd/file.rrd</nmwg:parameter>
                <nmwg:parameter name="dataSource">ds0</nmwg:parameter>
                <nmwg:parameter name="unit">bps</nmwg:parameter>
            </nmwg:parameters>
        </nmwg:key>
    </nmwg:data>
 
  </nmwg:store>



Back to MA installation guide

Retrieved from "http://wiki.perfsonar.net/jra1-wiki/index.php/RRD_description_file"
Personal tools