2 * collectd - src/python.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>
40 typedef struct cpy_callback_s {
44 struct cpy_callback_s *next;
47 static char log_doc[] = "This function sends a string to all logging plugins.";
49 static char flush_doc[] = "flush([plugin][, timeout][, identifier]) -> None\n"
51 "Flushes the cache of another plugin.";
53 static char unregister_doc[] = "Unregisters a callback. This function needs exactly one parameter either\n"
54 "the function to unregister or the callback identifier to unregister.";
56 static char reg_log_doc[] = "register_log(callback[, data][, name]) -> identifier\n"
58 "Register a callback function for log messages.\n"
60 "'callback' is a callable object that will be called every time something\n"
62 "'data' is an optional object that will be passed back to the callback\n"
63 " function every time it is called.\n"
64 "'name' is an optional identifier for this callback. The default name\n"
65 " is 'python.<module>'.\n"
66 " Every callback needs a unique identifier, so if you want to\n"
67 " register this callback multiple time from the same module you need\n"
68 " to specify a name here.\n"
69 "'identifier' is the full identifier assigned to this callback.\n"
71 "The callback function will be called with two or three parameters:\n"
72 "severity: An integer that should be compared to the LOG_ constants.\n"
73 "message: The text to be logged.\n"
74 "data: The optional data parameter passed to the register function.\n"
75 " If the parameter was omitted it will be omitted here, too.";
77 static char reg_init_doc[] = "register_init(callback[, data][, name]) -> identifier\n"
79 "Register a callback function that will be executed once after the config.\n"
80 "file has been read, all plugins heve been loaded and the collectd has\n"
81 "forked into the background.\n"
83 "'callback' is a callable object that will be executed.\n"
84 "'data' is an optional object that will be passed back to the callback\n"
85 " function when it is called.\n"
86 "'name' is an optional identifier for this callback. The default name\n"
87 " is 'python.<module>'.\n"
88 " Every callback needs a unique identifier, so if you want to\n"
89 " register this callback multiple time from the same module you need\n"
90 " to specify a name here.\n"
91 "'identifier' is the full identifier assigned to this callback.\n"
93 "The callback function will be called without parameters, except for\n"
94 "data if it was supplied.";
96 static char reg_config_doc[] = "register_config(callback[, data][, name]) -> identifier\n"
98 "Register a callback function for config file entries.\n"
99 "'callback' is a callable object that will be called for every config block.\n"
100 "'data' is an optional object that will be passed back to the callback\n"
101 " function every time it is called.\n"
102 "'name' is an optional identifier for this callback. The default name\n"
103 " is 'python.<module>'.\n"
104 " Every callback needs a unique identifier, so if you want to\n"
105 " register this callback multiple time from the same module you need\n"
106 " to specify a name here.\n"
107 "'identifier' is the full identifier assigned to this callback.\n"
109 "The callback function will be called with one or two parameters:\n"
110 "config: A Config object.\n"
111 "data: The optional data parameter passed to the register function.\n"
112 " If the parameter was omitted it will be omitted here, too.";
114 static char reg_read_doc[] = "register_read(callback[, interval][, data][, name]) -> identifier\n"
116 "Register a callback function for reading data. It will just be called\n"
117 "in a fixed interval to signal that it's time to dispatch new values.\n"
118 "'callback' is a callable object that will be called every time something\n"
120 "'interval' is the number of seconds between between calls to the callback\n"
121 " function. Full float precision is supported here.\n"
122 "'data' is an optional object that will be passed back to the callback\n"
123 " function every time it is called.\n"
124 "'name' is an optional identifier for this callback. The default name\n"
125 " is 'python.<module>'.\n"
126 " Every callback needs a unique identifier, so if you want to\n"
127 " register this callback multiple time from the same module you need\n"
128 " to specify a name here.\n"
129 "'identifier' is the full identifier assigned to this callback.\n"
131 "The callback function will be called without parameters, except for\n"
132 "data if it was supplied.";
134 static char reg_write_doc[] = "register_write(callback[, data][, name]) -> identifier\n"
136 "Register a callback function to receive values dispatched by other plugins.\n"
137 "'callback' is a callable object that will be called every time a value\n"
139 "'data' is an optional object that will be passed back to the callback\n"
140 " function every time it is called.\n"
141 "'name' is an optional identifier for this callback. The default name\n"
142 " is 'python.<module>'.\n"
143 " Every callback needs a unique identifier, so if you want to\n"
144 " register this callback multiple time from the same module you need\n"
145 " to specify a name here.\n"
146 "'identifier' is the full identifier assigned to this callback.\n"
148 "The callback function will be called with one or two parameters:\n"
149 "values: A Values object which is a copy of the dispatched values.\n"
150 "data: The optional data parameter passed to the register function.\n"
151 " If the parameter was omitted it will be omitted here, too.";
153 static char reg_notification_doc[] = "register_notification(callback[, data][, name]) -> identifier\n"
155 "Register a callback function for notifications.\n"
156 "'callback' is a callable object that will be called every time a notification\n"
158 "'data' is an optional object that will be passed back to the callback\n"
159 " function every time it is called.\n"
160 "'name' is an optional identifier for this callback. The default name\n"
161 " is 'python.<module>'.\n"
162 " Every callback needs a unique identifier, so if you want to\n"
163 " register this callback multiple time from the same module you need\n"
164 " to specify a name here.\n"
165 "'identifier' is the full identifier assigned to this callback.\n"
167 "The callback function will be called with one or two parameters:\n"
168 "notification: A copy of the notification that was dispatched.\n"
169 "data: The optional data parameter passed to the register function.\n"
170 " If the parameter was omitted it will be omitted here, too.";
172 static char reg_flush_doc[] = "register_flush(callback[, data][, name]) -> identifier\n"
174 "Register a callback function for flush messages.\n"
175 "'callback' is a callable object that will be called every time a plugin\n"
176 " requests a flush for either this or all plugins.\n"
177 "'data' is an optional object that will be passed back to the callback\n"
178 " function every time it is called.\n"
179 "'name' is an optional identifier for this callback. The default name\n"
180 " is 'python.<module>'.\n"
181 " Every callback needs a unique identifier, so if you want to\n"
182 " register this callback multiple time from the same module you need\n"
183 " to specify a name here.\n"
184 "'identifier' is the full identifier assigned to this callback.\n"
186 "The callback function will be called with two or three parameters:\n"
187 "timeout: Indicates that only data older than 'timeout' seconds is to\n"
189 "id: Specifies which values are to be flushed.\n"
190 "data: The optional data parameter passed to the register function.\n"
191 " If the parameter was omitted it will be omitted here, too.";
193 static char reg_shutdown_doc[] = "register_shutdown(callback[, data][, name]) -> identifier\n"
195 "Register a callback function for collectd shutdown.\n"
196 "'callback' is a callable object that will be called once collectd is\n"
198 "'data' is an optional object that will be passed back to the callback\n"
199 " function if it is called.\n"
200 "'name' is an optional identifier for this callback. The default name\n"
201 " is 'python.<module>'.\n"
202 " Every callback needs a unique identifier, so if you want to\n"
203 " register this callback multiple time from the same module you need\n"
204 " to specify a name here.\n"
205 "'identifier' is the full identifier assigned to this callback.\n"
207 "The callback function will be called with no parameters except for\n"
208 " data if it was supplied.";
211 static int do_interactive = 0;
213 /* This is our global thread state. Python saves some stuff in thread-local
214 * storage. So if we allow the interpreter to run in the background
215 * (the scriptwriters might have created some threads from python), we have
216 * to save the state so we can resume it later after shutdown. */
218 static PyThreadState *state;
220 static PyObject *cpy_format_exception;
222 static cpy_callback_t *cpy_config_callbacks;
223 static cpy_callback_t *cpy_init_callbacks;
224 static cpy_callback_t *cpy_shutdown_callbacks;
226 static void cpy_destroy_user_data(void *data) {
227 cpy_callback_t *c = data;
229 Py_DECREF(c->callback);
234 /* You must hold the GIL to call this function!
235 * But if you managed to extract the callback parameter then you probably already do. */
237 static void cpy_build_name(char *buf, size_t size, PyObject *callback, const char *name) {
238 const char *module = NULL;
239 PyObject *mod = NULL;
242 snprintf(buf, size, "python.%s", name);
246 mod = PyObject_GetAttrString(callback, "__module__"); /* New reference. */
248 module = PyString_AsString(mod);
250 if (module != NULL) {
251 snprintf(buf, size, "python.%s", module);
258 snprintf(buf, size, "python.%p", callback);
262 static void cpy_log_exception(const char *context) {
264 const char *typename = NULL, *message = NULL;
265 PyObject *type, *value, *traceback, *tn, *m, *list;
267 PyErr_Fetch(&type, &value, &traceback);
268 PyErr_NormalizeException(&type, &value, &traceback);
269 if (type == NULL) return;
270 tn = PyObject_GetAttrString(type, "__name__"); /* New reference. */
271 m = PyObject_GetAttrString(value, "message"); /* New reference. */
273 typename = PyString_AsString(tn);
275 message = PyString_AsString(m);
276 if (typename == NULL)
277 typename = "NamelessException";
280 Py_BEGIN_ALLOW_THREADS
281 ERROR("Unhandled python exception in %s: %s: %s", context, typename, message);
285 if (!cpy_format_exception) {
289 Py_XDECREF(traceback);
296 list = PyObject_CallFunction(cpy_format_exception, "NNN", type, value, traceback); /* New reference. */
298 l = PyObject_Length(list);
299 for (i = 0; i < l; ++i) {
303 line = PyList_GET_ITEM(list, i); /* Borrowed reference. */
304 s = strdup(PyString_AsString(line));
305 if (s[strlen(s) - 1] == '\n')
306 s[strlen(s) - 1] = 0;
307 Py_BEGIN_ALLOW_THREADS
316 static int cpy_read_callback(user_data_t *data) {
317 cpy_callback_t *c = data->data;
321 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
323 cpy_log_exception("read callback");
333 static int cpy_write_callback(const data_set_t *ds, const value_list_t *value_list, user_data_t *data) {
335 cpy_callback_t *c = data->data;
336 PyObject *ret, *v, *list;
339 list = PyList_New(value_list->values_len); /* New reference. */
341 cpy_log_exception("write callback");
342 CPY_RETURN_FROM_THREADS 0;
344 for (i = 0; i < value_list->values_len; ++i) {
345 if (ds->ds->type == DS_TYPE_COUNTER) {
346 if ((long) value_list->values[i].counter == value_list->values[i].counter)
347 PyList_SetItem(list, i, PyInt_FromLong(value_list->values[i].counter));
349 PyList_SetItem(list, i, PyLong_FromUnsignedLongLong(value_list->values[i].counter));
350 } else if (ds->ds->type == DS_TYPE_GAUGE) {
351 PyList_SetItem(list, i, PyFloat_FromDouble(value_list->values[i].gauge));
352 } else if (ds->ds->type == DS_TYPE_DERIVE) {
353 if ((long) value_list->values[i].derive == value_list->values[i].derive)
354 PyList_SetItem(list, i, PyInt_FromLong(value_list->values[i].derive));
356 PyList_SetItem(list, i, PyLong_FromLongLong(value_list->values[i].derive));
357 } else if (ds->ds->type == DS_TYPE_ABSOLUTE) {
358 if ((long) value_list->values[i].absolute == value_list->values[i].absolute)
359 PyList_SetItem(list, i, PyInt_FromLong(value_list->values[i].absolute));
361 PyList_SetItem(list, i, PyLong_FromUnsignedLongLong(value_list->values[i].absolute));
363 Py_BEGIN_ALLOW_THREADS
364 ERROR("cpy_write_callback: Unknown value type %d.", ds->ds->type);
367 CPY_RETURN_FROM_THREADS 0;
369 if (PyErr_Occurred() != NULL) {
370 cpy_log_exception("value building for write callback");
371 CPY_RETURN_FROM_THREADS 0;
374 v = PyObject_CallFunction((void *) &ValuesType, "sOssssdi", value_list->type, list,
375 value_list->plugin_instance, value_list->type_instance, value_list->plugin,
376 value_list->host, (double) value_list->time, value_list->interval);
378 ret = PyObject_CallFunctionObjArgs(c->callback, v, c->data, (void *) 0); /* New reference. */
380 cpy_log_exception("write callback");
388 static int cpy_notification_callback(const notification_t *notification, user_data_t *data) {
389 cpy_callback_t *c = data->data;
393 n = PyObject_CallFunction((void *) &NotificationType, "ssssssdi", notification->type, notification->message,
394 notification->plugin_instance, notification->type_instance, notification->plugin,
395 notification->host, (double) notification->time, notification->severity);
396 ret = PyObject_CallFunctionObjArgs(c->callback, n, c->data, (void *) 0); /* New reference. */
398 cpy_log_exception("notification callback");
406 static void cpy_log_callback(int severity, const char *message, user_data_t *data) {
407 cpy_callback_t * c = data->data;
412 ret = PyObject_CallFunction(c->callback, "is", severity, message); /* New reference. */
414 ret = PyObject_CallFunction(c->callback, "isO", severity, message, c->data); /* New reference. */
418 /* Do we really want to trigger a log callback because a log callback failed?
421 /* In case someone wanted to be clever, replaced stderr and failed at that. */
429 static void cpy_flush_callback(int timeout, const char *id, user_data_t *data) {
430 cpy_callback_t * c = data->data;
435 ret = PyObject_CallFunction(c->callback, "is", timeout, id); /* New reference. */
437 ret = PyObject_CallFunction(c->callback, "isO", timeout, id, c->data); /* New reference. */
440 cpy_log_exception("flush callback");
447 static PyObject *cpy_register_generic(cpy_callback_t **list_head, PyObject *args, PyObject *kwds) {
450 const char *name = NULL;
451 PyObject *callback = NULL, *data = NULL, *mod = NULL;
452 static char *kwlist[] = {"callback", "data", "name", NULL};
454 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|Oz", kwlist, &callback, &data, &name) == 0) return NULL;
455 if (PyCallable_Check(callback) == 0) {
456 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
459 cpy_build_name(buf, sizeof(buf), callback, name);
463 c = malloc(sizeof(*c));
464 c->name = strdup(buf);
465 c->callback = callback;
467 c->next = *list_head;
470 return PyString_FromString(buf);
473 static PyObject *cpy_flush(cpy_callback_t **list_head, PyObject *args, PyObject *kwds) {
475 const char *plugin = NULL, *identifier = NULL;
476 static char *kwlist[] = {"plugin", "timeout", "identifier", NULL};
478 if (PyArg_ParseTupleAndKeywords(args, kwds, "|ziz", kwlist, &plugin, &timeout, &identifier) == 0) return NULL;
479 Py_BEGIN_ALLOW_THREADS
480 plugin_flush(plugin, timeout, identifier);
485 static PyObject *cpy_register_config(PyObject *self, PyObject *args, PyObject *kwds) {
486 return cpy_register_generic(&cpy_config_callbacks, args, kwds);
489 static PyObject *cpy_register_init(PyObject *self, PyObject *args, PyObject *kwds) {
490 return cpy_register_generic(&cpy_init_callbacks, args, kwds);
493 typedef int reg_function_t(const char *name, void *callback, void *data);
495 static PyObject *cpy_register_generic_userdata(void *reg, void *handler, PyObject *args, PyObject *kwds) {
497 reg_function_t *register_function = (reg_function_t *) reg;
498 cpy_callback_t *c = NULL;
499 user_data_t *user_data = NULL;
500 const char *name = NULL;
501 PyObject *callback = NULL, *data = NULL;
502 static char *kwlist[] = {"callback", "data", "name", NULL};
504 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|Oz", kwlist, &callback, &data, &name) == 0) return NULL;
505 if (PyCallable_Check(callback) == 0) {
506 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
509 cpy_build_name(buf, sizeof(buf), callback, name);
513 c = malloc(sizeof(*c));
514 c->name = strdup(buf);
515 c->callback = callback;
518 user_data = malloc(sizeof(*user_data));
519 user_data->free_func = cpy_destroy_user_data;
521 register_function(buf, handler, user_data);
522 return PyString_FromString(buf);
525 static PyObject *cpy_register_read(PyObject *self, PyObject *args, PyObject *kwds) {
527 cpy_callback_t *c = NULL;
528 user_data_t *user_data = NULL;
530 const char *name = NULL;
531 PyObject *callback = NULL, *data = NULL;
533 static char *kwlist[] = {"callback", "interval", "data", "name", NULL};
535 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|dOz", kwlist, &callback, &interval, &data, &name) == 0) return NULL;
536 if (PyCallable_Check(callback) == 0) {
537 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
540 cpy_build_name(buf, sizeof(buf), callback, name);
544 c = malloc(sizeof(*c));
545 c->name = strdup(buf);
546 c->callback = callback;
549 user_data = malloc(sizeof(*user_data));
550 user_data->free_func = cpy_destroy_user_data;
552 ts.tv_sec = interval;
553 ts.tv_nsec = (interval - ts.tv_sec) * 1000000000;
554 plugin_register_complex_read(buf, cpy_read_callback, &ts, user_data);
555 return PyString_FromString(buf);
558 static PyObject *cpy_register_log(PyObject *self, PyObject *args, PyObject *kwds) {
559 return cpy_register_generic_userdata((void *) plugin_register_log,
560 (void *) cpy_log_callback, args, kwds);
563 static PyObject *cpy_register_write(PyObject *self, PyObject *args, PyObject *kwds) {
564 return cpy_register_generic_userdata((void *) plugin_register_write,
565 (void *) cpy_write_callback, args, kwds);
568 static PyObject *cpy_register_notification(PyObject *self, PyObject *args, PyObject *kwds) {
569 return cpy_register_generic_userdata((void *) plugin_register_notification,
570 (void *) cpy_notification_callback, args, kwds);
573 static PyObject *cpy_register_flush(PyObject *self, PyObject *args, PyObject *kwds) {
574 return cpy_register_generic_userdata((void *) plugin_register_flush,
575 (void *) cpy_flush_callback, args, kwds);
578 static PyObject *cpy_register_shutdown(PyObject *self, PyObject *args, PyObject *kwds) {
579 return cpy_register_generic(&cpy_shutdown_callbacks, args, kwds);
582 static PyObject *cpy_error(PyObject *self, PyObject *args) {
584 if (PyArg_ParseTuple(args, "s", &text) == 0) return NULL;
585 Py_BEGIN_ALLOW_THREADS
586 plugin_log(LOG_ERR, "%s", text);
591 static PyObject *cpy_warning(PyObject *self, PyObject *args) {
593 if (PyArg_ParseTuple(args, "s", &text) == 0) return NULL;
594 Py_BEGIN_ALLOW_THREADS
595 plugin_log(LOG_WARNING, "%s", text);
600 static PyObject *cpy_notice(PyObject *self, PyObject *args) {
602 if (PyArg_ParseTuple(args, "s", &text) == 0) return NULL;
603 Py_BEGIN_ALLOW_THREADS
604 plugin_log(LOG_NOTICE, "%s", text);
609 static PyObject *cpy_info(PyObject *self, PyObject *args) {
611 if (PyArg_ParseTuple(args, "s", &text) == 0) return NULL;
612 Py_BEGIN_ALLOW_THREADS
613 plugin_log(LOG_INFO, "%s", text);
618 static PyObject *cpy_debug(PyObject *self, PyObject *args) {
621 if (PyArg_ParseTuple(args, "s", &text) == 0) return NULL;
622 Py_BEGIN_ALLOW_THREADS
623 plugin_log(LOG_DEBUG, "%s", text);
629 static PyObject *cpy_unregister_generic(cpy_callback_t **list_head, PyObject *arg, const char *desc) {
632 cpy_callback_t *prev = NULL, *tmp;
634 if (PyUnicode_Check(arg)) {
635 arg = PyUnicode_AsEncodedString(arg, NULL, NULL);
638 name = PyString_AsString(arg);
640 } else if (PyString_Check(arg)) {
641 name = PyString_AsString(arg);
643 if (!PyCallable_Check(arg)) {
644 PyErr_SetString(PyExc_TypeError, "This function needs a string or a callable object as its only parameter.");
647 cpy_build_name(buf, sizeof(buf), arg, NULL);
650 for (tmp = *list_head; tmp; prev = tmp, tmp = tmp->next)
651 if (strcmp(name, tmp->name) == 0)
655 PyErr_Format(PyExc_RuntimeError, "Unable to unregister %s callback '%s'.", desc, name);
658 /* Yes, this is actually save. To call this function the caller has to
659 * hold the GIL. Well, save as long as there is only one GIL anyway ... */
661 *list_head = tmp->next;
663 prev->next = tmp->next;
664 cpy_destroy_user_data(tmp);
668 typedef int cpy_unregister_function_t(const char *name);
670 static PyObject *cpy_unregister_generic_userdata(cpy_unregister_function_t *unreg, PyObject *arg, const char *desc) {
674 if (PyUnicode_Check(arg)) {
675 arg = PyUnicode_AsEncodedString(arg, NULL, NULL);
678 name = PyString_AsString(arg);
680 } else if (PyString_Check(arg)) {
681 name = PyString_AsString(arg);
683 if (!PyCallable_Check(arg)) {
684 PyErr_SetString(PyExc_TypeError, "This function needs a string or a callable object as its only parameter.");
687 cpy_build_name(buf, sizeof(buf), arg, NULL);
690 if (unreg(name) == 0)
692 PyErr_Format(PyExc_RuntimeError, "Unable to unregister %s callback '%s'.", desc, name);
696 static PyObject *cpy_unregister_log(PyObject *self, PyObject *arg) {
697 return cpy_unregister_generic_userdata(plugin_unregister_log, arg, "log");
700 static PyObject *cpy_unregister_init(PyObject *self, PyObject *arg) {
701 return cpy_unregister_generic(&cpy_init_callbacks, arg, "init");
704 static PyObject *cpy_unregister_config(PyObject *self, PyObject *arg) {
705 return cpy_unregister_generic(&cpy_config_callbacks, arg, "config");
708 static PyObject *cpy_unregister_read(PyObject *self, PyObject *arg) {
709 return cpy_unregister_generic_userdata(plugin_unregister_read, arg, "read");
712 static PyObject *cpy_unregister_write(PyObject *self, PyObject *arg) {
713 return cpy_unregister_generic_userdata(plugin_unregister_write, arg, "write");
716 static PyObject *cpy_unregister_notification(PyObject *self, PyObject *arg) {
717 return cpy_unregister_generic_userdata(plugin_unregister_notification, arg, "notification");
720 static PyObject *cpy_unregister_flush(PyObject *self, PyObject *arg) {
721 return cpy_unregister_generic_userdata(plugin_unregister_flush, arg, "flush");
724 static PyObject *cpy_unregister_shutdown(PyObject *self, PyObject *arg) {
725 return cpy_unregister_generic(&cpy_shutdown_callbacks, arg, "shutdown");
728 static PyMethodDef cpy_methods[] = {
729 {"debug", cpy_debug, METH_VARARGS, log_doc},
730 {"info", cpy_info, METH_VARARGS, log_doc},
731 {"notice", cpy_notice, METH_VARARGS, log_doc},
732 {"warning", cpy_warning, METH_VARARGS, log_doc},
733 {"error", cpy_error, METH_VARARGS, log_doc},
734 {"flush", (PyCFunction) cpy_flush, METH_VARARGS | METH_KEYWORDS, flush_doc},
735 {"register_log", (PyCFunction) cpy_register_log, METH_VARARGS | METH_KEYWORDS, reg_log_doc},
736 {"register_init", (PyCFunction) cpy_register_init, METH_VARARGS | METH_KEYWORDS, reg_init_doc},
737 {"register_config", (PyCFunction) cpy_register_config, METH_VARARGS | METH_KEYWORDS, reg_config_doc},
738 {"register_read", (PyCFunction) cpy_register_read, METH_VARARGS | METH_KEYWORDS, reg_read_doc},
739 {"register_write", (PyCFunction) cpy_register_write, METH_VARARGS | METH_KEYWORDS, reg_write_doc},
740 {"register_notification", (PyCFunction) cpy_register_notification, METH_VARARGS | METH_KEYWORDS, reg_notification_doc},
741 {"register_flush", (PyCFunction) cpy_register_flush, METH_VARARGS | METH_KEYWORDS, reg_flush_doc},
742 {"register_shutdown", (PyCFunction) cpy_register_shutdown, METH_VARARGS | METH_KEYWORDS, reg_shutdown_doc},
743 {"unregister_log", cpy_unregister_log, METH_O, unregister_doc},
744 {"unregister_init", cpy_unregister_init, METH_O, unregister_doc},
745 {"unregister_config", cpy_unregister_config, METH_O, unregister_doc},
746 {"unregister_read", cpy_unregister_read, METH_O, unregister_doc},
747 {"unregister_write", cpy_unregister_write, METH_O, unregister_doc},
748 {"unregister_notification", cpy_unregister_notification, METH_O, unregister_doc},
749 {"unregister_flush", cpy_unregister_flush, METH_O, unregister_doc},
750 {"unregister_shutdown", cpy_unregister_shutdown, METH_O, unregister_doc},
754 static int cpy_shutdown(void) {
758 /* This can happen if the module was loaded but not configured. */
760 PyEval_RestoreThread(state);
762 for (c = cpy_shutdown_callbacks; c; c = c->next) {
763 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
765 cpy_log_exception("shutdown callback");
774 static void cpy_int_handler(int sig) {
778 static void *cpy_interactive(void *data) {
780 struct sigaction sig_int_action, old;
782 /* Signal handler in a plugin? Bad stuff, but the best way to
783 * handle it I guess. In an interactive session people will
784 * press Ctrl+C at some time, which will generate a SIGINT.
785 * This will cause collectd to shutdown, thus killing the
786 * interactive interpreter, and leaving the terminal in a
787 * mess. Chances are, this isn't what the user wanted to do.
789 * So this is the plan:
790 * 1. Block SIGINT in the main thread.
791 * 2. Install our own signal handler that does nothing.
792 * 3. Unblock SIGINT in the interactive thread.
794 * This will make sure that SIGINT won't kill collectd but
795 * still interrupt syscalls like sleep and pause.
796 * It does not raise a KeyboardInterrupt exception because so
797 * far nobody managed to figure out how to do that. */
798 memset (&sig_int_action, '\0', sizeof (sig_int_action));
799 sig_int_action.sa_handler = cpy_int_handler;
800 sigaction (SIGINT, &sig_int_action, &old);
802 sigemptyset(&sigset);
803 sigaddset(&sigset, SIGINT);
804 pthread_sigmask(SIG_UNBLOCK, &sigset, NULL);
805 PyEval_AcquireThread(state);
806 if (PyImport_ImportModule("readline") == NULL) {
807 /* This interactive session will suck. */
808 cpy_log_exception("interactive session init");
810 PyRun_InteractiveLoop(stdin, "<stdin>");
812 PyEval_ReleaseThread(state);
813 NOTICE("python: Interactive interpreter exited, stopping collectd ...");
814 /* Restore the original collectd SIGINT handler and raise SIGINT.
815 * The main thread still has SIGINT blocked and there's nothing we
816 * can do about that so this thread will handle it. But that's not
817 * important, except that it won't interrupt the main loop and so
818 * it might take a few seconds before collectd really shuts down. */
819 sigaction (SIGINT, &old, NULL);
825 static int cpy_init(void) {
828 static pthread_t thread;
831 if (!Py_IsInitialized()) {
832 WARNING("python: Plugin loaded but not configured.");
833 plugin_unregister_shutdown("python");
836 PyEval_InitThreads();
837 /* Now it's finally OK to use python threads. */
838 for (c = cpy_init_callbacks; c; c = c->next) {
839 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
841 cpy_log_exception("init callback");
845 sigemptyset(&sigset);
846 sigaddset(&sigset, SIGINT);
847 pthread_sigmask(SIG_BLOCK, &sigset, NULL);
848 state = PyEval_SaveThread();
849 if (do_interactive) {
850 if (pthread_create(&thread, NULL, cpy_interactive, NULL)) {
851 ERROR("python: Error creating thread for interactive interpreter.");
858 static PyObject *cpy_oconfig_to_pyconfig(oconfig_item_t *ci, PyObject *parent) {
860 PyObject *item, *values, *children, *tmp;
865 values = PyTuple_New(ci->values_num); /* New reference. */
866 for (i = 0; i < ci->values_num; ++i) {
867 if (ci->values[i].type == OCONFIG_TYPE_STRING) {
868 PyTuple_SET_ITEM(values, i, PyString_FromString(ci->values[i].value.string));
869 } else if (ci->values[i].type == OCONFIG_TYPE_NUMBER) {
870 PyTuple_SET_ITEM(values, i, PyFloat_FromDouble(ci->values[i].value.number));
871 } else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN) {
872 PyTuple_SET_ITEM(values, i, PyBool_FromLong(ci->values[i].value.boolean));
876 item = PyObject_CallFunction((void *) &ConfigType, "sONO", ci->key, parent, values, Py_None);
879 children = PyTuple_New(ci->children_num); /* New reference. */
880 for (i = 0; i < ci->children_num; ++i) {
881 PyTuple_SET_ITEM(children, i, cpy_oconfig_to_pyconfig(ci->children + i, item));
883 tmp = ((Config *) item)->children;
884 ((Config *) item)->children = children;
889 static int cpy_config(oconfig_item_t *ci) {
895 /* Ok in theory we shouldn't do initialization at this point
896 * but we have to. In order to give python scripts a chance
897 * to register a config callback we need to be able to execute
898 * python code during the config callback so we have to start
899 * the interpreter here. */
900 /* Do *not* use the python "thread" module at this point! */
903 PyType_Ready(&ConfigType);
904 PyType_Ready(&PluginDataType);
905 ValuesType.tp_base = &PluginDataType;
906 PyType_Ready(&ValuesType);
907 NotificationType.tp_base = &PluginDataType;
908 PyType_Ready(&NotificationType);
909 sys = PyImport_ImportModule("sys"); /* New reference. */
911 cpy_log_exception("python initialization");
914 sys_path = PyObject_GetAttrString(sys, "path"); /* New reference. */
916 if (sys_path == NULL) {
917 cpy_log_exception("python initialization");
920 module = Py_InitModule("collectd", cpy_methods); /* Borrowed reference. */
921 PyModule_AddObject(module, "Config", (void *) &ConfigType); /* Steals a reference. */
922 PyModule_AddObject(module, "Values", (void *) &ValuesType); /* Steals a reference. */
923 PyModule_AddObject(module, "Notification", (void *) &NotificationType); /* Steals a reference. */
924 PyModule_AddIntConstant(module, "LOG_DEBUG", LOG_DEBUG);
925 PyModule_AddIntConstant(module, "LOG_INFO", LOG_INFO);
926 PyModule_AddIntConstant(module, "LOG_NOTICE", LOG_NOTICE);
927 PyModule_AddIntConstant(module, "LOG_WARNING", LOG_WARNING);
928 PyModule_AddIntConstant(module, "LOG_ERROR", LOG_ERR);
929 PyModule_AddIntConstant(module, "NOTIF_FAILURE", NOTIF_FAILURE);
930 PyModule_AddIntConstant(module, "NOTIF_WARNING", NOTIF_WARNING);
931 PyModule_AddIntConstant(module, "NOTIF_OKAY", NOTIF_OKAY);
932 for (i = 0; i < ci->children_num; ++i) {
933 oconfig_item_t *item = ci->children + i;
935 if (strcasecmp(item->key, "Interactive") == 0) {
936 if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_BOOLEAN)
938 do_interactive = item->values[0].value.boolean;
939 } else if (strcasecmp(item->key, "Encoding") == 0) {
940 if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_STRING)
942 /* Why is this even necessary? And undocumented? */
943 if (PyUnicode_SetDefaultEncoding(item->values[0].value.string))
944 cpy_log_exception("setting default encoding");
945 } else if (strcasecmp(item->key, "LogTraces") == 0) {
946 if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_BOOLEAN)
948 if (!item->values[0].value.boolean) {
949 Py_XDECREF(cpy_format_exception);
950 cpy_format_exception = NULL;
953 if (cpy_format_exception)
955 tb = PyImport_ImportModule("traceback"); /* New reference. */
957 cpy_log_exception("python initialization");
960 cpy_format_exception = PyObject_GetAttrString(tb, "format_exception"); /* New reference. */
962 if (cpy_format_exception == NULL)
963 cpy_log_exception("python initialization");
964 } else if (strcasecmp(item->key, "ModulePath") == 0) {
966 PyObject *dir_object;
968 if (cf_util_get_string(item, &dir) != 0)
970 dir_object = PyString_FromString(dir); /* New reference. */
971 if (dir_object == NULL) {
972 ERROR("python plugin: Unable to convert \"%s\" to "
973 "a python object.", dir);
975 cpy_log_exception("python initialization");
978 if (PyList_Append(sys_path, dir_object) != 0) {
979 ERROR("python plugin: Unable to append \"%s\" to "
980 "python module path.", dir);
981 cpy_log_exception("python initialization");
983 Py_DECREF(dir_object);
985 } else if (strcasecmp(item->key, "Import") == 0) {
986 char *module_name = NULL;
989 if (cf_util_get_string(item, &module_name) != 0)
991 module = PyImport_ImportModule(module_name); /* New reference. */
992 if (module == NULL) {
993 ERROR("python plugin: Error importing module \"%s\".", module_name);
994 cpy_log_exception("importing module");
999 } else if (strcasecmp(item->key, "Module") == 0) {
1004 if (cf_util_get_string(item, &name) != 0)
1006 for (c = cpy_config_callbacks; c; c = c->next) {
1007 if (strcasecmp(c->name + 7, name) == 0)
1011 WARNING("python plugin: Found a configuration for the \"%s\" plugin, "
1012 "but the plugin isn't loaded or didn't register "
1013 "a configuration callback.", name);
1018 if (c->data == NULL)
1019 ret = PyObject_CallFunction(c->callback, "N",
1020 cpy_oconfig_to_pyconfig(item, NULL)); /* New reference. */
1022 ret = PyObject_CallFunction(c->callback, "NO",
1023 cpy_oconfig_to_pyconfig(item, NULL), c->data); /* New reference. */
1025 cpy_log_exception("loading module");
1029 WARNING("python plugin: Ignoring unknown config key \"%s\".", item->key);
1032 Py_DECREF(sys_path);
1036 void module_register(void) {
1037 plugin_register_complex_config("python", cpy_config);
1038 plugin_register_init("python", cpy_init);
1039 plugin_register_shutdown("python", cpy_shutdown);