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 $";
44 #include "rrd_extra.h"
46 static PyObject *ErrorObject;
50 /* forward declaration to keep compiler happy */
54 static int create_args(
63 size = PyTuple_Size(args);
64 *argv = PyMem_New(char *,
70 for (i = 0; i < size; i++) {
71 o = PyTuple_GET_ITEM(args, i);
72 if (PyString_Check(o))
73 (*argv)[i + 1] = PyString_AS_STRING(o);
76 PyErr_Format(PyExc_TypeError, "argument %d must be string", i);
83 /* reset getopt state */
89 static void destroy_args(
96 static char PyRRD_create__doc__[] =
97 "create(args..): Set up a new Round Robin Database\n\
98 create filename [--start|-b start time] \
99 [--step|-s step] [DS:ds-name:DST:heartbeat:min:max] \
100 [RRA:CF:xff:steps:rows]";
102 static PyObject *PyRRD_create(
103 PyObject UNUSED(*self),
110 if (create_args("create", args, &argc, &argv) < 0)
113 if (rrd_create(argc, argv) == -1) {
114 PyErr_SetString(ErrorObject, rrd_get_error());
126 static char PyRRD_update__doc__[] =
127 "update(args..): Store a new set of values into the rrd\n"
128 " update filename [--template|-t ds-name[:ds-name]...] "
129 "N|timestamp:value[:value...] [timestamp:value[:value...] ...]";
131 static PyObject *PyRRD_update(
132 PyObject UNUSED(*self),
139 if (create_args("update", args, &argc, &argv) < 0)
142 if (rrd_update(argc, argv) == -1) {
143 PyErr_SetString(ErrorObject, rrd_get_error());
155 static char PyRRD_fetch__doc__[] =
156 "fetch(args..): fetch data from an rrd.\n"
157 " fetch filename CF [--resolution|-r resolution] "
158 "[--start|-s start] [--end|-e end]";
160 static PyObject *PyRRD_fetch(
161 PyObject UNUSED(*self),
165 rrd_value_t *data, *datai;
166 unsigned long step, ds_cnt;
169 char **argv, **ds_namv;
171 if (create_args("fetch", args, &argc, &argv) < 0)
174 if (rrd_fetch(argc, argv, &start, &end, &step,
175 &ds_cnt, &ds_namv, &data) == -1) {
176 PyErr_SetString(ErrorObject, rrd_get_error());
181 ((start, end, step), (name1, name2, ...), [(data1, data2, ..), ...]) */
182 PyObject *range_tup, *dsnam_tup, *data_list, *t;
183 unsigned long i, j, row;
186 row = ((end - start) / step + 1);
189 range_tup = PyTuple_New(3);
190 dsnam_tup = PyTuple_New(ds_cnt);
191 data_list = PyList_New(row);
192 PyTuple_SET_ITEM(r, 0, range_tup);
193 PyTuple_SET_ITEM(r, 1, dsnam_tup);
194 PyTuple_SET_ITEM(r, 2, data_list);
198 PyTuple_SET_ITEM(range_tup, 0, PyInt_FromLong((long) start));
199 PyTuple_SET_ITEM(range_tup, 1, PyInt_FromLong((long) end));
200 PyTuple_SET_ITEM(range_tup, 2, PyInt_FromLong((long) step));
202 for (i = 0; i < ds_cnt; i++)
203 PyTuple_SET_ITEM(dsnam_tup, i, PyString_FromString(ds_namv[i]));
205 for (i = 0; i < row; i++) {
206 t = PyTuple_New(ds_cnt);
207 PyList_SET_ITEM(data_list, i, t);
209 for (j = 0; j < ds_cnt; j++) {
212 PyTuple_SET_ITEM(t, j, Py_None);
215 PyTuple_SET_ITEM(t, j, PyFloat_FromDouble((double) dv));
220 for (i = 0; i < ds_cnt; i++)
222 free(ds_namv); /* rrdtool don't use PyMem_Malloc :) */
230 static char PyRRD_graph__doc__[] =
231 "graph(args..): Create a graph based on data from one or several RRD\n"
232 " graph filename [-s|--start seconds] "
233 "[-e|--end seconds] [-x|--x-grid x-axis grid and label] "
234 "[-y|--y-grid y-axis grid and label] [--alt-y-grid] [--alt-y-mrtg] "
235 "[--alt-autoscale] [--alt-autoscale-max] [--units-exponent] value "
236 "[-v|--vertical-label text] [-w|--width pixels] [-h|--height pixels] "
238 "[-f|--imginfo formatstring] [-a|--imgformat GIF|PNG|GD] "
239 "[-B|--background value] [-O|--overlay value] "
240 "[-U|--unit value] [-z|--lazy] [-o|--logarithmic] "
241 "[-u|--upper-limit value] [-l|--lower-limit value] "
242 "[-g|--no-legend] [-r|--rigid] [--step value] "
243 "[-b|--base value] [-c|--color COLORTAG#rrggbb] "
244 "[-t|--title title] [DEF:vname=rrd:ds-name:CF] "
245 "[CDEF:vname=rpn-expression] [PRINT:vname:CF:format] "
246 "[GPRINT:vname:CF:format] [COMMENT:text] "
247 "[HRULE:value#rrggbb[:legend]] [VRULE:time#rrggbb[:legend]] "
248 "[LINE{1|2|3}:vname[#rrggbb[:legend]]] "
249 "[AREA:vname[#rrggbb[:legend]]] " "[STACK:vname[#rrggbb[:legend]]]";
251 static PyObject *PyRRD_graph(
252 PyObject UNUSED(*self),
256 char **argv, **calcpr;
257 int argc, xsize, ysize, i;
260 if (create_args("graph", args, &argc, &argv) < 0)
263 if (rrd_graph(argc, argv, &calcpr, &xsize, &ysize, NULL, &ymin, &ymax) ==
265 PyErr_SetString(ErrorObject, rrd_get_error());
271 PyTuple_SET_ITEM(r, 0, PyInt_FromLong((long) xsize));
272 PyTuple_SET_ITEM(r, 1, PyInt_FromLong((long) ysize));
278 PyTuple_SET_ITEM(r, 2, e);
280 for (i = 0; calcpr[i]; i++) {
281 t = PyString_FromString(calcpr[i]);
289 PyTuple_SET_ITEM(r, 2, Py_None);
297 static char PyRRD_tune__doc__[] =
298 "tune(args...): Modify some basic properties of a Round Robin Database\n"
299 " tune filename [--heartbeat|-h ds-name:heartbeat] "
300 "[--minimum|-i ds-name:min] [--maximum|-a ds-name:max] "
301 "[--data-source-type|-d ds-name:DST] [--data-source-rename|-r old-name:new-name]";
303 static PyObject *PyRRD_tune(
304 PyObject UNUSED(*self),
311 if (create_args("tune", args, &argc, &argv) < 0)
314 if (rrd_tune(argc, argv) == -1) {
315 PyErr_SetString(ErrorObject, rrd_get_error());
327 static char PyRRD_first__doc__[] =
328 "first(filename): Return the timestamp of the first data sample in an RRD";
330 static PyObject *PyRRD_first(
331 PyObject UNUSED(*self),
338 if (create_args("first", args, &argc, &argv) < 0)
341 if ((ts = rrd_first(argc, argv)) == -1) {
342 PyErr_SetString(ErrorObject, rrd_get_error());
346 r = PyInt_FromLong((long) ts);
352 static char PyRRD_last__doc__[] =
353 "last(filename): Return the timestamp of the last data sample in an RRD";
355 static PyObject *PyRRD_last(
356 PyObject UNUSED(*self),
363 if (create_args("last", args, &argc, &argv) < 0)
366 if ((ts = rrd_last(argc, argv)) == -1) {
367 PyErr_SetString(ErrorObject, rrd_get_error());
371 r = PyInt_FromLong((long) ts);
377 static char PyRRD_resize__doc__[] =
378 "resize(args...): alters the size of an RRA.\n"
379 " resize filename rra-num GROW|SHRINK rows";
381 static PyObject *PyRRD_resize(
382 PyObject UNUSED(*self),
389 if (create_args("resize", args, &argc, &argv) < 0)
392 if ((ts = rrd_resize(argc, argv)) == -1) {
393 PyErr_SetString(ErrorObject, rrd_get_error());
405 static char PyRRD_info__doc__[] =
406 "info(filename): extract header information from an rrd";
408 static PyObject *PyRRD_info(
409 PyObject UNUSED(*self),
412 PyObject *r, *t, *ds;
418 if (!PyArg_ParseTuple(args, "s:info", &filename))
421 if (rrd_open(filename, &in_file, &rrd, RRD_READONLY) == -1) {
422 PyErr_SetString(ErrorObject, rrd_get_error());
428 #define DICTSET_STR(dict, name, value) \
429 t = PyString_FromString(value); \
430 PyDict_SetItemString(dict, name, t); \
433 #define DICTSET_CNT(dict, name, value) \
434 t = PyInt_FromLong((long)value); \
435 PyDict_SetItemString(dict, name, t); \
438 #define DICTSET_VAL(dict, name, value) \
439 t = isnan(value) ? (Py_INCREF(Py_None), Py_None) : \
440 PyFloat_FromDouble((double)value); \
441 PyDict_SetItemString(dict, name, t); \
446 DICTSET_STR(r, "filename", filename);
447 DICTSET_STR(r, "rrd_version", rrd.stat_head->version);
448 DICTSET_CNT(r, "step", rrd.stat_head->pdp_step);
449 DICTSET_CNT(r, "last_update", rrd.live_head->last_up);
452 PyDict_SetItemString(r, "ds", ds);
455 for (i = 0; i < rrd.stat_head->ds_cnt; i++) {
459 PyDict_SetItemString(ds, rrd.ds_def[i].ds_nam, d);
462 DICTSET_STR(d, "ds_name", rrd.ds_def[i].ds_nam);
463 DICTSET_STR(d, "type", rrd.ds_def[i].dst);
464 DICTSET_CNT(d, "minimal_heartbeat",
465 rrd.ds_def[i].par[DS_mrhb_cnt].u_cnt);
466 DICTSET_VAL(d, "min", rrd.ds_def[i].par[DS_min_val].u_val);
467 DICTSET_VAL(d, "max", rrd.ds_def[i].par[DS_max_val].u_val);
468 DICTSET_STR(d, "last_ds", rrd.pdp_prep[i].last_ds);
469 DICTSET_VAL(d, "value", rrd.pdp_prep[i].scratch[PDP_val].u_val);
470 DICTSET_CNT(d, "unknown_sec",
471 rrd.pdp_prep[i].scratch[PDP_unkn_sec_cnt].u_cnt);
474 ds = PyList_New(rrd.stat_head->rra_cnt);
475 PyDict_SetItemString(r, "rra", ds);
478 for (i = 0; i < rrd.stat_head->rra_cnt; i++) {
482 PyList_SET_ITEM(ds, i, d);
484 DICTSET_STR(d, "cf", rrd.rra_def[i].cf_nam);
485 DICTSET_CNT(d, "rows", rrd.rra_def[i].row_cnt);
486 DICTSET_CNT(d, "pdp_per_row", rrd.rra_def[i].pdp_cnt);
487 DICTSET_VAL(d, "xff", rrd.rra_def[i].par[RRA_cdp_xff_val].u_val);
489 cdp = PyList_New(rrd.stat_head->ds_cnt);
490 PyDict_SetItemString(d, "cdp_prep", cdp);
493 for (j = 0; j < rrd.stat_head->ds_cnt; j++) {
497 PyList_SET_ITEM(cdp, j, cdd);
499 DICTSET_VAL(cdd, "value",
500 rrd.cdp_prep[i * rrd.stat_head->ds_cnt +
501 j].scratch[CDP_val].u_val);
502 DICTSET_CNT(cdd, "unknown_datapoints",
503 rrd.cdp_prep[i * rrd.stat_head->ds_cnt +
504 j].scratch[CDP_unkn_pdp_cnt].u_cnt);
513 /* List of methods defined in the module */
514 #define meth(name, func, doc) {name, (PyCFunction)func, METH_VARARGS, doc}
516 static PyMethodDef _rrdtool_methods[] = {
517 meth("create", PyRRD_create, PyRRD_create__doc__),
518 meth("update", PyRRD_update, PyRRD_update__doc__),
519 meth("fetch", PyRRD_fetch, PyRRD_fetch__doc__),
520 meth("graph", PyRRD_graph, PyRRD_graph__doc__),
521 meth("tune", PyRRD_tune, PyRRD_tune__doc__),
522 meth("first", PyRRD_first, PyRRD_first__doc__),
523 meth("last", PyRRD_last, PyRRD_last__doc__),
524 meth("resize", PyRRD_resize, PyRRD_resize__doc__),
525 meth("info", PyRRD_info, PyRRD_info__doc__),
526 {NULL, NULL, 0, NULL}
529 #define SET_INTCONSTANT(dict, value) \
530 t = PyInt_FromLong((long)value); \
531 PyDict_SetItemString(dict, #value, t); \
533 #define SET_STRCONSTANT(dict, value) \
534 t = PyString_FromString(value); \
535 PyDict_SetItemString(dict, #value, t); \
538 /* Initialization function for the module */
544 /* Create the module and add the functions */
545 m = Py_InitModule("rrdtool", _rrdtool_methods);
547 /* Add some symbolic constants to the module */
548 d = PyModule_GetDict(m);
550 SET_STRCONSTANT(d, __version__);
551 ErrorObject = PyErr_NewException("rrdtool.error", NULL, NULL);
552 PyDict_SetItemString(d, "error", ErrorObject);
554 /* Check for errors */
555 if (PyErr_Occurred())
556 Py_FatalError("can't initialize the rrdtool module");
560 * $Id: _rrdtoolmodule.c,v 1.14 2003/02/22 07:41:19 perky Exp $