2 * collectd - src/pyvalues.c
3 * Copyright (C) 2009 Sven Trenkel
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Sven Trenkel <collectd at semidefinite.de>
28 #include <structmember.h>
35 #define FreeAll() do {\
37 PyMem_Free(plugin_instance);\
38 PyMem_Free(type_instance);\
43 static PyObject *cpy_common_repr(PyObject *s) {
45 static PyObject *l_type = NULL, *l_type_instance = NULL, *l_plugin = NULL, *l_plugin_instance = NULL;
46 static PyObject *l_host = NULL, *l_time = NULL;
47 PluginData *self = (PluginData *) s;
50 l_type = cpy_string_to_unicode_or_bytes("(type=");
51 if (l_type_instance == NULL)
52 l_type_instance = cpy_string_to_unicode_or_bytes(",type_instance=");
54 l_plugin = cpy_string_to_unicode_or_bytes(",plugin=");
55 if (l_plugin_instance == NULL)
56 l_plugin_instance = cpy_string_to_unicode_or_bytes(",plugin_instance=");
58 l_host = cpy_string_to_unicode_or_bytes(",host=");
60 l_time = cpy_string_to_unicode_or_bytes(",time=");
62 if (!l_type || !l_type_instance || !l_plugin || !l_plugin_instance || !l_host || !l_time)
65 ret = cpy_string_to_unicode_or_bytes(s->ob_type->tp_name);
67 CPY_STRCAT(&ret, l_type);
68 tmp = cpy_string_to_unicode_or_bytes(self->type);
69 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
70 CPY_STRCAT_AND_DEL(&ret, tmp);
72 if (self->type_instance[0] != 0) {
73 CPY_STRCAT(&ret, l_type_instance);
74 tmp = cpy_string_to_unicode_or_bytes(self->type_instance);
75 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
76 CPY_STRCAT_AND_DEL(&ret, tmp);
79 if (self->plugin[0] != 0) {
80 CPY_STRCAT(&ret, l_plugin);
81 tmp = cpy_string_to_unicode_or_bytes(self->plugin);
82 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
83 CPY_STRCAT_AND_DEL(&ret, tmp);
86 if (self->plugin_instance[0] != 0) {
87 CPY_STRCAT(&ret, l_plugin_instance);
88 tmp = cpy_string_to_unicode_or_bytes(self->plugin_instance);
89 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
90 CPY_STRCAT_AND_DEL(&ret, tmp);
93 if (self->host[0] != 0) {
94 CPY_STRCAT(&ret, l_host);
95 tmp = cpy_string_to_unicode_or_bytes(self->host);
96 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
97 CPY_STRCAT_AND_DEL(&ret, tmp);
100 if (self->time != 0) {
101 CPY_STRCAT(&ret, l_time);
102 tmp = PyFloat_FromDouble(self->time);
103 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
104 CPY_STRCAT_AND_DEL(&ret, tmp);
109 static char time_doc[] = "This is the Unix timestap of the time this value was read.\n"
110 "For dispatching values this can be set to 0 which means \"now\".\n"
111 "This means the time the value is actually dispatched, not the time\n"
114 static char host_doc[] = "The hostname of the host this value was read from.\n"
115 "For dispatching this can be set to an empty string which means\n"
116 "the local hostname as defined in the collectd.conf.";
118 static char type_doc[] = "The type of this value. This type has to be defined\n"
119 "in your types.db. Attempting to set it to any other value will\n"
120 "raise a TypeError exception.\n"
121 "Assigning a type is mandetory, calling dispatch without doing\n"
122 "so will raise a RuntimeError exception.";
124 static char type_instance_doc[] = "";
126 static char plugin_doc[] = "The name of the plugin that read the data. Setting this\n"
127 "member to an empty string will insert \"python\" upon dispatching.";
129 static char plugin_instance_doc[] = "";
131 static char PluginData_doc[] = "This is an internal class that is the base for Values\n"
132 "and Notification. It is pretty useless by itself and was therefore not\n"
133 "exported to the collectd module.";
135 static PyObject *PluginData_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {
138 self = (PluginData *) type->tp_alloc(type, 0);
145 self->plugin_instance[0] = 0;
147 self->type_instance[0] = 0;
148 return (PyObject *) self;
151 static int PluginData_init(PyObject *s, PyObject *args, PyObject *kwds) {
152 PluginData *self = (PluginData *) s;
154 char *type = NULL, *plugin_instance = NULL, *type_instance = NULL, *plugin = NULL, *host = NULL;
155 static char *kwlist[] = {"type", "plugin_instance", "type_instance",
156 "plugin", "host", "time", NULL};
158 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|etetetetetd", kwlist, NULL, &type,
159 NULL, &plugin_instance, NULL, &type_instance, NULL, &plugin, NULL, &host, &time))
162 if (type && plugin_get_ds(type) == NULL) {
163 PyErr_Format(PyExc_TypeError, "Dataset %s not found", type);
168 sstrncpy(self->host, host ? host : "", sizeof(self->host));
169 sstrncpy(self->plugin, plugin ? plugin : "", sizeof(self->plugin));
170 sstrncpy(self->plugin_instance, plugin_instance ? plugin_instance : "", sizeof(self->plugin_instance));
171 sstrncpy(self->type, type ? type : "", sizeof(self->type));
172 sstrncpy(self->type_instance, type_instance ? type_instance : "", sizeof(self->type_instance));
180 static PyObject *PluginData_repr(PyObject *s) {
182 static PyObject *l_closing = NULL;
184 if (l_closing == NULL)
185 l_closing = cpy_string_to_unicode_or_bytes(")");
187 if (l_closing == NULL)
190 ret = cpy_common_repr(s);
191 CPY_STRCAT(&ret, l_closing);
195 static PyMemberDef PluginData_members[] = {
196 {"time", T_DOUBLE, offsetof(PluginData, time), 0, time_doc},
200 static PyObject *PluginData_getstring(PyObject *self, void *data) {
201 const char *value = ((char *) self) + (intptr_t) data;
203 return cpy_string_to_unicode_or_bytes(value);
206 static int PluginData_setstring(PyObject *self, PyObject *value, void *data) {
211 PyErr_SetString(PyExc_TypeError, "Cannot delete this attribute");
215 new = cpy_unicode_or_bytes_to_string(&value);
220 old = ((char *) self) + (intptr_t) data;
221 sstrncpy(old, new, DATA_MAX_NAME_LEN);
226 static int PluginData_settype(PyObject *self, PyObject *value, void *data) {
231 PyErr_SetString(PyExc_TypeError, "Cannot delete this attribute");
235 new = cpy_unicode_or_bytes_to_string(&value);
241 if (plugin_get_ds(new) == NULL) {
242 PyErr_Format(PyExc_TypeError, "Dataset %s not found", new);
247 old = ((char *) self) + (intptr_t) data;
248 sstrncpy(old, new, DATA_MAX_NAME_LEN);
253 static PyGetSetDef PluginData_getseters[] = {
254 {"host", PluginData_getstring, PluginData_setstring, host_doc, (void *) offsetof(PluginData, host)},
255 {"plugin", PluginData_getstring, PluginData_setstring, plugin_doc, (void *) offsetof(PluginData, plugin)},
256 {"plugin_instance", PluginData_getstring, PluginData_setstring, plugin_instance_doc, (void *) offsetof(PluginData, plugin_instance)},
257 {"type_instance", PluginData_getstring, PluginData_setstring, type_instance_doc, (void *) offsetof(PluginData, type_instance)},
258 {"type", PluginData_getstring, PluginData_settype, type_doc, (void *) offsetof(PluginData, type)},
262 PyTypeObject PluginDataType = {
264 "collectd.PluginData", /* tp_name */
265 sizeof(PluginData), /* tp_basicsize */
266 0, /* Will be filled in later */
272 PluginData_repr, /* tp_repr */
273 0, /* tp_as_number */
274 0, /* tp_as_sequence */
275 0, /* tp_as_mapping */
281 0, /* tp_as_buffer */
282 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE /*| Py_TPFLAGS_HAVE_GC*/, /*tp_flags*/
283 PluginData_doc, /* tp_doc */
286 0, /* tp_richcompare */
287 0, /* tp_weaklistoffset */
291 PluginData_members, /* tp_members */
292 PluginData_getseters, /* tp_getset */
295 0, /* tp_descr_get */
296 0, /* tp_descr_set */
297 0, /* tp_dictoffset */
298 PluginData_init, /* tp_init */
300 PluginData_new /* tp_new */
303 static char interval_doc[] = "The interval is the timespan in seconds between two submits for\n"
304 "the same data source. This value has to be a positive integer, so you can't\n"
305 "submit more than one value per second. If this member is set to a\n"
306 "non-positive value, the default value as specified in the config file will\n"
307 "be used (default: 10).\n"
309 "If you submit values more often than the specified interval, the average\n"
310 "will be used. If you submit less values, your graphs will have gaps.";
312 static char values_doc[] = "These are the actual values that get dispatched to collectd.\n"
313 "It has to be a sequence (a tuple or list) of numbers.\n"
314 "The size of the sequence and the type of its content depend on the type\n"
315 "member your types.db file. For more information on this read the types.db\n"
318 "If the sequence does not have the correct size upon dispatch a RuntimeError\n"
319 "exception will be raised. If the content of the sequence is not a number,\n"
320 "a TypeError exception will be raised.";
322 static char meta_doc[] = "These are the meta data for this Value object.\n"
323 "It has to be a dictionary of numbers, strings or bools. All keys must be\n"
324 "strings. int and long objects will be dispatched as signed integers unless\n"
325 "they are between 2**63 and 2**64-1, which will result in a unsigned integer.\n"
326 "You can force one of these storage classes by using the classes\n"
327 "collectd.Signed and collectd.Unsigned. A meta object received by a write\n"
328 "callback will always contain Signed or Unsigned objects.";
330 static char dispatch_doc[] = "dispatch([type][, values][, plugin_instance][, type_instance]"
331 "[, plugin][, host][, time][, interval]) -> None. Dispatch a value list.\n"
333 "Dispatch this instance to the collectd process. The object has members\n"
334 "for each of the possible arguments for this method. For a detailed explanation\n"
335 "of these parameters see the member of the same same.\n"
337 "If you do not submit a parameter the value saved in its member will be submitted.\n"
338 "If you do provide a parameter it will be used instead, without altering the member.";
340 static char write_doc[] = "write([destination][, type][, values][, plugin_instance][, type_instance]"
341 "[, plugin][, host][, time][, interval]) -> None. Dispatch a value list.\n"
343 "Write this instance to a single plugin or all plugins if 'destination' is obmitted.\n"
344 "This will bypass the main collectd process and all filtering and caching.\n"
345 "Other than that it works similar to 'dispatch'. In most cases 'dispatch' should be\n"
346 "used instead of 'write'.\n";
348 static char Values_doc[] = "A Values object used for dispatching values to collectd and receiving values from write callbacks.";
350 static PyObject *Values_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {
353 self = (Values *) PluginData_new(type, args, kwds);
357 self->values = PyList_New(0);
358 self->meta = PyDict_New();
360 return (PyObject *) self;
363 static int Values_init(PyObject *s, PyObject *args, PyObject *kwds) {
364 Values *self = (Values *) s;
365 double interval = 0, time = 0;
366 PyObject *values = NULL, *meta = NULL, *tmp;
367 char *type = NULL, *plugin_instance = NULL, *type_instance = NULL, *plugin = NULL, *host = NULL;
368 static char *kwlist[] = {"type", "values", "plugin_instance", "type_instance",
369 "plugin", "host", "time", "interval", "meta", NULL};
371 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|etOetetetetddO", kwlist,
372 NULL, &type, &values, NULL, &plugin_instance, NULL, &type_instance,
373 NULL, &plugin, NULL, &host, &time, &interval, &meta))
376 if (type && plugin_get_ds(type) == NULL) {
377 PyErr_Format(PyExc_TypeError, "Dataset %s not found", type);
382 sstrncpy(self->data.host, host ? host : "", sizeof(self->data.host));
383 sstrncpy(self->data.plugin, plugin ? plugin : "", sizeof(self->data.plugin));
384 sstrncpy(self->data.plugin_instance, plugin_instance ? plugin_instance : "", sizeof(self->data.plugin_instance));
385 sstrncpy(self->data.type, type ? type : "", sizeof(self->data.type));
386 sstrncpy(self->data.type_instance, type_instance ? type_instance : "", sizeof(self->data.type_instance));
387 self->data.time = time;
391 if (values == NULL) {
392 values = PyList_New(0);
406 self->values = values;
413 self->interval = interval;
417 static meta_data_t *cpy_build_meta(PyObject *meta) {
419 meta_data_t *m = NULL;
425 l = PyDict_Items(meta); /* New reference. */
427 cpy_log_exception("building meta data");
430 m = meta_data_create();
432 for (i = 0; i < s; ++i) {
433 const char *string, *keystring;
434 PyObject *key, *value, *item, *tmp;
436 item = PyList_GET_ITEM(l, i);
437 key = PyTuple_GET_ITEM(item, 0);
439 keystring = cpy_unicode_or_bytes_to_string(&key);
445 value = PyTuple_GET_ITEM(item, 1);
447 if (value == Py_True) {
448 meta_data_add_boolean(m, keystring, 1);
449 } else if (value == Py_False) {
450 meta_data_add_boolean(m, keystring, 0);
451 } else if (PyFloat_Check(value)) {
452 meta_data_add_double(m, keystring, PyFloat_AsDouble(value));
453 } else if (PyObject_TypeCheck(value, &SignedType)) {
455 lli = PyLong_AsLongLong(value);
456 if (!PyErr_Occurred() && (lli == (int64_t) lli))
457 meta_data_add_signed_int(m, keystring, lli);
458 } else if (PyObject_TypeCheck(value, &UnsignedType)) {
459 long long unsigned llu;
460 llu = PyLong_AsUnsignedLongLong(value);
461 if (!PyErr_Occurred() && (llu == (uint64_t) llu))
462 meta_data_add_unsigned_int(m, keystring, llu);
463 } else if (PyNumber_Check(value)) {
465 long long unsigned llu;
466 tmp = PyNumber_Long(value);
467 lli = PyLong_AsLongLong(tmp);
468 if (!PyErr_Occurred() && (lli == (int64_t) lli)) {
469 meta_data_add_signed_int(m, keystring, lli);
472 llu = PyLong_AsUnsignedLongLong(tmp);
473 if (!PyErr_Occurred() && (llu == (uint64_t) llu))
474 meta_data_add_unsigned_int(m, keystring, llu);
478 string = cpy_unicode_or_bytes_to_string(&value);
480 meta_data_add_string(m, keystring, string);
483 tmp = PyObject_Str(value);
484 string = cpy_unicode_or_bytes_to_string(&tmp);
486 meta_data_add_string(m, keystring, string);
490 if (PyErr_Occurred())
491 cpy_log_exception("building meta data");
499 static PyObject *Values_dispatch(Values *self, PyObject *args, PyObject *kwds) {
501 const data_set_t *ds;
504 value_list_t value_list = VALUE_LIST_INIT;
505 PyObject *values = self->values, *meta = self->meta;
506 double time = self->data.time, interval = self->interval;
507 char *host = NULL, *plugin = NULL, *plugin_instance = NULL, *type = NULL, *type_instance = NULL;
509 static char *kwlist[] = {"type", "values", "plugin_instance", "type_instance",
510 "plugin", "host", "time", "interval", "meta", NULL};
511 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|etOetetetetddO", kwlist,
512 NULL, &type, &values, NULL, &plugin_instance, NULL, &type_instance,
513 NULL, &plugin, NULL, &host, &time, &interval, &meta))
516 sstrncpy(value_list.host, host ? host : self->data.host, sizeof(value_list.host));
517 sstrncpy(value_list.plugin, plugin ? plugin : self->data.plugin, sizeof(value_list.plugin));
518 sstrncpy(value_list.plugin_instance, plugin_instance ? plugin_instance : self->data.plugin_instance, sizeof(value_list.plugin_instance));
519 sstrncpy(value_list.type, type ? type : self->data.type, sizeof(value_list.type));
520 sstrncpy(value_list.type_instance, type_instance ? type_instance : self->data.type_instance, sizeof(value_list.type_instance));
522 if (value_list.type[0] == 0) {
523 PyErr_SetString(PyExc_RuntimeError, "type not set");
527 ds = plugin_get_ds(value_list.type);
529 PyErr_Format(PyExc_TypeError, "Dataset %s not found", value_list.type);
532 if (values == NULL || (PyTuple_Check(values) == 0 && PyList_Check(values) == 0)) {
533 PyErr_Format(PyExc_TypeError, "values must be list or tuple");
536 if (meta != NULL && meta != Py_None && !PyDict_Check(meta)) {
537 PyErr_Format(PyExc_TypeError, "meta must be a dict");
540 size = (int) PySequence_Length(values);
541 if (size != ds->ds_num) {
542 PyErr_Format(PyExc_RuntimeError, "type %s needs %d values, got %i", value_list.type, ds->ds_num, size);
545 value = malloc(size * sizeof(*value));
546 for (i = 0; i < size; ++i) {
547 PyObject *item, *num;
548 item = PySequence_Fast_GET_ITEM(values, i); /* Borrowed reference. */
549 if (ds->ds->type == DS_TYPE_COUNTER) {
550 num = PyNumber_Long(item); /* New reference. */
552 value[i].counter = PyLong_AsUnsignedLongLong(num);
555 } else if (ds->ds->type == DS_TYPE_GAUGE) {
556 num = PyNumber_Float(item); /* New reference. */
558 value[i].gauge = PyFloat_AsDouble(num);
561 } else if (ds->ds->type == DS_TYPE_DERIVE) {
562 /* This might overflow without raising an exception.
563 * Not much we can do about it */
564 num = PyNumber_Long(item); /* New reference. */
566 value[i].derive = PyLong_AsLongLong(num);
569 } else if (ds->ds->type == DS_TYPE_ABSOLUTE) {
570 /* This might overflow without raising an exception.
571 * Not much we can do about it */
572 num = PyNumber_Long(item); /* New reference. */
574 value[i].absolute = PyLong_AsUnsignedLongLong(num);
579 PyErr_Format(PyExc_RuntimeError, "unknown data type %d for %s", ds->ds->type, value_list.type);
582 if (PyErr_Occurred() != NULL) {
587 value_list.values = value;
588 value_list.meta = cpy_build_meta(meta);
589 value_list.values_len = size;
590 value_list.time = DOUBLE_TO_CDTIME_T(time);
591 value_list.interval = DOUBLE_TO_CDTIME_T(interval);
592 if (value_list.host[0] == 0)
593 sstrncpy(value_list.host, hostname_g, sizeof(value_list.host));
594 if (value_list.plugin[0] == 0)
595 sstrncpy(value_list.plugin, "python", sizeof(value_list.plugin));
596 Py_BEGIN_ALLOW_THREADS;
597 ret = plugin_dispatch_values(&value_list);
598 Py_END_ALLOW_THREADS;
599 meta_data_destroy(value_list.meta);
602 PyErr_SetString(PyExc_RuntimeError, "error dispatching values, read the logs");
608 static PyObject *Values_write(Values *self, PyObject *args, PyObject *kwds) {
610 const data_set_t *ds;
613 value_list_t value_list = VALUE_LIST_INIT;
614 PyObject *values = self->values, *meta = self->meta;
615 double time = self->data.time, interval = self->interval;
616 char *host = NULL, *plugin = NULL, *plugin_instance = NULL, *type = NULL, *type_instance = NULL, *dest = NULL;
618 static char *kwlist[] = {"destination", "type", "values", "plugin_instance", "type_instance",
619 "plugin", "host", "time", "interval", "meta", NULL};
620 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|etOetetetetdiO", kwlist, NULL, &dest,
621 NULL, &type, &values, NULL, &plugin_instance, NULL, &type_instance,
622 NULL, &plugin, NULL, &host, &time, &interval, &meta))
625 sstrncpy(value_list.host, host ? host : self->data.host, sizeof(value_list.host));
626 sstrncpy(value_list.plugin, plugin ? plugin : self->data.plugin, sizeof(value_list.plugin));
627 sstrncpy(value_list.plugin_instance, plugin_instance ? plugin_instance : self->data.plugin_instance, sizeof(value_list.plugin_instance));
628 sstrncpy(value_list.type, type ? type : self->data.type, sizeof(value_list.type));
629 sstrncpy(value_list.type_instance, type_instance ? type_instance : self->data.type_instance, sizeof(value_list.type_instance));
631 if (value_list.type[0] == 0) {
632 PyErr_SetString(PyExc_RuntimeError, "type not set");
635 ds = plugin_get_ds(value_list.type);
637 PyErr_Format(PyExc_TypeError, "Dataset %s not found", value_list.type);
640 if (values == NULL || (PyTuple_Check(values) == 0 && PyList_Check(values) == 0)) {
641 PyErr_Format(PyExc_TypeError, "values must be list or tuple");
644 size = (int) PySequence_Length(values);
645 if (size != ds->ds_num) {
646 PyErr_Format(PyExc_RuntimeError, "type %s needs %d values, got %i", value_list.type, ds->ds_num, size);
649 value = malloc(size * sizeof(*value));
650 for (i = 0; i < size; ++i) {
651 PyObject *item, *num;
652 item = PySequence_Fast_GET_ITEM(values, i); /* Borrowed reference. */
653 if (ds->ds->type == DS_TYPE_COUNTER) {
654 num = PyNumber_Long(item); /* New reference. */
656 value[i].counter = PyLong_AsUnsignedLongLong(num);
659 } else if (ds->ds->type == DS_TYPE_GAUGE) {
660 num = PyNumber_Float(item); /* New reference. */
662 value[i].gauge = PyFloat_AsDouble(num);
665 } else if (ds->ds->type == DS_TYPE_DERIVE) {
666 /* This might overflow without raising an exception.
667 * Not much we can do about it */
668 num = PyNumber_Long(item); /* New reference. */
670 value[i].derive = PyLong_AsLongLong(num);
673 } else if (ds->ds->type == DS_TYPE_ABSOLUTE) {
674 /* This might overflow without raising an exception.
675 * Not much we can do about it */
676 num = PyNumber_Long(item); /* New reference. */
678 value[i].absolute = PyLong_AsUnsignedLongLong(num);
683 PyErr_Format(PyExc_RuntimeError, "unknown data type %d for %s", ds->ds->type, value_list.type);
686 if (PyErr_Occurred() != NULL) {
691 value_list.values = value;
692 value_list.values_len = size;
693 value_list.time = DOUBLE_TO_CDTIME_T(time);
694 value_list.interval = DOUBLE_TO_CDTIME_T(interval);
695 value_list.meta = cpy_build_meta(meta);;
696 if (value_list.host[0] == 0)
697 sstrncpy(value_list.host, hostname_g, sizeof(value_list.host));
698 if (value_list.plugin[0] == 0)
699 sstrncpy(value_list.plugin, "python", sizeof(value_list.plugin));
700 Py_BEGIN_ALLOW_THREADS;
701 ret = plugin_write(dest, NULL, &value_list);
702 Py_END_ALLOW_THREADS;
703 meta_data_destroy(value_list.meta);
706 PyErr_SetString(PyExc_RuntimeError, "error dispatching values, read the logs");
712 static PyObject *Values_repr(PyObject *s) {
714 static PyObject *l_interval = NULL, *l_values = NULL, *l_meta = NULL, *l_closing = NULL;
715 Values *self = (Values *) s;
717 if (l_interval == NULL)
718 l_interval = cpy_string_to_unicode_or_bytes(",interval=");
719 if (l_values == NULL)
720 l_values = cpy_string_to_unicode_or_bytes(",values=");
722 l_meta = cpy_string_to_unicode_or_bytes(",meta=");
723 if (l_closing == NULL)
724 l_closing = cpy_string_to_unicode_or_bytes(")");
726 if (l_interval == NULL || l_values == NULL || l_meta == NULL || l_closing == NULL)
729 ret = cpy_common_repr(s);
730 if (self->interval != 0) {
731 CPY_STRCAT(&ret, l_interval);
732 tmp = PyFloat_FromDouble(self->interval);
733 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
734 CPY_STRCAT_AND_DEL(&ret, tmp);
736 if (self->values && (!PyList_Check(self->values) || PySequence_Length(self->values) > 0)) {
737 CPY_STRCAT(&ret, l_values);
738 tmp = PyObject_Repr(self->values);
739 CPY_STRCAT_AND_DEL(&ret, tmp);
741 if (self->meta && (!PyDict_Check(self->meta) || PyDict_Size(self->meta) > 0)) {
742 CPY_STRCAT(&ret, l_meta);
743 tmp = PyObject_Repr(self->meta);
744 CPY_STRCAT_AND_DEL(&ret, tmp);
746 CPY_STRCAT(&ret, l_closing);
750 static int Values_traverse(PyObject *self, visitproc visit, void *arg) {
751 Values *v = (Values *) self;
757 static int Values_clear(PyObject *self) {
758 Values *v = (Values *) self;
764 static void Values_dealloc(PyObject *self) {
766 self->ob_type->tp_free(self);
769 static PyMemberDef Values_members[] = {
770 {"interval", T_DOUBLE, offsetof(Values, interval), 0, interval_doc},
771 {"values", T_OBJECT_EX, offsetof(Values, values), 0, values_doc},
772 {"meta", T_OBJECT_EX, offsetof(Values, meta), 0, meta_doc},
776 static PyMethodDef Values_methods[] = {
777 {"dispatch", (PyCFunction) Values_dispatch, METH_VARARGS | METH_KEYWORDS, dispatch_doc},
778 {"write", (PyCFunction) Values_write, METH_VARARGS | METH_KEYWORDS, write_doc},
782 PyTypeObject ValuesType = {
784 "collectd.Values", /* tp_name */
785 sizeof(Values), /* tp_basicsize */
786 0, /* Will be filled in later */
787 Values_dealloc, /* tp_dealloc */
792 Values_repr, /* tp_repr */
793 0, /* tp_as_number */
794 0, /* tp_as_sequence */
795 0, /* tp_as_mapping */
801 0, /* tp_as_buffer */
802 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
803 Values_doc, /* tp_doc */
804 Values_traverse, /* tp_traverse */
805 Values_clear, /* tp_clear */
806 0, /* tp_richcompare */
807 0, /* tp_weaklistoffset */
810 Values_methods, /* tp_methods */
811 Values_members, /* tp_members */
815 0, /* tp_descr_get */
816 0, /* tp_descr_set */
817 0, /* tp_dictoffset */
818 Values_init, /* tp_init */
820 Values_new /* tp_new */
823 static char severity_doc[] = "The severity of this notification. Assign or compare to\n"
824 "NOTIF_FAILURE, NOTIF_WARNING or NOTIF_OKAY.";
826 static char message_doc[] = "Some kind of description what's going on and why this Notification was generated.";
828 static char Notification_doc[] = "The Notification class is a wrapper around the collectd notification.\n"
829 "It can be used to notify other plugins about bad stuff happening. It works\n"
830 "similar to Values but has a severity and a message instead of interval\n"
832 "Notifications can be dispatched at any time and can be received with register_notification.";
834 static int Notification_init(PyObject *s, PyObject *args, PyObject *kwds) {
835 Notification *self = (Notification *) s;
838 char *message = NULL;
839 char *type = NULL, *plugin_instance = NULL, *type_instance = NULL, *plugin = NULL, *host = NULL;
840 static char *kwlist[] = {"type", "message", "plugin_instance", "type_instance",
841 "plugin", "host", "time", "severity", NULL};
843 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|etetetetetetdi", kwlist,
844 NULL, &type, NULL, &message, NULL, &plugin_instance, NULL, &type_instance,
845 NULL, &plugin, NULL, &host, &time, &severity))
848 if (type && plugin_get_ds(type) == NULL) {
849 PyErr_Format(PyExc_TypeError, "Dataset %s not found", type);
855 sstrncpy(self->data.host, host ? host : "", sizeof(self->data.host));
856 sstrncpy(self->data.plugin, plugin ? plugin : "", sizeof(self->data.plugin));
857 sstrncpy(self->data.plugin_instance, plugin_instance ? plugin_instance : "", sizeof(self->data.plugin_instance));
858 sstrncpy(self->data.type, type ? type : "", sizeof(self->data.type));
859 sstrncpy(self->data.type_instance, type_instance ? type_instance : "", sizeof(self->data.type_instance));
860 sstrncpy(self->message, message ? message : "", sizeof(self->message));
861 self->data.time = time;
862 self->severity = severity;
869 static PyObject *Notification_dispatch(Notification *self, PyObject *args, PyObject *kwds) {
871 const data_set_t *ds;
872 notification_t notification;
873 double t = self->data.time;
874 int severity = self->severity;
875 char *host = NULL, *plugin = NULL, *plugin_instance = NULL, *type = NULL, *type_instance = NULL;
876 char *message = NULL;
878 static char *kwlist[] = {"type", "message", "plugin_instance", "type_instance",
879 "plugin", "host", "time", "severity", NULL};
880 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|etetetetetetdi", kwlist,
881 NULL, &type, NULL, &message, NULL, &plugin_instance, NULL, &type_instance,
882 NULL, &plugin, NULL, &host, &t, &severity))
885 notification.time = DOUBLE_TO_CDTIME_T(t);
886 notification.severity = severity;
887 sstrncpy(notification.message, message ? message : self->message, sizeof(notification.message));
888 sstrncpy(notification.host, host ? host : self->data.host, sizeof(notification.host));
889 sstrncpy(notification.plugin, plugin ? plugin : self->data.plugin, sizeof(notification.plugin));
890 sstrncpy(notification.plugin_instance, plugin_instance ? plugin_instance : self->data.plugin_instance, sizeof(notification.plugin_instance));
891 sstrncpy(notification.type, type ? type : self->data.type, sizeof(notification.type));
892 sstrncpy(notification.type_instance, type_instance ? type_instance : self->data.type_instance, sizeof(notification.type_instance));
893 notification.meta = NULL;
897 if (notification.type[0] == 0) {
898 PyErr_SetString(PyExc_RuntimeError, "type not set");
901 ds = plugin_get_ds(notification.type);
903 PyErr_Format(PyExc_TypeError, "Dataset %s not found", notification.type);
907 if (notification.time == 0)
908 notification.time = cdtime();
909 if (notification.host[0] == 0)
910 sstrncpy(notification.host, hostname_g, sizeof(notification.host));
911 if (notification.plugin[0] == 0)
912 sstrncpy(notification.plugin, "python", sizeof(notification.plugin));
913 Py_BEGIN_ALLOW_THREADS;
914 ret = plugin_dispatch_notification(¬ification);
915 Py_END_ALLOW_THREADS;
917 PyErr_SetString(PyExc_RuntimeError, "error dispatching notification, read the logs");
923 static PyObject *Notification_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {
926 self = (Notification *) PluginData_new(type, args, kwds);
930 self->message[0] = 0;
932 return (PyObject *) self;
935 static int Notification_setstring(PyObject *self, PyObject *value, void *data) {
940 PyErr_SetString(PyExc_TypeError, "Cannot delete this attribute");
944 new = cpy_unicode_or_bytes_to_string(&value);
949 old = ((char *) self) + (intptr_t) data;
950 sstrncpy(old, new, NOTIF_MAX_MSG_LEN);
955 static PyObject *Notification_repr(PyObject *s) {
957 static PyObject *l_severity = NULL, *l_message = NULL, *l_closing = NULL;
958 Notification *self = (Notification *) s;
960 if (l_severity == NULL)
961 l_severity = cpy_string_to_unicode_or_bytes(",severity=");
962 if (l_message == NULL)
963 l_message = cpy_string_to_unicode_or_bytes(",message=");
964 if (l_closing == NULL)
965 l_closing = cpy_string_to_unicode_or_bytes(")");
967 if (l_severity == NULL || l_message == NULL || l_closing == NULL)
970 ret = cpy_common_repr(s);
971 if (self->severity != 0) {
972 CPY_STRCAT(&ret, l_severity);
973 tmp = PyInt_FromLong(self->severity);
974 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
975 CPY_STRCAT_AND_DEL(&ret, tmp);
977 if (self->message[0] != 0) {
978 CPY_STRCAT(&ret, l_message);
979 tmp = cpy_string_to_unicode_or_bytes(self->message);
980 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
981 CPY_STRCAT_AND_DEL(&ret, tmp);
983 CPY_STRCAT(&ret, l_closing);
987 static PyMethodDef Notification_methods[] = {
988 {"dispatch", (PyCFunction) Notification_dispatch, METH_VARARGS | METH_KEYWORDS, dispatch_doc},
992 static PyMemberDef Notification_members[] = {
993 {"severity", T_INT, offsetof(Notification, severity), 0, severity_doc},
997 static PyGetSetDef Notification_getseters[] = {
998 {"message", PluginData_getstring, Notification_setstring, message_doc, (void *) offsetof(Notification, message)},
1002 PyTypeObject NotificationType = {
1004 "collectd.Notification", /* tp_name */
1005 sizeof(Notification), /* tp_basicsize */
1006 0, /* Will be filled in later */
1012 Notification_repr, /* tp_repr */
1013 0, /* tp_as_number */
1014 0, /* tp_as_sequence */
1015 0, /* tp_as_mapping */
1019 0, /* tp_getattro */
1020 0, /* tp_setattro */
1021 0, /* tp_as_buffer */
1022 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
1023 Notification_doc, /* tp_doc */
1024 0, /* tp_traverse */
1026 0, /* tp_richcompare */
1027 0, /* tp_weaklistoffset */
1029 0, /* tp_iternext */
1030 Notification_methods, /* tp_methods */
1031 Notification_members, /* tp_members */
1032 Notification_getseters, /* tp_getset */
1035 0, /* tp_descr_get */
1036 0, /* tp_descr_set */
1037 0, /* tp_dictoffset */
1038 Notification_init, /* tp_init */
1040 Notification_new /* tp_new */
1043 static char Signed_doc[] = "This is a long by another name. Use it in meta data dicts\n"
1044 "to choose the way it is stored in the meta data.";
1046 PyTypeObject SignedType = {
1048 "collectd.Signed", /* tp_name */
1049 sizeof(Signed), /* tp_basicsize */
1050 0, /* Will be filled in later */
1057 0, /* tp_as_number */
1058 0, /* tp_as_sequence */
1059 0, /* tp_as_mapping */
1063 0, /* tp_getattro */
1064 0, /* tp_setattro */
1065 0, /* tp_as_buffer */
1066 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
1067 Signed_doc /* tp_doc */
1070 static char Unsigned_doc[] = "This is a long by another name. Use it in meta data dicts\n"
1071 "to choose the way it is stored in the meta data.";
1073 PyTypeObject UnsignedType = {
1075 "collectd.Unsigned", /* tp_name */
1076 sizeof(Unsigned), /* tp_basicsize */
1077 0, /* Will be filled in later */
1084 0, /* tp_as_number */
1085 0, /* tp_as_sequence */
1086 0, /* tp_as_mapping */
1090 0, /* tp_getattro */
1091 0, /* tp_setattro */
1092 0, /* tp_as_buffer */
1093 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
1094 Unsigned_doc /* tp_doc */