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 = PyInt_FromLong(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;
367 PyObject *values = NULL, *meta = NULL, *tmp;
368 char *type = NULL, *plugin_instance = NULL, *type_instance = NULL, *plugin = NULL, *host = NULL;
369 static char *kwlist[] = {"type", "values", "plugin_instance", "type_instance",
370 "plugin", "host", "time", "interval", "meta", NULL};
372 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|etOetetetetdiO", kwlist,
373 NULL, &type, &values, NULL, &plugin_instance, NULL, &type_instance,
374 NULL, &plugin, NULL, &host, &time, &interval, &meta))
377 if (type && plugin_get_ds(type) == NULL) {
378 PyErr_Format(PyExc_TypeError, "Dataset %s not found", type);
383 sstrncpy(self->data.host, host ? host : "", sizeof(self->data.host));
384 sstrncpy(self->data.plugin, plugin ? plugin : "", sizeof(self->data.plugin));
385 sstrncpy(self->data.plugin_instance, plugin_instance ? plugin_instance : "", sizeof(self->data.plugin_instance));
386 sstrncpy(self->data.type, type ? type : "", sizeof(self->data.type));
387 sstrncpy(self->data.type_instance, type_instance ? type_instance : "", sizeof(self->data.type_instance));
388 self->data.time = time;
392 if (values == NULL) {
393 values = PyList_New(0);
407 self->values = values;
414 self->interval = interval;
418 static meta_data_t *cpy_build_meta(PyObject *meta) {
420 meta_data_t *m = NULL;
426 l = PyDict_Items(meta); /* New reference. */
428 cpy_log_exception("building meta data");
431 m = meta_data_create();
433 for (i = 0; i < s; ++i) {
434 const char *string, *keystring;
435 PyObject *key, *value, *item, *tmp;
437 item = PyList_GET_ITEM(l, i);
438 key = PyTuple_GET_ITEM(item, 0);
440 keystring = cpy_unicode_or_bytes_to_string(&key);
446 value = PyTuple_GET_ITEM(item, 1);
448 if (value == Py_True) {
449 meta_data_add_boolean(m, keystring, 1);
450 } else if (value == Py_False) {
451 meta_data_add_boolean(m, keystring, 0);
452 } else if (PyFloat_Check(value)) {
453 meta_data_add_double(m, keystring, PyFloat_AsDouble(value));
454 } else if (PyObject_TypeCheck(value, &SignedType)) {
456 lli = PyLong_AsLongLong(value);
457 if (!PyErr_Occurred() && (lli == (int64_t) lli))
458 meta_data_add_signed_int(m, keystring, lli);
459 } else if (PyObject_TypeCheck(value, &UnsignedType)) {
460 long long unsigned llu;
461 llu = PyLong_AsUnsignedLongLong(value);
462 if (!PyErr_Occurred() && (llu == (uint64_t) llu))
463 meta_data_add_unsigned_int(m, keystring, llu);
464 } else if (PyNumber_Check(value)) {
466 long long unsigned llu;
467 tmp = PyNumber_Long(value);
468 lli = PyLong_AsLongLong(tmp);
469 if (!PyErr_Occurred() && (lli == (int64_t) lli)) {
470 meta_data_add_signed_int(m, keystring, lli);
473 llu = PyLong_AsUnsignedLongLong(tmp);
474 if (!PyErr_Occurred() && (llu == (uint64_t) llu))
475 meta_data_add_unsigned_int(m, keystring, llu);
479 string = cpy_unicode_or_bytes_to_string(&value);
481 meta_data_add_string(m, keystring, string);
484 tmp = PyObject_Str(value);
485 string = cpy_unicode_or_bytes_to_string(&tmp);
487 meta_data_add_string(m, keystring, string);
491 if (PyErr_Occurred())
492 cpy_log_exception("building meta data");
500 static PyObject *Values_dispatch(Values *self, PyObject *args, PyObject *kwds) {
502 const data_set_t *ds;
505 value_list_t value_list = VALUE_LIST_INIT;
506 PyObject *values = self->values, *meta = self->meta;
507 double time = self->data.time;
508 int interval = self->interval;
509 char *host = NULL, *plugin = NULL, *plugin_instance = NULL, *type = NULL, *type_instance = NULL;
511 static char *kwlist[] = {"type", "values", "plugin_instance", "type_instance",
512 "plugin", "host", "time", "interval", "meta", NULL};
513 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|etOetetetetdiO", kwlist,
514 NULL, &type, &values, NULL, &plugin_instance, NULL, &type_instance,
515 NULL, &plugin, NULL, &host, &time, &interval, &meta))
518 sstrncpy(value_list.host, host ? host : self->data.host, sizeof(value_list.host));
519 sstrncpy(value_list.plugin, plugin ? plugin : self->data.plugin, sizeof(value_list.plugin));
520 sstrncpy(value_list.plugin_instance, plugin_instance ? plugin_instance : self->data.plugin_instance, sizeof(value_list.plugin_instance));
521 sstrncpy(value_list.type, type ? type : self->data.type, sizeof(value_list.type));
522 sstrncpy(value_list.type_instance, type_instance ? type_instance : self->data.type_instance, sizeof(value_list.type_instance));
524 if (value_list.type[0] == 0) {
525 PyErr_SetString(PyExc_RuntimeError, "type not set");
529 ds = plugin_get_ds(value_list.type);
531 PyErr_Format(PyExc_TypeError, "Dataset %s not found", value_list.type);
534 if (values == NULL || (PyTuple_Check(values) == 0 && PyList_Check(values) == 0)) {
535 PyErr_Format(PyExc_TypeError, "values must be list or tuple");
538 if (meta != NULL && meta != Py_None && !PyDict_Check(meta)) {
539 PyErr_Format(PyExc_TypeError, "meta must be a dict");
542 size = (int) PySequence_Length(values);
543 if (size != ds->ds_num) {
544 PyErr_Format(PyExc_RuntimeError, "type %s needs %d values, got %i", value_list.type, ds->ds_num, size);
547 value = malloc(size * sizeof(*value));
548 for (i = 0; i < size; ++i) {
549 PyObject *item, *num;
550 item = PySequence_Fast_GET_ITEM(values, i); /* Borrowed reference. */
551 if (ds->ds->type == DS_TYPE_COUNTER) {
552 num = PyNumber_Long(item); /* New reference. */
554 value[i].counter = PyLong_AsUnsignedLongLong(num);
557 } else if (ds->ds->type == DS_TYPE_GAUGE) {
558 num = PyNumber_Float(item); /* New reference. */
560 value[i].gauge = PyFloat_AsDouble(num);
563 } else if (ds->ds->type == DS_TYPE_DERIVE) {
564 /* This might overflow without raising an exception.
565 * Not much we can do about it */
566 num = PyNumber_Long(item); /* New reference. */
568 value[i].derive = PyLong_AsLongLong(num);
571 } else if (ds->ds->type == DS_TYPE_ABSOLUTE) {
572 /* This might overflow without raising an exception.
573 * Not much we can do about it */
574 num = PyNumber_Long(item); /* New reference. */
576 value[i].absolute = PyLong_AsUnsignedLongLong(num);
581 PyErr_Format(PyExc_RuntimeError, "unknown data type %d for %s", ds->ds->type, value_list.type);
584 if (PyErr_Occurred() != NULL) {
589 value_list.values = value;
590 value_list.meta = cpy_build_meta(meta);
591 value_list.values_len = size;
592 value_list.time = time;
593 value_list.interval = interval;
594 if (value_list.host[0] == 0)
595 sstrncpy(value_list.host, hostname_g, sizeof(value_list.host));
596 if (value_list.plugin[0] == 0)
597 sstrncpy(value_list.plugin, "python", sizeof(value_list.plugin));
598 Py_BEGIN_ALLOW_THREADS;
599 ret = plugin_dispatch_values(&value_list);
600 Py_END_ALLOW_THREADS;
601 meta_data_destroy(value_list.meta);
604 PyErr_SetString(PyExc_RuntimeError, "error dispatching values, read the logs");
610 static PyObject *Values_write(Values *self, PyObject *args, PyObject *kwds) {
612 const data_set_t *ds;
615 value_list_t value_list = VALUE_LIST_INIT;
616 PyObject *values = self->values, *meta = self->meta;
617 double time = self->data.time;
618 int interval = self->interval;
619 char *host = NULL, *plugin = NULL, *plugin_instance = NULL, *type = NULL, *type_instance = NULL, *dest = NULL;
621 static char *kwlist[] = {"destination", "type", "values", "plugin_instance", "type_instance",
622 "plugin", "host", "time", "interval", "meta", NULL};
623 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|etOetetetetdiO", kwlist, NULL, &dest,
624 NULL, &type, &values, NULL, &plugin_instance, NULL, &type_instance,
625 NULL, &plugin, NULL, &host, &time, &interval, &meta))
628 sstrncpy(value_list.host, host ? host : self->data.host, sizeof(value_list.host));
629 sstrncpy(value_list.plugin, plugin ? plugin : self->data.plugin, sizeof(value_list.plugin));
630 sstrncpy(value_list.plugin_instance, plugin_instance ? plugin_instance : self->data.plugin_instance, sizeof(value_list.plugin_instance));
631 sstrncpy(value_list.type, type ? type : self->data.type, sizeof(value_list.type));
632 sstrncpy(value_list.type_instance, type_instance ? type_instance : self->data.type_instance, sizeof(value_list.type_instance));
634 if (value_list.type[0] == 0) {
635 PyErr_SetString(PyExc_RuntimeError, "type not set");
638 ds = plugin_get_ds(value_list.type);
640 PyErr_Format(PyExc_TypeError, "Dataset %s not found", value_list.type);
643 if (values == NULL || (PyTuple_Check(values) == 0 && PyList_Check(values) == 0)) {
644 PyErr_Format(PyExc_TypeError, "values must be list or tuple");
647 size = (int) PySequence_Length(values);
648 if (size != ds->ds_num) {
649 PyErr_Format(PyExc_RuntimeError, "type %s needs %d values, got %i", value_list.type, ds->ds_num, size);
652 value = malloc(size * sizeof(*value));
653 for (i = 0; i < size; ++i) {
654 PyObject *item, *num;
655 item = PySequence_Fast_GET_ITEM(values, i); /* Borrowed reference. */
656 if (ds->ds->type == DS_TYPE_COUNTER) {
657 num = PyNumber_Long(item); /* New reference. */
659 value[i].counter = PyLong_AsUnsignedLongLong(num);
662 } else if (ds->ds->type == DS_TYPE_GAUGE) {
663 num = PyNumber_Float(item); /* New reference. */
665 value[i].gauge = PyFloat_AsDouble(num);
668 } else if (ds->ds->type == DS_TYPE_DERIVE) {
669 /* This might overflow without raising an exception.
670 * Not much we can do about it */
671 num = PyNumber_Long(item); /* New reference. */
673 value[i].derive = PyLong_AsLongLong(num);
676 } else if (ds->ds->type == DS_TYPE_ABSOLUTE) {
677 /* This might overflow without raising an exception.
678 * Not much we can do about it */
679 num = PyNumber_Long(item); /* New reference. */
681 value[i].absolute = PyLong_AsUnsignedLongLong(num);
686 PyErr_Format(PyExc_RuntimeError, "unknown data type %d for %s", ds->ds->type, value_list.type);
689 if (PyErr_Occurred() != NULL) {
694 value_list.values = value;
695 value_list.values_len = size;
696 value_list.time = time;
697 value_list.interval = interval;
698 value_list.meta = cpy_build_meta(meta);;
699 if (value_list.host[0] == 0)
700 sstrncpy(value_list.host, hostname_g, sizeof(value_list.host));
701 if (value_list.plugin[0] == 0)
702 sstrncpy(value_list.plugin, "python", sizeof(value_list.plugin));
703 Py_BEGIN_ALLOW_THREADS;
704 ret = plugin_write(dest, NULL, &value_list);
705 Py_END_ALLOW_THREADS;
706 meta_data_destroy(value_list.meta);
709 PyErr_SetString(PyExc_RuntimeError, "error dispatching values, read the logs");
715 static PyObject *Values_repr(PyObject *s) {
717 static PyObject *l_interval = NULL, *l_values = NULL, *l_meta = NULL, *l_closing = NULL;
718 Values *self = (Values *) s;
720 if (l_interval == NULL)
721 l_interval = cpy_string_to_unicode_or_bytes(",interval=");
722 if (l_values == NULL)
723 l_values = cpy_string_to_unicode_or_bytes(",values=");
725 l_meta = cpy_string_to_unicode_or_bytes(",meta=");
726 if (l_closing == NULL)
727 l_closing = cpy_string_to_unicode_or_bytes(")");
729 if (l_interval == NULL || l_values == NULL || l_meta == NULL || l_closing == NULL)
732 ret = cpy_common_repr(s);
733 if (self->interval != 0) {
734 CPY_STRCAT(&ret, l_interval);
735 tmp = PyInt_FromLong(self->interval);
736 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
737 CPY_STRCAT_AND_DEL(&ret, tmp);
739 if (self->values && (!PyList_Check(self->values) || PySequence_Length(self->values) > 0)) {
740 CPY_STRCAT(&ret, l_values);
741 tmp = PyObject_Repr(self->values);
742 CPY_STRCAT_AND_DEL(&ret, tmp);
744 if (self->meta && (!PyDict_Check(self->meta) || PyDict_Size(self->meta) > 0)) {
745 CPY_STRCAT(&ret, l_meta);
746 tmp = PyObject_Repr(self->meta);
747 CPY_STRCAT_AND_DEL(&ret, tmp);
749 CPY_STRCAT(&ret, l_closing);
753 static int Values_traverse(PyObject *self, visitproc visit, void *arg) {
754 Values *v = (Values *) self;
760 static int Values_clear(PyObject *self) {
761 Values *v = (Values *) self;
767 static void Values_dealloc(PyObject *self) {
769 self->ob_type->tp_free(self);
772 static PyMemberDef Values_members[] = {
773 {"interval", T_INT, offsetof(Values, interval), 0, interval_doc},
774 {"values", T_OBJECT_EX, offsetof(Values, values), 0, values_doc},
775 {"meta", T_OBJECT_EX, offsetof(Values, meta), 0, meta_doc},
779 static PyMethodDef Values_methods[] = {
780 {"dispatch", (PyCFunction) Values_dispatch, METH_VARARGS | METH_KEYWORDS, dispatch_doc},
781 {"write", (PyCFunction) Values_write, METH_VARARGS | METH_KEYWORDS, write_doc},
785 PyTypeObject ValuesType = {
787 "collectd.Values", /* tp_name */
788 sizeof(Values), /* tp_basicsize */
789 0, /* Will be filled in later */
790 Values_dealloc, /* tp_dealloc */
795 Values_repr, /* tp_repr */
796 0, /* tp_as_number */
797 0, /* tp_as_sequence */
798 0, /* tp_as_mapping */
804 0, /* tp_as_buffer */
805 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
806 Values_doc, /* tp_doc */
807 Values_traverse, /* tp_traverse */
808 Values_clear, /* tp_clear */
809 0, /* tp_richcompare */
810 0, /* tp_weaklistoffset */
813 Values_methods, /* tp_methods */
814 Values_members, /* tp_members */
818 0, /* tp_descr_get */
819 0, /* tp_descr_set */
820 0, /* tp_dictoffset */
821 Values_init, /* tp_init */
823 Values_new /* tp_new */
826 static char severity_doc[] = "The severity of this notification. Assign or compare to\n"
827 "NOTIF_FAILURE, NOTIF_WARNING or NOTIF_OKAY.";
829 static char message_doc[] = "Some kind of description what's going on and why this Notification was generated.";
831 static char Notification_doc[] = "The Notification class is a wrapper around the collectd notification.\n"
832 "It can be used to notify other plugins about bad stuff happening. It works\n"
833 "similar to Values but has a severity and a message instead of interval\n"
835 "Notifications can be dispatched at any time and can be received with register_notification.";
837 static int Notification_init(PyObject *s, PyObject *args, PyObject *kwds) {
838 Notification *self = (Notification *) s;
841 char *message = NULL;
842 char *type = NULL, *plugin_instance = NULL, *type_instance = NULL, *plugin = NULL, *host = NULL;
843 static char *kwlist[] = {"type", "message", "plugin_instance", "type_instance",
844 "plugin", "host", "time", "severity", NULL};
846 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|etetetetetetdi", kwlist,
847 NULL, &type, NULL, &message, NULL, &plugin_instance, NULL, &type_instance,
848 NULL, &plugin, NULL, &host, &time, &severity))
851 if (type && plugin_get_ds(type) == NULL) {
852 PyErr_Format(PyExc_TypeError, "Dataset %s not found", type);
858 sstrncpy(self->data.host, host ? host : "", sizeof(self->data.host));
859 sstrncpy(self->data.plugin, plugin ? plugin : "", sizeof(self->data.plugin));
860 sstrncpy(self->data.plugin_instance, plugin_instance ? plugin_instance : "", sizeof(self->data.plugin_instance));
861 sstrncpy(self->data.type, type ? type : "", sizeof(self->data.type));
862 sstrncpy(self->data.type_instance, type_instance ? type_instance : "", sizeof(self->data.type_instance));
863 sstrncpy(self->message, message ? message : "", sizeof(self->message));
864 self->data.time = time;
865 self->severity = severity;
872 static PyObject *Notification_dispatch(Notification *self, PyObject *args, PyObject *kwds) {
874 const data_set_t *ds;
875 notification_t notification;
876 double t = self->data.time;
877 int severity = self->severity;
878 char *host = NULL, *plugin = NULL, *plugin_instance = NULL, *type = NULL, *type_instance = NULL;
879 char *message = NULL;
881 static char *kwlist[] = {"type", "message", "plugin_instance", "type_instance",
882 "plugin", "host", "time", "severity", NULL};
883 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|etetetetetetdi", kwlist,
884 NULL, &type, NULL, &message, NULL, &plugin_instance, NULL, &type_instance,
885 NULL, &plugin, NULL, &host, &t, &severity))
888 notification.time = t;
889 notification.severity = severity;
890 sstrncpy(notification.message, message ? message : self->message, sizeof(notification.message));
891 sstrncpy(notification.host, host ? host : self->data.host, sizeof(notification.host));
892 sstrncpy(notification.plugin, plugin ? plugin : self->data.plugin, sizeof(notification.plugin));
893 sstrncpy(notification.plugin_instance, plugin_instance ? plugin_instance : self->data.plugin_instance, sizeof(notification.plugin_instance));
894 sstrncpy(notification.type, type ? type : self->data.type, sizeof(notification.type));
895 sstrncpy(notification.type_instance, type_instance ? type_instance : self->data.type_instance, sizeof(notification.type_instance));
896 notification.meta = NULL;
900 if (notification.type[0] == 0) {
901 PyErr_SetString(PyExc_RuntimeError, "type not set");
904 ds = plugin_get_ds(notification.type);
906 PyErr_Format(PyExc_TypeError, "Dataset %s not found", notification.type);
910 if (notification.time < 1)
911 notification.time = time(0);
912 if (notification.host[0] == 0)
913 sstrncpy(notification.host, hostname_g, sizeof(notification.host));
914 if (notification.plugin[0] == 0)
915 sstrncpy(notification.plugin, "python", sizeof(notification.plugin));
916 Py_BEGIN_ALLOW_THREADS;
917 ret = plugin_dispatch_notification(¬ification);
918 Py_END_ALLOW_THREADS;
920 PyErr_SetString(PyExc_RuntimeError, "error dispatching notification, read the logs");
926 static PyObject *Notification_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {
929 self = (Notification *) PluginData_new(type, args, kwds);
933 self->message[0] = 0;
935 return (PyObject *) self;
938 static int Notification_setstring(PyObject *self, PyObject *value, void *data) {
943 PyErr_SetString(PyExc_TypeError, "Cannot delete this attribute");
947 new = cpy_unicode_or_bytes_to_string(&value);
952 old = ((char *) self) + (intptr_t) data;
953 sstrncpy(old, new, NOTIF_MAX_MSG_LEN);
958 static PyObject *Notification_repr(PyObject *s) {
960 static PyObject *l_severity = NULL, *l_message = NULL, *l_closing = NULL;
961 Notification *self = (Notification *) s;
963 if (l_severity == NULL)
964 l_severity = cpy_string_to_unicode_or_bytes(",severity=");
965 if (l_message == NULL)
966 l_message = cpy_string_to_unicode_or_bytes(",message=");
967 if (l_closing == NULL)
968 l_closing = cpy_string_to_unicode_or_bytes(")");
970 if (l_severity == NULL || l_message == NULL || l_closing == NULL)
973 ret = cpy_common_repr(s);
974 if (self->severity != 0) {
975 CPY_STRCAT(&ret, l_severity);
976 tmp = PyInt_FromLong(self->severity);
977 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
978 CPY_STRCAT_AND_DEL(&ret, tmp);
980 if (self->message[0] != 0) {
981 CPY_STRCAT(&ret, l_message);
982 tmp = cpy_string_to_unicode_or_bytes(self->message);
983 CPY_SUBSTITUTE(PyObject_Repr, tmp, tmp);
984 CPY_STRCAT_AND_DEL(&ret, tmp);
986 CPY_STRCAT(&ret, l_closing);
990 static PyMethodDef Notification_methods[] = {
991 {"dispatch", (PyCFunction) Notification_dispatch, METH_VARARGS | METH_KEYWORDS, dispatch_doc},
995 static PyMemberDef Notification_members[] = {
996 {"severity", T_INT, offsetof(Notification, severity), 0, severity_doc},
1000 static PyGetSetDef Notification_getseters[] = {
1001 {"message", PluginData_getstring, Notification_setstring, message_doc, (void *) offsetof(Notification, message)},
1005 PyTypeObject NotificationType = {
1007 "collectd.Notification", /* tp_name */
1008 sizeof(Notification), /* tp_basicsize */
1009 0, /* Will be filled in later */
1015 Notification_repr, /* tp_repr */
1016 0, /* tp_as_number */
1017 0, /* tp_as_sequence */
1018 0, /* tp_as_mapping */
1022 0, /* tp_getattro */
1023 0, /* tp_setattro */
1024 0, /* tp_as_buffer */
1025 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
1026 Notification_doc, /* tp_doc */
1027 0, /* tp_traverse */
1029 0, /* tp_richcompare */
1030 0, /* tp_weaklistoffset */
1032 0, /* tp_iternext */
1033 Notification_methods, /* tp_methods */
1034 Notification_members, /* tp_members */
1035 Notification_getseters, /* tp_getset */
1038 0, /* tp_descr_get */
1039 0, /* tp_descr_set */
1040 0, /* tp_dictoffset */
1041 Notification_init, /* tp_init */
1043 Notification_new /* tp_new */
1046 static char Signed_doc[] = "This is a long by another name. Use it in meta data dicts\n"
1047 "to choose the way it is stored in the meta data.";
1049 PyTypeObject SignedType = {
1051 "collectd.Signed", /* tp_name */
1052 sizeof(Signed), /* tp_basicsize */
1053 0, /* Will be filled in later */
1060 0, /* tp_as_number */
1061 0, /* tp_as_sequence */
1062 0, /* tp_as_mapping */
1066 0, /* tp_getattro */
1067 0, /* tp_setattro */
1068 0, /* tp_as_buffer */
1069 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
1070 Signed_doc /* tp_doc */
1073 static char Unsigned_doc[] = "This is a long by another name. Use it in meta data dicts\n"
1074 "to choose the way it is stored in the meta data.";
1076 PyTypeObject UnsignedType = {
1078 "collectd.Unsigned", /* tp_name */
1079 sizeof(Unsigned), /* tp_basicsize */
1080 0, /* Will be filled in later */
1087 0, /* tp_as_number */
1088 0, /* tp_as_sequence */
1089 0, /* tp_as_mapping */
1093 0, /* tp_getattro */
1094 0, /* tp_setattro */
1095 0, /* tp_as_buffer */
1096 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
1097 Unsigned_doc /* tp_doc */