- do some logging

Author: zzzeek

collectdconsole.conf

@@ -5,10 +5,11 @@
 
 LoadPlugin logfile
 <Plugin logfile>
-       LogLevel info
+        # note "debug" will usually not work
+       LogLevel "info"
        File STDOUT
        Timestamp true
-       PrintSeverity false
+       PrintSeverity true
 </Plugin>
 
 LoadPlugin write_log
@@ -29,6 +30,11 @@ LoadPlugin python
     <Module "sqlalchemy_collectd.server.plugin">
         listen "localhost" 25827
 
+        # the plugin sends logging into the collectd
+        # notify system.
+        # "info" shows essentially a startup message; set to "debug" to
+        # show messages received
+        loglevel "info"
     </Module>
 </Plugin>
 

setup.py

@@ -41,4 +41,9 @@
     setup_requires=['pytest-runner'],
     zip_safe=False,
     install_requires=requires,
+    entry_points={
+        'sqlalchemy.plugins': [
+            'collectd = sqlalchemy_collectd.client.plugin.Plugin'
+        ]
+    }
 )

sqlalchemy_collectd/protocol.py

@@ -2,6 +2,7 @@
 connect straight to the network plugin.
 
 """
+import collections
 import struct
 import socket
 import logging
@@ -149,8 +150,59 @@ def send(self, connection, timestamp, *values):
 
         payload = self.type._encode_values(*values)
 
+        log.debug("send: %s", _SendMsg(self, values))
         connection.send(header_ + payload)
 
+    def __str__(self):
+        return (
+            "(host=%r, plugin=%r, plugin_instance=%r, "
+            "type=%r, type_instance=%r, interval=%r)" % (
+                self.host, self.plugin, self.plugin_instance,
+                self.type.name, self.type_instance, self.interval
+            )
+        )
+
+
+class _SendMsg(collections.namedtuple('sendmsg', ['sender', 'values'])):
+    def __str__(self):
+        sender = self.sender
+        type_ = sender.type
+        return (
+            "(host=%r, plugin=%r, plugin_instance=%r, "
+            "type=%r, type_instance=%r, interval=%r, values=%s)" % (
+                sender.host, sender.plugin, sender.plugin_instance,
+                type_.name, sender.type_instance, sender.interval,
+                ", ".join(
+                    "%s=%s" % (field_name, value)
+                    for field_name, value in zip(type_.names, self.values)
+                )
+            )
+        )
+
+
+class _RecvMsg(collections.namedtuple("receivemsg", ['result', 'type'])):
+
+    def __str__(self):
+        if self.type:
+            type_names = self.type.names
+        else:
+            type_names = ["(unknown)" for value in self.result[TYPE_VALUES]]
+
+        return (
+            "(host=%r, plugin=%r, plugin_instance=%r, "
+            "type=%r, type_instance=%r, interval=%r, values=%s)" % (
+                self.result[TYPE_HOST], self.result[TYPE_PLUGIN],
+                self.result[TYPE_PLUGIN_INSTANCE],
+                self.result[TYPE_TYPE], self.result[TYPE_TYPE_INSTANCE],
+                self.result[TYPE_INTERVAL],
+                ", ".join(
+                    "%s=%s" % (field_name, value)
+                    for field_name, value
+                    in zip(type_names, self.result[TYPE_VALUES])
+                )
+            )
+        )
+
 
 class MessageReceiver(object):
     def __init__(self, *types):
@@ -171,6 +223,7 @@ def __init__(self, *types):
     def receive(self, buf):
         result = self._unpack_packet(buf)
         type_name = result[TYPE_TYPE]
+        type_ = None
         try:
             type_ = self._types[type_name]
         except KeyError:
@@ -183,6 +236,8 @@ def receive(self, buf):
                 for name, value in zip(type_._field_names, result[TYPE_VALUES])
             }
             return result
+        finally:
+            log.debug("receive: %s", _RecvMsg(result, type_))
 
     def _unpack_packet(self, buf):
         pos = 0
@@ -257,7 +312,6 @@ def send(self, message):
         self._mutex.acquire()
         try:
             self._check_connect()
-            log.debug("sending: %r", message)
             self.socket.sendto(message, (self.host, self.port))
         except IOError:
             log.error("Error in socket.sendto", exc_info=True)

sqlalchemy_collectd/server/plugin.py

@@ -12,16 +12,24 @@
 receiver_ = None
 
 
-# TODO: merge collectd.notice w/ python logging?
-def _notice(msg):
-    collectd.notice("[sqlalchemy-collectd] %s" % msg)
+class CollectdHandler(logging.Handler):
+    levels = {
+        logging.INFO: collectd.info,
+        logging.WARN: collectd.warning,
+        logging.ERROR: collectd.error,
+        logging.DEBUG: collectd.info,
+        logging.CRITICAL: collectd.error,
+
+    }
+
+    def emit(self, record):
+        fn = self.levels[record.levelno]
+        fn(record.msg % record.args)
 
 
 def get_config(config):
     global aggregator_
 
-    _notice("sqlalchemy_collectd plugin version %s" % __version__)
-    _notice("Python version: %s" % sys.version)
     start_plugin(config)
 
 
@@ -31,6 +39,18 @@ def start_plugin(config):
     config_dict = {elem.key: tuple(elem.values) for elem in config.children}
     host, port = config_dict.get("listen", ("localhost", 25827))
 
+    logging.getLogger().addHandler(CollectdHandler())
+
+    loglevel = {
+        "warn": logging.WARN, "error": logging.ERROR,
+        "debug": logging.DEBUG, "info": logging.INFO
+    }[config_dict.get("loglevel", ("info", ))[0]]
+
+    logging.getLogger().setLevel(loglevel)
+
+    log.info("sqlalchemy_collectd plugin version %s", __version__)
+    log.info("Python version: %s", sys.version)
+
     receiver_ = receiver.Receiver()
     connection = protocol.ServerConnection(host, int(port))