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>
38 typedef struct cpy_callback_s {
42 struct cpy_callback_s *next;
45 static char log_doc[] = "This function sends a string to all logging plugins.";
47 static char get_ds_doc[] = "get_dataset(name) -> definition\n"
49 "Returns the definition of a dataset specified by name.\n"
51 "'name' is a string specifying the dataset to query.\n"
52 "'definition' is a list of 4-tuples. Every tuple represents a \n"
53 " data source within the data set and its 4 values are the \n"
54 " name, type, min and max value.\n"
55 " 'name' is a string.\n"
56 " 'type' is a string that is equal to either DS_TYPE_COUNTER,\n"
57 " DS_TYPE_GAUGE, DS_TYPE_DERIVE or DS_TYPE_ABSOLUTE.\n"
58 " 'min' and 'max' are either a float or None.";
60 static char flush_doc[] = "flush([plugin][, timeout][, identifier]) -> None\n"
62 "Flushes the cache of another plugin.";
64 static char unregister_doc[] = "Unregisters a callback. This function needs exactly one parameter either\n"
65 "the function to unregister or the callback identifier to unregister.";
67 static char reg_log_doc[] = "register_log(callback[, data][, name]) -> identifier\n"
69 "Register a callback function for log messages.\n"
71 "'callback' is a callable object that will be called every time something\n"
73 "'data' is an optional object that will be passed back to the callback\n"
74 " function every time it is called.\n"
75 "'name' is an optional identifier for this callback. The default name\n"
76 " is 'python.<module>'.\n"
77 " Every callback needs a unique identifier, so if you want to\n"
78 " register this callback multiple time from the same module you need\n"
79 " to specify a name here.\n"
80 "'identifier' is the full identifier assigned to this callback.\n"
82 "The callback function will be called with two or three parameters:\n"
83 "severity: An integer that should be compared to the LOG_ constants.\n"
84 "message: The text to be logged.\n"
85 "data: The optional data parameter passed to the register function.\n"
86 " If the parameter was omitted it will be omitted here, too.";
88 static char reg_init_doc[] = "register_init(callback[, data][, name]) -> identifier\n"
90 "Register a callback function that will be executed once after the config.\n"
91 "file has been read, all plugins heve been loaded and the collectd has\n"
92 "forked into the background.\n"
94 "'callback' is a callable object that will be executed.\n"
95 "'data' is an optional object that will be passed back to the callback\n"
96 " function when it is called.\n"
97 "'name' is an optional identifier for this callback. The default name\n"
98 " is 'python.<module>'.\n"
99 " Every callback needs a unique identifier, so if you want to\n"
100 " register this callback multiple time from the same module you need\n"
101 " to specify a name here.\n"
102 "'identifier' is the full identifier assigned to this callback.\n"
104 "The callback function will be called without parameters, except for\n"
105 "data if it was supplied.";
107 static char reg_config_doc[] = "register_config(callback[, data][, name]) -> identifier\n"
109 "Register a callback function for config file entries.\n"
110 "'callback' is a callable object that will be called for every config block.\n"
111 "'data' is an optional object that will be passed back to the callback\n"
112 " function every time it is called.\n"
113 "'name' is an optional identifier for this callback. The default name\n"
114 " is 'python.<module>'.\n"
115 " Every callback needs a unique identifier, so if you want to\n"
116 " register this callback multiple time from the same module you need\n"
117 " to specify a name here.\n"
118 "'identifier' is the full identifier assigned to this callback.\n"
120 "The callback function will be called with one or two parameters:\n"
121 "config: A Config object.\n"
122 "data: The optional data parameter passed to the register function.\n"
123 " If the parameter was omitted it will be omitted here, too.";
125 static char reg_read_doc[] = "register_read(callback[, interval][, data][, name]) -> identifier\n"
127 "Register a callback function for reading data. It will just be called\n"
128 "in a fixed interval to signal that it's time to dispatch new values.\n"
129 "'callback' is a callable object that will be called every time something\n"
131 "'interval' is the number of seconds between between calls to the callback\n"
132 " function. Full float precision is supported here.\n"
133 "'data' is an optional object that will be passed back to the callback\n"
134 " function every time it is called.\n"
135 "'name' is an optional identifier for this callback. The default name\n"
136 " is 'python.<module>'.\n"
137 " Every callback needs a unique identifier, so if you want to\n"
138 " register this callback multiple time from the same module you need\n"
139 " to specify a name here.\n"
140 "'identifier' is the full identifier assigned to this callback.\n"
142 "The callback function will be called without parameters, except for\n"
143 "data if it was supplied.";
145 static char reg_write_doc[] = "register_write(callback[, data][, name]) -> identifier\n"
147 "Register a callback function to receive values dispatched by other plugins.\n"
148 "'callback' is a callable object that will be called every time a value\n"
150 "'data' is an optional object that will be passed back to the callback\n"
151 " function every time it is called.\n"
152 "'name' is an optional identifier for this callback. The default name\n"
153 " is 'python.<module>'.\n"
154 " Every callback needs a unique identifier, so if you want to\n"
155 " register this callback multiple time from the same module you need\n"
156 " to specify a name here.\n"
157 "'identifier' is the full identifier assigned to this callback.\n"
159 "The callback function will be called with one or two parameters:\n"
160 "values: A Values object which is a copy of the dispatched values.\n"
161 "data: The optional data parameter passed to the register function.\n"
162 " If the parameter was omitted it will be omitted here, too.";
164 static char reg_notification_doc[] = "register_notification(callback[, data][, name]) -> identifier\n"
166 "Register a callback function for notifications.\n"
167 "'callback' is a callable object that will be called every time a notification\n"
169 "'data' is an optional object that will be passed back to the callback\n"
170 " function every time it is called.\n"
171 "'name' is an optional identifier for this callback. The default name\n"
172 " is 'python.<module>'.\n"
173 " Every callback needs a unique identifier, so if you want to\n"
174 " register this callback multiple time from the same module you need\n"
175 " to specify a name here.\n"
176 "'identifier' is the full identifier assigned to this callback.\n"
178 "The callback function will be called with one or two parameters:\n"
179 "notification: A copy of the notification that was dispatched.\n"
180 "data: The optional data parameter passed to the register function.\n"
181 " If the parameter was omitted it will be omitted here, too.";
183 static char reg_flush_doc[] = "register_flush(callback[, data][, name]) -> identifier\n"
185 "Register a callback function for flush messages.\n"
186 "'callback' is a callable object that will be called every time a plugin\n"
187 " requests a flush for either this or all plugins.\n"
188 "'data' is an optional object that will be passed back to the callback\n"
189 " function every time it is called.\n"
190 "'name' is an optional identifier for this callback. The default name\n"
191 " is 'python.<module>'.\n"
192 " Every callback needs a unique identifier, so if you want to\n"
193 " register this callback multiple time from the same module you need\n"
194 " to specify a name here.\n"
195 "'identifier' is the full identifier assigned to this callback.\n"
197 "The callback function will be called with two or three parameters:\n"
198 "timeout: Indicates that only data older than 'timeout' seconds is to\n"
200 "id: Specifies which values are to be flushed.\n"
201 "data: The optional data parameter passed to the register function.\n"
202 " If the parameter was omitted it will be omitted here, too.";
204 static char reg_shutdown_doc[] = "register_shutdown(callback[, data][, name]) -> identifier\n"
206 "Register a callback function for collectd shutdown.\n"
207 "'callback' is a callable object that will be called once collectd is\n"
209 "'data' is an optional object that will be passed back to the callback\n"
210 " function if it is called.\n"
211 "'name' is an optional identifier for this callback. The default name\n"
212 " is 'python.<module>'.\n"
213 " Every callback needs a unique identifier, so if you want to\n"
214 " register this callback multiple time from the same module you need\n"
215 " to specify a name here.\n"
216 "'identifier' is the full identifier assigned to this callback.\n"
218 "The callback function will be called with no parameters except for\n"
219 " data if it was supplied.";
222 static pthread_t main_thread;
223 static PyOS_sighandler_t python_sigint_handler;
224 static _Bool do_interactive = 0;
226 /* This is our global thread state. Python saves some stuff in thread-local
227 * storage. So if we allow the interpreter to run in the background
228 * (the scriptwriters might have created some threads from python), we have
229 * to save the state so we can resume it later after shutdown. */
231 static PyThreadState *state;
233 static PyObject *sys_path, *cpy_format_exception;
235 static cpy_callback_t *cpy_config_callbacks;
236 static cpy_callback_t *cpy_init_callbacks;
237 static cpy_callback_t *cpy_shutdown_callbacks;
239 static void cpy_destroy_user_data(void *data) {
240 cpy_callback_t *c = data;
243 Py_DECREF(c->callback);
249 /* You must hold the GIL to call this function!
250 * But if you managed to extract the callback parameter then you probably already do. */
252 static void cpy_build_name(char *buf, size_t size, PyObject *callback, const char *name) {
253 const char *module = NULL;
254 PyObject *mod = NULL;
257 snprintf(buf, size, "python.%s", name);
261 mod = PyObject_GetAttrString(callback, "__module__"); /* New reference. */
263 module = cpy_unicode_or_bytes_to_string(&mod);
265 if (module != NULL) {
266 snprintf(buf, size, "python.%s", module);
273 snprintf(buf, size, "python.%p", callback);
277 void cpy_log_exception(const char *context) {
279 const char *typename = NULL, *message = NULL;
280 PyObject *type, *value, *traceback, *tn, *m, *list;
282 PyErr_Fetch(&type, &value, &traceback);
283 PyErr_NormalizeException(&type, &value, &traceback);
284 if (type == NULL) return;
285 tn = PyObject_GetAttrString(type, "__name__"); /* New reference. */
286 m = PyObject_Str(value); /* New reference. */
288 typename = cpy_unicode_or_bytes_to_string(&tn);
290 message = cpy_unicode_or_bytes_to_string(&m);
291 if (typename == NULL)
292 typename = "NamelessException";
295 Py_BEGIN_ALLOW_THREADS
296 ERROR("Unhandled python exception in %s: %s: %s", context, typename, message);
300 if (!cpy_format_exception || !traceback) {
304 Py_XDECREF(traceback);
307 list = PyObject_CallFunction(cpy_format_exception, "NNN", type, value, traceback); /* New reference. Steals references from "type", "value" and "traceback". */
309 l = PyObject_Length(list);
311 for (int i = 0; i < l; ++i) {
316 line = PyList_GET_ITEM(list, i); /* Borrowed reference. */
319 msg = cpy_unicode_or_bytes_to_string(&line);
328 if (cpy[strlen(cpy) - 1] == '\n')
329 cpy[strlen(cpy) - 1] = 0;
331 Py_BEGIN_ALLOW_THREADS
342 static int cpy_read_callback(user_data_t *data) {
343 cpy_callback_t *c = data->data;
347 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
349 cpy_log_exception("read callback");
359 static int cpy_write_callback(const data_set_t *ds, const value_list_t *value_list, user_data_t *data) {
360 cpy_callback_t *c = data->data;
361 PyObject *ret, *list, *temp, *dict = NULL;
365 list = PyList_New(value_list->values_len); /* New reference. */
367 cpy_log_exception("write callback");
368 CPY_RETURN_FROM_THREADS 0;
370 for (size_t i = 0; i < value_list->values_len; ++i) {
371 if (ds->ds[i].type == DS_TYPE_COUNTER) {
372 PyList_SetItem(list, i, PyLong_FromUnsignedLongLong(value_list->values[i].counter));
373 } else if (ds->ds[i].type == DS_TYPE_GAUGE) {
374 PyList_SetItem(list, i, PyFloat_FromDouble(value_list->values[i].gauge));
375 } else if (ds->ds[i].type == DS_TYPE_DERIVE) {
376 PyList_SetItem(list, i, PyLong_FromLongLong(value_list->values[i].derive));
377 } else if (ds->ds[i].type == DS_TYPE_ABSOLUTE) {
378 PyList_SetItem(list, i, PyLong_FromUnsignedLongLong(value_list->values[i].absolute));
380 Py_BEGIN_ALLOW_THREADS
381 ERROR("cpy_write_callback: Unknown value type %d.", ds->ds[i].type);
384 CPY_RETURN_FROM_THREADS 0;
386 if (PyErr_Occurred() != NULL) {
387 cpy_log_exception("value building for write callback");
389 CPY_RETURN_FROM_THREADS 0;
392 dict = PyDict_New(); /* New reference. */
393 if (value_list->meta) {
395 meta_data_t *meta = value_list->meta;
397 int num = meta_data_toc(meta, &table);
398 for (int i = 0; i < num; ++i) {
406 type = meta_data_type(meta, table[i]);
407 if (type == MD_TYPE_STRING) {
408 if (meta_data_get_string(meta, table[i], &string))
410 temp = cpy_string_to_unicode_or_bytes(string); /* New reference. */
412 PyDict_SetItemString(dict, table[i], temp);
414 } else if (type == MD_TYPE_SIGNED_INT) {
415 if (meta_data_get_signed_int(meta, table[i], &si))
417 temp = PyObject_CallFunctionObjArgs((void *) &SignedType, PyLong_FromLongLong(si), (void *) 0); /* New reference. */
418 PyDict_SetItemString(dict, table[i], temp);
420 } else if (type == MD_TYPE_UNSIGNED_INT) {
421 if (meta_data_get_unsigned_int(meta, table[i], &ui))
423 temp = PyObject_CallFunctionObjArgs((void *) &UnsignedType, PyLong_FromUnsignedLongLong(ui), (void *) 0); /* New reference. */
424 PyDict_SetItemString(dict, table[i], temp);
426 } else if (type == MD_TYPE_DOUBLE) {
427 if (meta_data_get_double(meta, table[i], &d))
429 temp = PyFloat_FromDouble(d); /* New reference. */
430 PyDict_SetItemString(dict, table[i], temp);
432 } else if (type == MD_TYPE_BOOLEAN) {
433 if (meta_data_get_boolean(meta, table[i], &b))
436 PyDict_SetItemString(dict, table[i], Py_True);
438 PyDict_SetItemString(dict, table[i], Py_False);
444 v = (Values *) Values_New(); /* New reference. */
445 sstrncpy(v->data.host, value_list->host, sizeof(v->data.host));
446 sstrncpy(v->data.type, value_list->type, sizeof(v->data.type));
447 sstrncpy(v->data.type_instance, value_list->type_instance, sizeof(v->data.type_instance));
448 sstrncpy(v->data.plugin, value_list->plugin, sizeof(v->data.plugin));
449 sstrncpy(v->data.plugin_instance, value_list->plugin_instance, sizeof(v->data.plugin_instance));
450 v->data.time = CDTIME_T_TO_DOUBLE(value_list->time);
451 v->interval = CDTIME_T_TO_DOUBLE(value_list->interval);
455 v->meta = dict; /* Steals a reference. */
456 ret = PyObject_CallFunctionObjArgs(c->callback, v, c->data, (void *) 0); /* New reference. */
459 cpy_log_exception("write callback");
467 static int cpy_notification_callback(const notification_t *notification, user_data_t *data) {
468 cpy_callback_t *c = data->data;
469 PyObject *ret, *notify;
473 notify = Notification_New(); /* New reference. */
474 n = (Notification *) notify;
475 sstrncpy(n->data.host, notification->host, sizeof(n->data.host));
476 sstrncpy(n->data.type, notification->type, sizeof(n->data.type));
477 sstrncpy(n->data.type_instance, notification->type_instance, sizeof(n->data.type_instance));
478 sstrncpy(n->data.plugin, notification->plugin, sizeof(n->data.plugin));
479 sstrncpy(n->data.plugin_instance, notification->plugin_instance, sizeof(n->data.plugin_instance));
480 n->data.time = CDTIME_T_TO_DOUBLE(notification->time);
481 sstrncpy(n->message, notification->message, sizeof(n->message));
482 n->severity = notification->severity;
483 ret = PyObject_CallFunctionObjArgs(c->callback, n, c->data, (void *) 0); /* New reference. */
486 cpy_log_exception("notification callback");
494 static void cpy_log_callback(int severity, const char *message, user_data_t *data) {
495 cpy_callback_t * c = data->data;
496 PyObject *ret, *text;
499 text = cpy_string_to_unicode_or_bytes(message); /* New reference. */
501 ret = PyObject_CallFunction(c->callback, "iN", severity, text); /* New reference. Steals a reference from "text". */
503 ret = PyObject_CallFunction(c->callback, "iNO", severity, text, c->data); /* New reference. Steals a reference from "text". */
507 /* Do we really want to trigger a log callback because a log callback failed?
510 /* In case someone wanted to be clever, replaced stderr and failed at that. */
518 static void cpy_flush_callback(int timeout, const char *id, user_data_t *data) {
519 cpy_callback_t * c = data->data;
520 PyObject *ret, *text;
523 text = cpy_string_to_unicode_or_bytes(id);
525 ret = PyObject_CallFunction(c->callback, "iN", timeout, text); /* New reference. */
527 ret = PyObject_CallFunction(c->callback, "iNO", timeout, text, c->data); /* New reference. */
530 cpy_log_exception("flush callback");
537 static PyObject *cpy_register_generic(cpy_callback_t **list_head, PyObject *args, PyObject *kwds) {
541 PyObject *callback = NULL, *data = NULL, *mod = NULL;
542 static char *kwlist[] = {"callback", "data", "name", NULL};
544 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|Oet", kwlist, &callback, &data, NULL, &name) == 0) return NULL;
545 if (PyCallable_Check(callback) == 0) {
547 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
550 cpy_build_name(buf, sizeof(buf), callback, name);
555 c = calloc(1, sizeof(*c));
559 c->name = strdup(buf);
560 c->callback = callback;
562 c->next = *list_head;
566 return cpy_string_to_unicode_or_bytes(buf);
569 static PyObject *float_or_none(float number) {
573 return PyFloat_FromDouble(number);
576 static PyObject *cpy_get_dataset(PyObject *self, PyObject *args) {
578 const data_set_t *ds;
579 PyObject *list, *tuple;
581 if (PyArg_ParseTuple(args, "et", NULL, &name) == 0) return NULL;
582 ds = plugin_get_ds(name);
585 PyErr_Format(PyExc_TypeError, "Dataset %s not found", name);
588 list = PyList_New(ds->ds_num); /* New reference. */
589 for (size_t i = 0; i < ds->ds_num; ++i) {
590 tuple = PyTuple_New(4);
591 PyTuple_SET_ITEM(tuple, 0, cpy_string_to_unicode_or_bytes(ds->ds[i].name));
592 PyTuple_SET_ITEM(tuple, 1, cpy_string_to_unicode_or_bytes(DS_TYPE_TO_STRING(ds->ds[i].type)));
593 PyTuple_SET_ITEM(tuple, 2, float_or_none(ds->ds[i].min));
594 PyTuple_SET_ITEM(tuple, 3, float_or_none(ds->ds[i].max));
595 PyList_SET_ITEM(list, i, tuple);
600 static PyObject *cpy_flush(PyObject *self, PyObject *args, PyObject *kwds) {
602 char *plugin = NULL, *identifier = NULL;
603 static char *kwlist[] = {"plugin", "timeout", "identifier", NULL};
605 if (PyArg_ParseTupleAndKeywords(args, kwds, "|etiet", kwlist, NULL, &plugin, &timeout, NULL, &identifier) == 0) return NULL;
606 Py_BEGIN_ALLOW_THREADS
607 plugin_flush(plugin, timeout, identifier);
610 PyMem_Free(identifier);
614 static PyObject *cpy_register_config(PyObject *self, PyObject *args, PyObject *kwds) {
615 return cpy_register_generic(&cpy_config_callbacks, args, kwds);
618 static PyObject *cpy_register_init(PyObject *self, PyObject *args, PyObject *kwds) {
619 return cpy_register_generic(&cpy_init_callbacks, args, kwds);
622 typedef int reg_function_t(const char *name, void *callback, void *data);
624 static PyObject *cpy_register_generic_userdata(void *reg, void *handler, PyObject *args, PyObject *kwds) {
626 reg_function_t *register_function = (reg_function_t *) reg;
627 cpy_callback_t *c = NULL;
629 PyObject *callback = NULL, *data = NULL;
630 static char *kwlist[] = {"callback", "data", "name", NULL};
632 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|Oet", kwlist, &callback, &data, NULL, &name) == 0) return NULL;
633 if (PyCallable_Check(callback) == 0) {
635 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
638 cpy_build_name(buf, sizeof(buf), callback, name);
644 c = calloc(1, sizeof(*c));
648 c->name = strdup(buf);
649 c->callback = callback;
653 user_data_t user_data = {
655 .free_func = cpy_destroy_user_data
658 register_function(buf, handler, &user_data);
659 return cpy_string_to_unicode_or_bytes(buf);
662 static PyObject *cpy_register_read(PyObject *self, PyObject *args, PyObject *kwds) {
664 cpy_callback_t *c = NULL;
667 PyObject *callback = NULL, *data = NULL;
668 static char *kwlist[] = {"callback", "interval", "data", "name", NULL};
670 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|dOet", kwlist, &callback, &interval, &data, NULL, &name) == 0) return NULL;
671 if (PyCallable_Check(callback) == 0) {
673 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
676 cpy_build_name(buf, sizeof(buf), callback, name);
682 c = calloc(1, sizeof(*c));
686 c->name = strdup(buf);
687 c->callback = callback;
691 user_data_t user_data = {
693 .free_func = cpy_destroy_user_data
696 plugin_register_complex_read(/* group = */ "python", buf,
697 cpy_read_callback, DOUBLE_TO_CDTIME_T (interval), &user_data);
698 return cpy_string_to_unicode_or_bytes(buf);
701 static PyObject *cpy_register_log(PyObject *self, PyObject *args, PyObject *kwds) {
702 return cpy_register_generic_userdata((void *) plugin_register_log,
703 (void *) cpy_log_callback, args, kwds);
706 static PyObject *cpy_register_write(PyObject *self, PyObject *args, PyObject *kwds) {
707 return cpy_register_generic_userdata((void *) plugin_register_write,
708 (void *) cpy_write_callback, args, kwds);
711 static PyObject *cpy_register_notification(PyObject *self, PyObject *args, PyObject *kwds) {
712 return cpy_register_generic_userdata((void *) plugin_register_notification,
713 (void *) cpy_notification_callback, args, kwds);
716 static PyObject *cpy_register_flush(PyObject *self, PyObject *args, PyObject *kwds) {
717 return cpy_register_generic_userdata((void *) plugin_register_flush,
718 (void *) cpy_flush_callback, args, kwds);
721 static PyObject *cpy_register_shutdown(PyObject *self, PyObject *args, PyObject *kwds) {
722 return cpy_register_generic(&cpy_shutdown_callbacks, args, kwds);
725 static PyObject *cpy_error(PyObject *self, PyObject *args) {
727 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
728 Py_BEGIN_ALLOW_THREADS
729 plugin_log(LOG_ERR, "%s", text);
735 static PyObject *cpy_warning(PyObject *self, PyObject *args) {
737 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
738 Py_BEGIN_ALLOW_THREADS
739 plugin_log(LOG_WARNING, "%s", text);
745 static PyObject *cpy_notice(PyObject *self, PyObject *args) {
747 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
748 Py_BEGIN_ALLOW_THREADS
749 plugin_log(LOG_NOTICE, "%s", text);
755 static PyObject *cpy_info(PyObject *self, PyObject *args) {
757 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
758 Py_BEGIN_ALLOW_THREADS
759 plugin_log(LOG_INFO, "%s", text);
765 static PyObject *cpy_debug(PyObject *self, PyObject *args) {
768 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
769 Py_BEGIN_ALLOW_THREADS
770 plugin_log(LOG_DEBUG, "%s", text);
777 static PyObject *cpy_unregister_generic(cpy_callback_t **list_head, PyObject *arg, const char *desc) {
780 cpy_callback_t *prev = NULL, *tmp;
783 name = cpy_unicode_or_bytes_to_string(&arg);
786 if (!PyCallable_Check(arg)) {
787 PyErr_SetString(PyExc_TypeError, "This function needs a string or a callable object as its only parameter.");
791 cpy_build_name(buf, sizeof(buf), arg, NULL);
794 for (tmp = *list_head; tmp; prev = tmp, tmp = tmp->next)
795 if (strcmp(name, tmp->name) == 0)
800 PyErr_Format(PyExc_RuntimeError, "Unable to unregister %s callback '%s'.", desc, name);
803 /* Yes, this is actually save. To call this function the caller has to
804 * hold the GIL. Well, save as long as there is only one GIL anyway ... */
806 *list_head = tmp->next;
808 prev->next = tmp->next;
809 cpy_destroy_user_data(tmp);
813 typedef int cpy_unregister_function_t(const char *name);
815 static PyObject *cpy_unregister_generic_userdata(cpy_unregister_function_t *unreg, PyObject *arg, const char *desc) {
820 name = cpy_unicode_or_bytes_to_string(&arg);
823 if (!PyCallable_Check(arg)) {
824 PyErr_SetString(PyExc_TypeError, "This function needs a string or a callable object as its only parameter.");
828 cpy_build_name(buf, sizeof(buf), arg, NULL);
831 if (unreg(name) == 0) {
835 PyErr_Format(PyExc_RuntimeError, "Unable to unregister %s callback '%s'.", desc, name);
840 static PyObject *cpy_unregister_log(PyObject *self, PyObject *arg) {
841 return cpy_unregister_generic_userdata(plugin_unregister_log, arg, "log");
844 static PyObject *cpy_unregister_init(PyObject *self, PyObject *arg) {
845 return cpy_unregister_generic(&cpy_init_callbacks, arg, "init");
848 static PyObject *cpy_unregister_config(PyObject *self, PyObject *arg) {
849 return cpy_unregister_generic(&cpy_config_callbacks, arg, "config");
852 static PyObject *cpy_unregister_read(PyObject *self, PyObject *arg) {
853 return cpy_unregister_generic_userdata(plugin_unregister_read, arg, "read");
856 static PyObject *cpy_unregister_write(PyObject *self, PyObject *arg) {
857 return cpy_unregister_generic_userdata(plugin_unregister_write, arg, "write");
860 static PyObject *cpy_unregister_notification(PyObject *self, PyObject *arg) {
861 return cpy_unregister_generic_userdata(plugin_unregister_notification, arg, "notification");
864 static PyObject *cpy_unregister_flush(PyObject *self, PyObject *arg) {
865 return cpy_unregister_generic_userdata(plugin_unregister_flush, arg, "flush");
868 static PyObject *cpy_unregister_shutdown(PyObject *self, PyObject *arg) {
869 return cpy_unregister_generic(&cpy_shutdown_callbacks, arg, "shutdown");
872 static PyMethodDef cpy_methods[] = {
873 {"debug", cpy_debug, METH_VARARGS, log_doc},
874 {"info", cpy_info, METH_VARARGS, log_doc},
875 {"notice", cpy_notice, METH_VARARGS, log_doc},
876 {"warning", cpy_warning, METH_VARARGS, log_doc},
877 {"error", cpy_error, METH_VARARGS, log_doc},
878 {"get_dataset", (PyCFunction) cpy_get_dataset, METH_VARARGS, get_ds_doc},
879 {"flush", (PyCFunction) cpy_flush, METH_VARARGS | METH_KEYWORDS, flush_doc},
880 {"register_log", (PyCFunction) cpy_register_log, METH_VARARGS | METH_KEYWORDS, reg_log_doc},
881 {"register_init", (PyCFunction) cpy_register_init, METH_VARARGS | METH_KEYWORDS, reg_init_doc},
882 {"register_config", (PyCFunction) cpy_register_config, METH_VARARGS | METH_KEYWORDS, reg_config_doc},
883 {"register_read", (PyCFunction) cpy_register_read, METH_VARARGS | METH_KEYWORDS, reg_read_doc},
884 {"register_write", (PyCFunction) cpy_register_write, METH_VARARGS | METH_KEYWORDS, reg_write_doc},
885 {"register_notification", (PyCFunction) cpy_register_notification, METH_VARARGS | METH_KEYWORDS, reg_notification_doc},
886 {"register_flush", (PyCFunction) cpy_register_flush, METH_VARARGS | METH_KEYWORDS, reg_flush_doc},
887 {"register_shutdown", (PyCFunction) cpy_register_shutdown, METH_VARARGS | METH_KEYWORDS, reg_shutdown_doc},
888 {"unregister_log", cpy_unregister_log, METH_O, unregister_doc},
889 {"unregister_init", cpy_unregister_init, METH_O, unregister_doc},
890 {"unregister_config", cpy_unregister_config, METH_O, unregister_doc},
891 {"unregister_read", cpy_unregister_read, METH_O, unregister_doc},
892 {"unregister_write", cpy_unregister_write, METH_O, unregister_doc},
893 {"unregister_notification", cpy_unregister_notification, METH_O, unregister_doc},
894 {"unregister_flush", cpy_unregister_flush, METH_O, unregister_doc},
895 {"unregister_shutdown", cpy_unregister_shutdown, METH_O, unregister_doc},
899 static int cpy_shutdown(void) {
902 /* This can happen if the module was loaded but not configured. */
904 PyEval_RestoreThread(state);
906 for (cpy_callback_t *c = cpy_shutdown_callbacks; c; c = c->next) {
907 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
909 cpy_log_exception("shutdown callback");
918 static void *cpy_interactive(void *data) {
919 PyOS_sighandler_t cur_sig;
921 /* Signal handler in a plugin? Bad stuff, but the best way to
922 * handle it I guess. In an interactive session people will
923 * press Ctrl+C at some time, which will generate a SIGINT.
924 * This will cause collectd to shutdown, thus killing the
925 * interactive interpreter, and leaving the terminal in a
926 * mess. Chances are, this isn't what the user wanted to do.
928 * So this is the plan:
929 * 1. Restore Python's own signal handler
930 * 2. Tell Python we just forked so it will accept this thread
931 * as the main one. No version of Python will ever handle
932 * interrupts anywhere but in the main thread.
933 * 3. After the interactive loop is done, restore collectd's
935 * 4. Raise SIGINT for a clean shutdown. The signal is sent to
936 * the main thread to ensure it wakes up the main interval
937 * sleep so that collectd shuts down immediately not in 10
940 * This will make sure that SIGINT won't kill collectd but
941 * still interrupt syscalls like sleep and pause. */
943 PyEval_AcquireThread(state);
944 if (PyImport_ImportModule("readline") == NULL) {
945 /* This interactive session will suck. */
946 cpy_log_exception("interactive session init");
948 cur_sig = PyOS_setsig(SIGINT, python_sigint_handler);
949 /* We totally forked just now. Everyone saw that, right? */
951 PyRun_InteractiveLoop(stdin, "<stdin>");
952 PyOS_setsig(SIGINT, cur_sig);
954 PyEval_ReleaseThread(state);
955 NOTICE("python: Interactive interpreter exited, stopping collectd ...");
956 pthread_kill(main_thread, SIGINT);
960 static int cpy_init(void) {
962 static pthread_t thread;
964 if (!Py_IsInitialized()) {
965 WARNING("python: Plugin loaded but not configured.");
966 plugin_unregister_shutdown("python");
969 PyEval_InitThreads();
970 /* Now it's finally OK to use python threads. */
971 for (cpy_callback_t *c = cpy_init_callbacks; c; c = c->next) {
972 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
974 cpy_log_exception("init callback");
978 state = PyEval_SaveThread();
979 main_thread = pthread_self();
980 if (do_interactive) {
981 if (plugin_thread_create(&thread, NULL, cpy_interactive, NULL)) {
982 ERROR("python: Error creating thread for interactive interpreter.");
989 static PyObject *cpy_oconfig_to_pyconfig(oconfig_item_t *ci, PyObject *parent) {
990 PyObject *item, *values, *children, *tmp;
995 values = PyTuple_New(ci->values_num); /* New reference. */
996 for (int i = 0; i < ci->values_num; ++i) {
997 if (ci->values[i].type == OCONFIG_TYPE_STRING) {
998 PyTuple_SET_ITEM(values, i, cpy_string_to_unicode_or_bytes(ci->values[i].value.string));
999 } else if (ci->values[i].type == OCONFIG_TYPE_NUMBER) {
1000 PyTuple_SET_ITEM(values, i, PyFloat_FromDouble(ci->values[i].value.number));
1001 } else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN) {
1002 PyTuple_SET_ITEM(values, i, PyBool_FromLong(ci->values[i].value.boolean));
1006 tmp = cpy_string_to_unicode_or_bytes(ci->key);
1007 item = PyObject_CallFunction((void *) &ConfigType, "NONO", tmp, parent, values, Py_None);
1010 children = PyTuple_New(ci->children_num); /* New reference. */
1011 for (int i = 0; i < ci->children_num; ++i) {
1012 PyTuple_SET_ITEM(children, i, cpy_oconfig_to_pyconfig(ci->children + i, item));
1014 tmp = ((Config *) item)->children;
1015 ((Config *) item)->children = children;
1021 static struct PyModuleDef collectdmodule = {
1022 PyModuleDef_HEAD_INIT,
1023 "collectd", /* name of module */
1024 "The python interface to collectd", /* module documentation, may be NULL */
1029 PyMODINIT_FUNC PyInit_collectd(void) {
1030 return PyModule_Create(&collectdmodule);
1034 static int cpy_init_python(void) {
1035 PyOS_sighandler_t cur_sig;
1040 wchar_t *argv = L"";
1041 /* Add a builtin module, before Py_Initialize */
1042 PyImport_AppendInittab("collectd", PyInit_collectd);
1047 /* Chances are the current signal handler is already SIG_DFL, but let's make sure. */
1048 cur_sig = PyOS_setsig(SIGINT, SIG_DFL);
1050 python_sigint_handler = PyOS_setsig(SIGINT, cur_sig);
1052 PyType_Ready(&ConfigType);
1053 PyType_Ready(&PluginDataType);
1054 ValuesType.tp_base = &PluginDataType;
1055 PyType_Ready(&ValuesType);
1056 NotificationType.tp_base = &PluginDataType;
1057 PyType_Ready(&NotificationType);
1058 SignedType.tp_base = &PyLong_Type;
1059 PyType_Ready(&SignedType);
1060 UnsignedType.tp_base = &PyLong_Type;
1061 PyType_Ready(&UnsignedType);
1062 sys = PyImport_ImportModule("sys"); /* New reference. */
1064 cpy_log_exception("python initialization");
1067 sys_path = PyObject_GetAttrString(sys, "path"); /* New reference. */
1069 if (sys_path == NULL) {
1070 cpy_log_exception("python initialization");
1073 PySys_SetArgv(1, &argv);
1074 PyList_SetSlice(sys_path, 0, 1, NULL);
1077 module = PyImport_ImportModule("collectd");
1079 module = Py_InitModule("collectd", cpy_methods); /* Borrowed reference. */
1081 PyModule_AddObject(module, "Config", (void *) &ConfigType); /* Steals a reference. */
1082 PyModule_AddObject(module, "Values", (void *) &ValuesType); /* Steals a reference. */
1083 PyModule_AddObject(module, "Notification", (void *) &NotificationType); /* Steals a reference. */
1084 PyModule_AddObject(module, "Signed", (void *) &SignedType); /* Steals a reference. */
1085 PyModule_AddObject(module, "Unsigned", (void *) &UnsignedType); /* Steals a reference. */
1086 PyModule_AddIntConstant(module, "LOG_DEBUG", LOG_DEBUG);
1087 PyModule_AddIntConstant(module, "LOG_INFO", LOG_INFO);
1088 PyModule_AddIntConstant(module, "LOG_NOTICE", LOG_NOTICE);
1089 PyModule_AddIntConstant(module, "LOG_WARNING", LOG_WARNING);
1090 PyModule_AddIntConstant(module, "LOG_ERROR", LOG_ERR);
1091 PyModule_AddIntConstant(module, "NOTIF_FAILURE", NOTIF_FAILURE);
1092 PyModule_AddIntConstant(module, "NOTIF_WARNING", NOTIF_WARNING);
1093 PyModule_AddIntConstant(module, "NOTIF_OKAY", NOTIF_OKAY);
1094 PyModule_AddStringConstant(module, "DS_TYPE_COUNTER", DS_TYPE_TO_STRING(DS_TYPE_COUNTER));
1095 PyModule_AddStringConstant(module, "DS_TYPE_GAUGE", DS_TYPE_TO_STRING(DS_TYPE_GAUGE));
1096 PyModule_AddStringConstant(module, "DS_TYPE_DERIVE", DS_TYPE_TO_STRING(DS_TYPE_DERIVE));
1097 PyModule_AddStringConstant(module, "DS_TYPE_ABSOLUTE", DS_TYPE_TO_STRING(DS_TYPE_ABSOLUTE));
1101 static int cpy_config(oconfig_item_t *ci) {
1105 /* Ok in theory we shouldn't do initialization at this point
1106 * but we have to. In order to give python scripts a chance
1107 * to register a config callback we need to be able to execute
1108 * python code during the config callback so we have to start
1109 * the interpreter here. */
1110 /* Do *not* use the python "thread" module at this point! */
1112 if (!Py_IsInitialized() && cpy_init_python()) return 1;
1114 for (int i = 0; i < ci->children_num; ++i) {
1115 oconfig_item_t *item = ci->children + i;
1117 if (strcasecmp(item->key, "Interactive") == 0) {
1118 if (cf_util_get_boolean(item, &do_interactive) != 0) {
1122 } else if (strcasecmp(item->key, "Encoding") == 0) {
1123 char *encoding = NULL;
1124 if (cf_util_get_string(item, &encoding) != 0) {
1129 ERROR("python: \"Encoding\" was used in the config file but Python3 was used, which does not support changing encodings");
1134 /* Why is this even necessary? And undocumented? */
1135 if (PyUnicode_SetDefaultEncoding(encoding)) {
1136 cpy_log_exception("setting default encoding");
1141 } else if (strcasecmp(item->key, "LogTraces") == 0) {
1143 if (cf_util_get_boolean(item, &log_traces) != 0) {
1148 Py_XDECREF(cpy_format_exception);
1149 cpy_format_exception = NULL;
1152 if (cpy_format_exception)
1154 tb = PyImport_ImportModule("traceback"); /* New reference. */
1156 cpy_log_exception("python initialization");
1160 cpy_format_exception = PyObject_GetAttrString(tb, "format_exception"); /* New reference. */
1162 if (cpy_format_exception == NULL) {
1163 cpy_log_exception("python initialization");
1166 } else if (strcasecmp(item->key, "ModulePath") == 0) {
1168 PyObject *dir_object;
1170 if (cf_util_get_string(item, &dir) != 0) {
1174 dir_object = cpy_string_to_unicode_or_bytes(dir); /* New reference. */
1175 if (dir_object == NULL) {
1176 ERROR("python plugin: Unable to convert \"%s\" to "
1177 "a python object.", dir);
1179 cpy_log_exception("python initialization");
1183 if (PyList_Insert(sys_path, 0, dir_object) != 0) {
1184 ERROR("python plugin: Unable to prepend \"%s\" to "
1185 "python module path.", dir);
1186 cpy_log_exception("python initialization");
1189 Py_DECREF(dir_object);
1191 } else if (strcasecmp(item->key, "Import") == 0) {
1192 char *module_name = NULL;
1195 if (cf_util_get_string(item, &module_name) != 0) {
1199 module = PyImport_ImportModule(module_name); /* New reference. */
1200 if (module == NULL) {
1201 ERROR("python plugin: Error importing module \"%s\".", module_name);
1202 cpy_log_exception("importing module");
1207 } else if (strcasecmp(item->key, "Module") == 0) {
1212 if (cf_util_get_string(item, &name) != 0) {
1216 for (c = cpy_config_callbacks; c; c = c->next) {
1217 if (strcasecmp(c->name + 7, name) == 0)
1221 WARNING("python plugin: Found a configuration for the \"%s\" plugin, "
1222 "but the plugin isn't loaded or didn't register "
1223 "a configuration callback.", name);
1228 if (c->data == NULL)
1229 ret = PyObject_CallFunction(c->callback, "N",
1230 cpy_oconfig_to_pyconfig(item, NULL)); /* New reference. */
1232 ret = PyObject_CallFunction(c->callback, "NO",
1233 cpy_oconfig_to_pyconfig(item, NULL), c->data); /* New reference. */
1235 cpy_log_exception("loading module");
1240 ERROR("python plugin: Unknown config key \"%s\".", item->key);
1247 void module_register(void) {
1248 plugin_register_complex_config("python", cpy_config);
1249 plugin_register_init("python", cpy_init);
1250 plugin_register_shutdown("python", cpy_shutdown);