python-rrdtool

Python bindings for RRDtool with a native C extension and an object-oriented way to work with Round Robin Databases. As of version 0.1.1, Python 2 and 3 is supported.

The bindings are based on the code of the original Python 2 bindings for rrdtool by Hye-Shik Chang.

Installation

In order to build the native C extension (which is an required step), you'll need librrd and its headers installed. Having rrdtool installed should be enough on most distributions.

The easy way to install is to use pip install rrdtool or easy_install rrdtool

In case you'd like to build the module on your own, you can obtain a copy of the repository and run python setup.py install in it's destination folder to build the native C extension as well as the RRD module.

Usage

You can either use the low-level rrdtool module (which offers almost the same functions as the old Python 2 bindings for rrdtool provided), or the RRDtool module, which represents a object-oriented interface to rrdtool.

Using the low-level rrdtool module

import rrdtool

# Create Round Robin Database
rrdtool.create('test.rrd', '--start', 'now', '--step', '300', 'RRA:AVERAGE:0.5:1:1200', 'DS:temp:GAUGE:600:-273:5000')

# Feed updates to the RRD
rrdtool.update('test.rrd', 'N:32')

Using the high-level RRDtool module

import RRDtool

# Create a Round Robin Database
rrd = RRDtool.create('test.rrd', '--start', 'now', '--step', '300', 'RRA:AVERAGE:0.5:1:1200', 'DS:temp:GAUGE:600:-273:5000')

# Update the RRD
rrd.update([(None, 32)])

# Create a graph from it
rrd.graph('test.png', '--end', 'now', '--start', 'end-5minutes', '--width', '400', 'DEF:ds0a=test.rrd:temp:AVERAGE', 'LINE1:ds0a#0000FF:"temperature\l"')

# Same, but keep data in memory.
imgdata = rrd.graph(None, '--end', 'now', '--start', 'end-5minutes', '--width', '400', 'DEF:ds0a=test.rrd:temp:AVERAGE', 'LINE1:ds0a#0000FF:"temperature\l"')

# You can also use file-like objects
from io import BytesIO
rrd.graph(io, ...)

Changes

0.1.1

Released 2013-12-19

• Added support for Python 2.7 (other 2.x versions might also work, but its not tested)
• Added dump command
• Fixed some issues regarding generating graphs with graphv on Python 3.3

Please note: The graph method in the object-oriented RRD class will now return a dict by default (as returned by graphv). Only if the output_file parameter is None, the actual graph image bytes are returned. Python 3.3 will return a bytes object whereas Python 2.x will return a str object.

0.1.0

Released 2012-09-17

• Initial release.
• Support for Python 3.x added
• Updated documentation strings (__doc__) for each of the rrdtool functions

Author

Christian Jurk commx@commx.ws

This binding was created because I am currently porting some existing Python 2 code to Python 3 and try to help the community by contributing a updated binding extension. Hope someone can benefit from it.

If you encounter any bugs (which I expected at time of writing this), please submit them in the issue tracker here on the project page on Github. Thank you.