4 * RRDTool Python binding
6 * Author : Hye-Shik Chang <perky@fallin.lv>
7 * Date : $Date: 2003/02/22 07:41:19 $
8 * Created : 23 May 2002
12 * ==========================================================================
13 * This file is part of py-rrdtool.
15 * py-rrdtool is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU Lesser General Public License as published
17 * by the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * py-rrdtool is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU Lesser General Public License for more details.
25 * You should have received a copy of the GNU Lesser General Public License
26 * along with Foobar; if not, write to the Free Software
27 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 #elif defined(__GNUC__)
33 # define UNUSED(x) x __attribute__((unused))
34 #elif defined(__LCLINT__)
35 # define UNUSED(x) /*@unused@*/ x
40 static const char *__version__ = "$Revision: 1.14 $";
43 #include "../../src/rrd_tool.h"
45 //#include "rrd_extra.h"
47 static PyObject *ErrorObject;
51 /* forward declaration to keep compiler happy */
55 static int create_args(
64 size = PyTuple_Size(args);
65 *argv = PyMem_New(char *,
71 for (i = 0; i < size; i++) {
72 o = PyTuple_GET_ITEM(args, i);
73 if (PyString_Check(o))
74 (*argv)[i + 1] = PyString_AS_STRING(o);
77 PyErr_Format(PyExc_TypeError, "argument %d must be string", i);
84 /* reset getopt state */
90 static void destroy_args(
97 static char PyRRD_create__doc__[] =
98 "create(args..): Set up a new Round Robin Database\n\
99 create filename [--start|-b start time] \
100 [--step|-s step] [DS:ds-name:DST:heartbeat:min:max] \
101 [RRA:CF:xff:steps:rows]";
103 static PyObject *PyRRD_create(
104 PyObject UNUSED(*self),
111 if (create_args("create", args, &argc, &argv) < 0)
114 if (rrd_create(argc, argv) == -1) {
115 PyErr_SetString(ErrorObject, rrd_get_error());
127 static char PyRRD_update__doc__[] =
128 "update(args..): Store a new set of values into the rrd\n"
129 " update filename [--template|-t ds-name[:ds-name]...] "
130 "N|timestamp:value[:value...] [timestamp:value[:value...] ...]";
132 static PyObject *PyRRD_update(
133 PyObject UNUSED(*self),
140 if (create_args("update", args, &argc, &argv) < 0)
143 if (rrd_update(argc, argv) == -1) {
144 PyErr_SetString(ErrorObject, rrd_get_error());
156 static char PyRRD_fetch__doc__[] =
157 "fetch(args..): fetch data from an rrd.\n"
158 " fetch filename CF [--resolution|-r resolution] "
159 "[--start|-s start] [--end|-e end]";
161 static PyObject *PyRRD_fetch(
162 PyObject UNUSED(*self),
166 rrd_value_t *data, *datai;
167 unsigned long step, ds_cnt;
170 char **argv, **ds_namv;
172 if (create_args("fetch", args, &argc, &argv) < 0)
175 if (rrd_fetch(argc, argv, &start, &end, &step,
176 &ds_cnt, &ds_namv, &data) == -1) {
177 PyErr_SetString(ErrorObject, rrd_get_error());
182 ((start, end, step), (name1, name2, ...), [(data1, data2, ..), ...]) */
183 PyObject *range_tup, *dsnam_tup, *data_list, *t;
184 unsigned long i, j, row;
187 row = ((end - start) / step + 1);
190 range_tup = PyTuple_New(3);
191 dsnam_tup = PyTuple_New(ds_cnt);
192 data_list = PyList_New(row);
193 PyTuple_SET_ITEM(r, 0, range_tup);
194 PyTuple_SET_ITEM(r, 1, dsnam_tup);
195 PyTuple_SET_ITEM(r, 2, data_list);
199 PyTuple_SET_ITEM(range_tup, 0, PyInt_FromLong((long) start));
200 PyTuple_SET_ITEM(range_tup, 1, PyInt_FromLong((long) end));
201 PyTuple_SET_ITEM(range_tup, 2, PyInt_FromLong((long) step));
203 for (i = 0; i < ds_cnt; i++)
204 PyTuple_SET_ITEM(dsnam_tup, i, PyString_FromString(ds_namv[i]));
206 for (i = 0; i < row; i++) {
207 t = PyTuple_New(ds_cnt);
208 PyList_SET_ITEM(data_list, i, t);
210 for (j = 0; j < ds_cnt; j++) {
213 PyTuple_SET_ITEM(t, j, Py_None);
216 PyTuple_SET_ITEM(t, j, PyFloat_FromDouble((double) dv));
221 for (i = 0; i < ds_cnt; i++)
222 rrd_freemem(ds_namv[i]);
223 rrd_freemem(ds_namv); /* rrdtool don't use PyMem_Malloc :) */
231 static char PyRRD_graph__doc__[] =
232 "graph(args..): Create a graph based on data from one or several RRD\n"
233 " graph filename [-s|--start seconds] "
234 "[-e|--end seconds] [-x|--x-grid x-axis grid and label] "
235 "[-y|--y-grid y-axis grid and label] [--alt-y-grid] [--alt-y-mrtg] "
236 "[--alt-autoscale] [--alt-autoscale-max] [--units-exponent] value "
237 "[-v|--vertical-label text] [-w|--width pixels] [-h|--height pixels] "
239 "[-f|--imginfo formatstring] [-a|--imgformat GIF|PNG|GD] "
240 "[-B|--background value] [-O|--overlay value] "
241 "[-U|--unit value] [-z|--lazy] [-o|--logarithmic] "
242 "[-u|--upper-limit value] [-l|--lower-limit value] "
243 "[-g|--no-legend] [-r|--rigid] [--step value] "
244 "[-b|--base value] [-c|--color COLORTAG#rrggbb] "
245 "[-t|--title title] [DEF:vname=rrd:ds-name:CF] "
246 "[CDEF:vname=rpn-expression] [PRINT:vname:CF:format] "
247 "[GPRINT:vname:CF:format] [COMMENT:text] "
248 "[HRULE:value#rrggbb[:legend]] [VRULE:time#rrggbb[:legend]] "
249 "[LINE{1|2|3}:vname[#rrggbb[:legend]]] "
250 "[AREA:vname[#rrggbb[:legend]]] " "[STACK:vname[#rrggbb[:legend]]]";
252 static PyObject *PyRRD_graph(
253 PyObject UNUSED(*self),
257 char **argv, **calcpr;
258 int argc, xsize, ysize, i;
261 if (create_args("graph", args, &argc, &argv) < 0)
264 if (rrd_graph(argc, argv, &calcpr, &xsize, &ysize, NULL, &ymin, &ymax) ==
266 PyErr_SetString(ErrorObject, rrd_get_error());
272 PyTuple_SET_ITEM(r, 0, PyInt_FromLong((long) xsize));
273 PyTuple_SET_ITEM(r, 1, PyInt_FromLong((long) ysize));
279 PyTuple_SET_ITEM(r, 2, e);
281 for (i = 0; calcpr[i]; i++) {
282 t = PyString_FromString(calcpr[i]);
285 rrd_freemem(calcpr[i]);
290 PyTuple_SET_ITEM(r, 2, Py_None);
298 static char PyRRD_tune__doc__[] =
299 "tune(args...): Modify some basic properties of a Round Robin Database\n"
300 " tune filename [--heartbeat|-h ds-name:heartbeat] "
301 "[--minimum|-i ds-name:min] [--maximum|-a ds-name:max] "
302 "[--data-source-type|-d ds-name:DST] [--data-source-rename|-r old-name:new-name]";
304 static PyObject *PyRRD_tune(
305 PyObject UNUSED(*self),
312 if (create_args("tune", args, &argc, &argv) < 0)
315 if (rrd_tune(argc, argv) == -1) {
316 PyErr_SetString(ErrorObject, rrd_get_error());
328 static char PyRRD_first__doc__[] =
329 "first(filename): Return the timestamp of the first data sample in an RRD";
331 static PyObject *PyRRD_first(
332 PyObject UNUSED(*self),
339 if (create_args("first", args, &argc, &argv) < 0)
342 if ((ts = rrd_first(argc, argv)) == -1) {
343 PyErr_SetString(ErrorObject, rrd_get_error());
347 r = PyInt_FromLong((long) ts);
353 static char PyRRD_last__doc__[] =
354 "last(filename): Return the timestamp of the last data sample in an RRD";
356 static PyObject *PyRRD_last(
357 PyObject UNUSED(*self),
364 if (create_args("last", args, &argc, &argv) < 0)
367 if ((ts = rrd_last(argc, argv)) == -1) {
368 PyErr_SetString(ErrorObject, rrd_get_error());
372 r = PyInt_FromLong((long) ts);
378 static char PyRRD_resize__doc__[] =
379 "resize(args...): alters the size of an RRA.\n"
380 " resize filename rra-num GROW|SHRINK rows";
382 static PyObject *PyRRD_resize(
383 PyObject UNUSED(*self),
390 if (create_args("resize", args, &argc, &argv) < 0)
393 if ((ts = rrd_resize(argc, argv)) == -1) {
394 PyErr_SetString(ErrorObject, rrd_get_error());
406 static PyObject *PyDict_FromInfo(
413 PyObject *val = NULL;
415 switch (data->type) {
417 val = isnan(data->value.u_val)
418 ? (Py_INCREF(Py_None), Py_None)
419 : PyFloat_FromDouble(data->value.u_val);
422 val = PyLong_FromUnsignedLong(data->value.u_cnt);
425 val = PyLong_FromLong(data->value.u_int);
428 val = PyString_FromString(data->value.u_str);
432 PyString_FromStringAndSize((char *) data->value.u_blo.ptr,
433 data->value.u_blo.size);
437 PyDict_SetItemString(r, data->key, val);
444 static char PyRRD_info__doc__[] =
445 "info(filename): extract header information from an rrd";
447 static PyObject *PyRRD_info(
448 PyObject UNUSED(*self),
456 if (create_args("info", args, &argc, &argv) < 0)
459 if ((data = rrd_info(argc, argv)) == NULL) {
460 PyErr_SetString(ErrorObject, rrd_get_error());
464 r = PyDict_FromInfo(data);
469 static char PyRRD_graphv__doc__[] =
470 "graphv is called in the same manner as graph";
472 static PyObject *PyRRD_graphv(
473 PyObject UNUSED(*self),
481 if (create_args("graphv", args, &argc, &argv) < 0)
484 if ((data = rrd_graph_v(argc, argv)) == NULL) {
485 PyErr_SetString(ErrorObject, rrd_get_error());
489 r = PyDict_FromInfo(data);
494 static char PyRRD_updatev__doc__[] =
495 "updatev is called in the same manner as update";
497 static PyObject *PyRRD_updatev(
498 PyObject UNUSED(*self),
506 if (create_args("updatev", args, &argc, &argv) < 0)
509 if ((data = rrd_update_v(argc, argv)) == NULL) {
510 PyErr_SetString(ErrorObject, rrd_get_error());
514 r = PyDict_FromInfo(data);
519 /* List of methods defined in the module */
520 #define meth(name, func, doc) {name, (PyCFunction)func, METH_VARARGS, doc}
522 static PyMethodDef _rrdtool_methods[] = {
523 meth("create", PyRRD_create, PyRRD_create__doc__),
524 meth("update", PyRRD_update, PyRRD_update__doc__),
525 meth("fetch", PyRRD_fetch, PyRRD_fetch__doc__),
526 meth("graph", PyRRD_graph, PyRRD_graph__doc__),
527 meth("tune", PyRRD_tune, PyRRD_tune__doc__),
528 meth("first", PyRRD_first, PyRRD_first__doc__),
529 meth("last", PyRRD_last, PyRRD_last__doc__),
530 meth("resize", PyRRD_resize, PyRRD_resize__doc__),
531 meth("info", PyRRD_info, PyRRD_info__doc__),
532 meth("graphv", PyRRD_graphv, PyRRD_graphv__doc__),
533 meth("updatev", PyRRD_updatev, PyRRD_updatev__doc__),
534 {NULL, NULL, 0, NULL}
537 #define SET_INTCONSTANT(dict, value) \
538 t = PyInt_FromLong((long)value); \
539 PyDict_SetItemString(dict, #value, t); \
541 #define SET_STRCONSTANT(dict, value) \
542 t = PyString_FromString(value); \
543 PyDict_SetItemString(dict, #value, t); \
546 /* Initialization function for the module */
552 /* Create the module and add the functions */
553 m = Py_InitModule("rrdtool", _rrdtool_methods);
555 /* Add some symbolic constants to the module */
556 d = PyModule_GetDict(m);
558 SET_STRCONSTANT(d, __version__);
559 ErrorObject = PyErr_NewException("rrdtool.error", NULL, NULL);
560 PyDict_SetItemString(d, "error", ErrorObject);
562 /* Check for errors */
563 if (PyErr_Occurred())
564 Py_FatalError("can't initialize the rrdtool module");
568 * $Id: _rrdtoolmodule.c,v 1.14 2003/02/22 07:41:19 perky Exp $