Introduction
NHawk is an initiative to provide a thin, complete RRDtool provider for the .NET and Mono framework. The project goal is targeted at providing a C# interface to native RRDtool facilities through appropriate .NET / Mono object model semantics with the intent of retaining an intuitive syntax that fits naturally into the .NET / Mono paradigm and closely resembles that of native RRDtool. In doing so, NHawk seeks to provide a powerful time series analysis toolkit library that fills a big void in the .NET and Mono framework. It is our hope to provide a toolkit that promotes high productively, robustness, and expressiveness; enabling proficient C# developers to build code interchangeably (and intuitively) with native RRDtool script. It is a NHawk goal to promote productive use by allowing clients to refer solely to native RRDtool documentation resources, and thereby carry a very short learning curve (in most cases, if the developer is familiar with both RRDtool and C#). The example code snippets that follow will hopefully illustrate the basic concepts. Please make particular note of syntactic similarities, and pay special attention to the section highlighting serialization, deserialization, and deepcloning, as these comprise powerful architectural utility which include support for web service oriented applications as well as for generation of, and interoperation with existing (native) RRDtool scripts.
Background
The examples that follow are taken from an expanded tutorial which has been included along with the version 1.0 release of the source code and binaries.
Please note that the example material that follows is derived from a tutorial created initially by: Alex van den Bogaerdt alex@ergens.op.het.net which can be viewed at http://oss.oetiker.ch/rrdtool/tut/rrdtutorial.en.html.
RRDtool is written by Tobias Oetiker tobi@oetiker.ch and can be found at http://oss.oetiker.ch/rrdtool/index.en.html.
*** See the end of this document for contact details and information pertaining to development and status of the current code revision. ***
Using the Code
RRDtool Syntax for Defining and Creating RRDs
rrdtool create test.rrd --start 920804400
DS:speed:COUNTER:600:U:U
RRA:AVERAGE:0.5:1:24
RRA:AVERAGE:0.5:6:10
NHawk (C#) Syntax for Defining and Creating RRDs
RRD rrd1 = new RRD("test.rrd", 920804400);
rrd1.addDS(new DS("speed", DS.TYPE.COUNTER, 600, DS.U, DS.U));
rrd1.addRRA(new RRA(RRA.CF.AVERAGE, 0.5, 1, 24));
rrd1.addRRA(new RRA(RRA.CF.AVERAGE, 0.5, 6, 10));
rrd1.create(true);
RRDtool Update Syntax
rrdtool update test.rrd 920804700:12345
NHawk (C#) Update Syntax
NHawk provides a means to update an RRD by packing expected DS (data source) arguments into an array of type object or string. One of the following C# method overloads should be used.
Note: The version with type object is explicitly casted (internally) to string as the update command is serialized and sent to rrdtool for processing. The intent is to save you from having to explicitly cast (whenever possible). When not possible, you'll have use the string version. Aside from that, both methods are equivalent.
rrd1.update(920804700, new object[] { 12345 });
rrd1.update(920804700, new string[] { “12345” });
string[] args = new string[1];
args[0] = “12345”;
rrd1.update(920804700, args);
The (current) serialized update string can be retrieved by calling: “rrd1.CurrentUpdateStr” as in the example below:
Console.WriteLine("{0}", rrd1.CurrentUpdateStr);
Resulting in the following console output…
rrdtool update test.rrd 920804700:12345
Note: “CurrentUpdateStr” should be called after each call to “rrd1.update(…)” because serialization is done there.
RRDtool Graph Syntax
rrdtool graph speed4.png
--start 920804400 --end 920808000
--vertical-label km/h
DEF:myspeed=test.rrd:speed:AVERAGE
"CDEF:kmh=myspeed,3600,*"
CDEF:fast=kmh,100,GT,100,0,IF
CDEF:over=kmh,100,GT,kmh,100,-,0,IF
CDEF:good=kmh,100,GT,0,kmh,IF
HRULE:100#0000FF:"Maximum allowed"
AREA:good#00FF00:"Good speed"
AREA:fast#550000:"Too fast"
STACK:over#FF0000:"Over speed"
NHawk(C#) Syntax Graph Syntax
GRAPH gr4 = new GRAPH("speed4.png", "920804400", "920808000");
gr4.yaxislabel = "km/h";
gr4.addDEF(new DEF("myspeed", rrd1, "speed", RRA.CF.AVERAGE));
gr4.addCDEF(new CDEF("kmh", "myspeed,3600,*"));
gr4.addCDEF(new CDEF("fast", "kmh,100,GT,kmh,0,IF"));
gr4.addCDEF(new CDEF("over", "kmh,100,GT,kmh,100,-,0,IF"));
gr4.addCDEF(new CDEF("good", "kmh,100,GT,0,kmh,IF"));
gr4.addGELEM(new HRULE("100", Color.Blue, "Maximum allowed"));
gr4.addGELEM(new AREA("good", Color.Green, "Good speed"));
gr4.addGELEM(new AREA("fast", Color.Brown, "Too fast"));
gr4.addGELEM(new AREA("over", Color.Red, "Over speed",true));
gr4.graph();
Note: The NHAWK code line:
gr4.addGELEM(new AREA("over", Color.Red, "Over speed",true));
is semantically equivalent to:
STACK:over#FF0000:"Over speed"
NHAWK is using the newer syntactic constructs, as the STACK construct as a direct graphing element is deprecated as of RRDTool 1.3.
Architectural Features: Serialization and Deserialization and Deepcloning
All NHAWK constructs are built as composite structures, in which a contract states that each construct must be able to serialize, deserialize, and deepclone itself (see the UML architecture diagram available with the source download). In other words, a higher level construct (such as the GRAPH class) would serialize itself by asking all of its composed constructs to serialize themselves. This is a powerful feature in that it opens up a whole new level of functionality. This includes the generation and interoperation with (native) RRDTool script, as well as ease of use with service orientated architectures such as web service applications. Below we illustrate with an example for the GRAPH class.
GRAPH gr5 = new GRAPH(gr4.ToString(), ".\\");
Console.WriteLine("{0}", gr5.ToString());
The above code snippet performs the following operations:
graph object g4 is serialized and passed to the GRAPH class deserialization (promotion) constructor. graph object g5 is instantiated by deserialing the serialized (string) form of object g4. - object
g5 is serialized and written to the console as shown below…
graph speed4.png --start 920804400 --end 920808000
--vertical-label "km/h"
DEF:myspeed=test.rrd:speed:AVERAGE
CDEF:kmh=myspeed,3600,*
CDEF:fast=kmh,100,GT,kmh,0,IF
CDEF:over=kmh,100,GT,kmh,100,-,0,IF
CDEF:good=kmh,100,GT,0,kmh,IF
HRULE:100#0000FF:"Maximum allowed"
AREA:good#008000:"Good speed"
AREA:fast#A52A2A:"Too fast"
AREA:over#FF0000:"Over speed"
DeepCloning and Why NHawk Has It
GRAPH gr6 = GRAPH.DeepClone(gr5);
Console.WriteLine("\n{0}", gr6.ToString());
Above object gr6 is a (new memory) copy of gr5. Essentially, NHawk is really just a whole load of parsing, and therefore every aggregated class member is either a string or a value type. Value types are deep copied by default, and although string is a reference type, NHawk uses temporary StringBuilders to return newly constructed (new memory) string objects. This could prove useful in many circumstances as it provides for limited preservation of object identity in a object model (shallow reference) which works on premise of not having object identity. Finally, just for completeness, the below code snippet illustrates the usual shallow copy.
GRAPH gr7 = gr6;
Current Code Base Progress: Revision: 1.0
DEF (Graph Definitions) == 100%
CDEF (Graph Calc Definitions) == 100%
RRD (Defining, creating, and loading existing Round Robin Database files).
DS (data source) == 100%
RRA (round robin archives) == 100%
GRAPHING ELEMENTS
LINE == 100%
AREA == 100%
VRULE == 100%
HRULE == 100%
SHIFT == 100%
GRAPH == 90% (approx. needs VDEF, PRINT Elements)
Current TODO List (for features I plan to implement next).
Timeline: 2-4 weeks. Note: Once the list below is completed, tested and added what’s already be done, then the vast majority of the major rrdtool features will be complete. This is a very do-able project.
- VDEF
- PRINT Elements
- RRDFetch
Compilation Instructions and Library Usage
See the user manual included with the source download.
Getting Started
For a quick start, see the tutorial (included with the source) located in: "NHawk\tutorials\rrdtutorial.en.html".
The source code can be compiled and executed from folder: "NHawk\tutorials\rrdtutorial1_code".
RRDtool can be downloaded from http://oss.oetiker.ch/rrdtool/pub/.
A good site for Windows and Netware Binaries is http://www.gknw.net/mirror/rrdtool/
(latest == rrdtool-1.2.28-bin-w32.zip).
Author Contact Details
Michael Corley
mwcorley79@gmail.com
History
- 22 August 08 -- Posted revision 1.0
- 26 May 2010 -- No new features yet... fixed CLS compliancy issue
