Administrator Handbook Table of contents version française LinkedIn social network LinkedIn social network LinkedIn social network LinkedIn social network Share on social media

RRD profile list XML configuration file description

The RRD_Profile.xml file contains the list of RRD profiles . A RRD profile describe the record number and type that a RRD database supports.

This list is updated with new profiles either from the RRD manager or from RRD collector. Profiles can be modified with the RRD Manager only.

The XML schema definition (RRD_Profile.xsd)

 

<RoundRobinDatabases> The main XML tag of the document
<Profile>

This tag defines one profile

DateCreation creation date
Author author of the RRD profile
Description Description of the RRD profile
<ProfileName> A name identifying the RRD profile
<DataBase> The tag enclosing RRD database parameter

<DataBase>

<StartTime> The start time is used to define that allowed time that the collected samples can have to be considered as valid.
<Step> Time interval of the database update (the polling time interval)
<Users>
<DB_User> The user is the plugin ID of the RRD collector that if filling tis database with data

<DataSource>

The tag defining one data source. A RRD database can contains multiple Data Source (DS)
<RoundRobinArchive> The tag defining one Round Robin Archive.. A RRD database can contains multiple Round Robin Archive (RRA)

<DataSource> The tag defining one data source(DS)

<DS_Name> The Data Source Name (should be unique)
<DataSourceType>

The type of data source

Gauge

Gauge is values that are moving between a minimum and a maximum. Gauge is used for things like temperatures, cpu utilization, disk space utilization, message queue utilization.

Counter Counter is for continuous incrementing counters like the InOctets counter in a router. The COUNTER data source assumes that the counter never decreases, except when a counter overflows. The update function takes the overflow into account. The counter is stored as a per-second rate. When the counter overflows, RRDTool checks if the overflow happened at the 32bit or 64bit border and acts accordingly by adding an appropriate value to the result.
Derive Derive will store the derivative of the line going from the last to the current value of the data source. This can be useful for gauges, for example, to measure the rate of people entering or leaving a room. Internally, derive works exactly like COUNTER but without overflow checks. So if your counter does not reset at 32 or 64 bit you might want to use DERIVE and combine it with a MIN value of 0.
Absolute Absolute is for counters which get reset upon reading. This is used for fast counters which tend to overflow. So instead of reading them normally you reset them after every read to make sure you have a maximal time available before the next overflow. Another usage is for things you count like number of messages since the last update.

 

<HeartBeat> Heartbeat defines the maximum number of seconds that may pass between two updates of a data source before the value of the data source is assumed to be *UNKNOWN*.
<MinValue> If MinValue is defined, any value under this minimum value will be regarded as *UNKNOWN*. Note that min and max always refer to the processed values of the DS. For a traffic-COUNTER type DS this would be the max and min data-rate expected from the device.
<MaxValue> If MaxValue is defined, any value upper this maximun value will be regarded as *UNKNOWN*. Note that min and max always refer to the processed values of the DS. For a traffic-COUNTER type DS this would be the max and min data-rate expected from the device.

<RoundRobinArchive>

<RRA_Name> The Round Robin ARchive Name
<ConsolidationFunction>

La fonction de consolidation a réalisé sur les valeurs collectées

Average Perform the arithmetical average of the collected values over the considered time period.
Min Keep the smallest values of the collected values over the considered time period.
Max Keep the Highest values of the collected values over the considered time period.
Last Keep the last collected value over the considered time period.
<xFileFactor>

The xfiles factor defines what part of a consolidation interval may be made up from *UNKNOWN* data while the consolidated value is still regarded as known.

<RRA_Step>

RRA_Step defines how many of these primary data points are used to build a consolidated data point which then goes into the archive.

<RRA_Rows>

RRA_Rows defines how many generations of data values are kept in an RRA

Example of profil automatically created by RRD Collector: 

<?xml version="1.0"?>
<
RoundRobinDatabases>
      <Profile DateCreation="Thursday, February 09, 2006" Author="489427ì514039619590" Description="Created by RRD Collector Plugin attached to host :LoriotPro IP address : 127_0_0_1">
            <ProfileName>P_LoriotPro-4894270514039619590</ProfileName>
            <DataBase>
                  <StartTime>1139536168</StartTime>
                  <Step>60</Step>
                  <Users>
                        <DB_User>LoriotPro-4894270514039619590</DB_User>
                  </Users>
                  <DataSource Description="Ping Round Trip Time, Host : LoriotPro, Packet size : 64, TTL: 32, Timeout: 4">
                        <DS_Name>DS0</DS_Name>
                        <DataSourceType>GAUGE</DataSourceType>
                        <HeartBeat>120</HeartBeat>
                        <MinValue></MinValue>
                        <MaxValue></MaxValue></DataSource>
                  <RoundRobinArchive Description="The last hour of collected data">
                        <RRA_Name>Last Hour</RRA_Name>
                        <ConsolidationFunction>AVERAGE</ConsolidationFunction>
                        <xFileFactor>0.5</xFileFactor>
                        <RRA_Step>1</RRA_Step>
                        <RRA_Rows>800</RRA_Rows></RoundRobinArchive>
                  <RoundRobinArchive Description="The last 24 hours of collected data">
                        <RRA_Name>Last Day</RRA_Name>
                        <ConsolidationFunction>AVERAGE</ConsolidationFunction>
                        <xFileFactor>0.5</xFileFactor>
                        <RRA_Step>4</RRA_Step>
                        <RRA_Rows>800</RRA_Rows></RoundRobinArchive>
                  <RoundRobinArchive Description="The last week of collected data">
                        <RRA_Name>Last Week</RRA_Name>
                        <ConsolidationFunction>AVERAGE</ConsolidationFunction>
                        <xFileFactor>0.5</xFileFactor>
                        <RRA_Step>28</RRA_Step>
                        <RRA_Rows>800</RRA_Rows></RoundRobinArchive>
                  <RoundRobinArchive Description="The last month of collected data">
                        <RRA_Name>Last Month</RRA_Name>
                        <ConsolidationFunction>AVERAGE</ConsolidationFunction>
                        <xFileFactor>0.5</xFileFactor>
                        <RRA_Step>112</RRA_Step>
                        <RRA_Rows>800</RRA_Rows>
                  </RoundRobinArchive>
            </DataBase>
      </Profile>
</RoundRobinDatabases>


www.loriotpro.com