Add support for OpenTSDB export (issue #638)

NEWS

@@ -9,6 +9,7 @@ Enhancements and new features:
 
     * Allow export of Docker and sensors plugins stats to InfluxDB, StatsD... (issue #600)
     * Server password configuration for the browser mode (issue #500)
+    * Add support for OpenTSDB export (issue #638) 
     * Support Fahrenheit unit in the sensor plugin using the --fahrenheit command line option (issue #620) 
     * Display an error if export is not used in the standalone/client mode (issue #614)  
     * New --disable-quicklook, --disable-cpu, --disable-mem, --disable-swap, --disable-load tags (issue #631)

conf/glances.conf

@@ -175,14 +175,27 @@ mem_critical=90
 #default=defaultpassword
 
 [influxdb]
+# Configuration file for the --export-influxdb option
+# https://influxdb.com/ 
 host=localhost
 port=8086
 user=root
 password=root
 db=glances
-#prefix=localhost
+prefix=localhost
+#tags=foo:bar,spam:eggs
+
+[opentsdb]
+# Configuration file for the --export-opentsdb option
+# http://opentsdb.net/
+host=localhost
+port=4242
+#prefix=glances
+#tags=foo:bar,spam:eggs
 
 [statsd]
+# Configuration file for the --export-statsd option
+# https://github.com/etsy/statsd
 host=localhost
 port=8125
 #prefix=glances

docs/glances-doc.rst

@@ -175,6 +175,7 @@ Command-Line Options
   --export-csv EXPORT_CSV
                         export stats to a CSV file
   --export-influxdb     export stats to an InfluxDB server (influxdb needed)
+  --export-opentsdb     export stats to an OpenTSDB server (potsdb needed)
   --export-statsd       export stats to a StatsD server (statsd needed)
   --export-rabbitmq     export stats to a RabbitMQ server (pika needed)
   -c CLIENT, --client CLIENT
@@ -842,6 +843,27 @@ the file in your ``Grafana`` web interface.
 
 .. image:: images/grafana.png
 
+OpenTSDB
+--------
+
+You can export statistics to an ``OpenTSDB`` server (time series server).
+The connection should be defined in the Glances configuration file as
+following:
+
+.. code-block::
+
+    [opentsdb]
+    host=localhost
+    port=4242
+    prefix=glances
+    tags=foo:bar,spam:eggs
+
+and run Glances with:
+
+.. code-block:: console
+
+    $ glances --export-opentsdb
+
 Statsd
 ------
 

glances/core/glances_main.py

@@ -148,6 +148,8 @@ Start the client browser (browser mode):\n\
                             dest='export_csv', help='export stats to a CSV file')
         parser.add_argument('--export-influxdb', action='store_true', default=False,
                             dest='export_influxdb', help='export stats to an InfluxDB server (influxdb needed)')
+        parser.add_argument('--export-opentsdb', action='store_true', default=False,
+                            dest='export_opentsdb', help='export stats to an OpenTSDB server (potsdb needed)')
         parser.add_argument('--export-statsd', action='store_true', default=False,
                             dest='export_statsd', help='export stats to a StatsD server (statsd needed)')
         parser.add_argument('--export-rabbitmq', action='store_true', default=False,
@@ -270,7 +272,7 @@ Start the client browser (browser mode):\n\
         self.args = args
 
         # Export is only available in standalone or client mode (issue #614)
-        export_tag = args.export_csv or args.export_statsd or args.export_influxdb or args.export_rabbitmq
+        export_tag = args.export_csv or args.export_statsd or args.export_influxdb or args.export_opentsdb or args.export_rabbitmq
         if not (self.is_standalone() or self.is_client()) and export_tag:
             logger.critical("Export is only available in standalone or client mode")
             sys.exit(2)

glances/exports/glances_export.py

@@ -80,6 +80,18 @@ class GlancesExport(object):
         else:
             return ret
 
+    def parse_tags(self):
+        """ Parses some tags into a dict"""
+        if self.tags:
+            try:
+                self.tags = dict([x.split(':') for x in self.tags.split(',')])
+            except ValueError:
+                # one of the keyvalue pairs was missing
+                logger.info('invalid tags passed: %s', self.tags)
+                self.tags = {}
+        else:
+            self.tags = {}
+
     def update(self, stats):
         """Update stats to a server.
 

glances/exports/glances_influxdb.py

@@ -94,18 +94,6 @@ class Export(GlancesExport):
 
         return True
 
-    def parse_tags(self):
-        """ Parses some tags into a dict"""
-        if self.tags:
-            try:
-                self.tags = dict([x.split(':') for x in self.tags.split(',')])
-            except ValueError:
-                # one of the keyvalue pairs was missing
-                logger.info('invalid tags passed: %s', self.tags)
-                self.tags = {}
-        else:
-            self.tags = {}
-
     def init(self):
         """Init the connection to the InfluxDB server."""
         if not self.export_enable:
@@ -140,6 +128,7 @@ class Export(GlancesExport):
             logger.critical("InfluxDB database '%s' did not exist. Please create it" % self.db)
             sys.exit(2)
 
+        # Read tags
         self.parse_tags()
 
         return db

glances/exports/glances_opentsdb.py

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Glances.
+#
+# Copyright (C) 2015 Nicolargo <nicolas@nicolargo.com>
+#
+# Glances is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Glances is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+"""OpenTSDB interface class."""
+
+# Import sys libs
+import sys
+from numbers import Number
+try:
+    from configparser import NoOptionError, NoSectionError
+except ImportError:  # Python 2
+    from ConfigParser import NoOptionError, NoSectionError
+
+# Import Glances lib
+from glances.core.glances_logging import logger
+from glances.exports.glances_export import GlancesExport
+
+import potsdb
+
+class Export(GlancesExport):
+
+    """This class manages the OpenTSDB export module."""
+
+    def __init__(self, config=None, args=None):
+        """Init the OpenTSDB export IF."""
+        GlancesExport.__init__(self, config=config, args=args)
+
+        # Load the InfluxDB configuration file
+        self.host = None
+        self.port = None
+        self.prefix = None
+        self.export_enable = self.load_conf()
+        if not self.export_enable:
+            sys.exit(2)
+
+        # Default prefix for stats is 'glances'
+        if self.prefix is None:
+            self.prefix = 'glances'
+
+        # Init the OpenTSDB client
+        self.client = self.init()
+
+    def load_conf(self, section="opentsdb"):
+        """Load the OpenTSDB configuration in the Glances configuration file."""
+        if self.config is None:
+            return False
+        try:
+            self.host = self.config.get_value(section, 'host')
+            self.port = self.config.get_value(section, 'port')
+        except NoSectionError:
+            logger.critical("No OpenTSDB configuration found")
+            return False
+        except NoOptionError as e:
+            logger.critical("Error in the OpenTSDB configuration (%s)" % e)
+            return False
+        else:
+            logger.debug("Load OpenTSDB from the Glances configuration file")
+
+        # Prefix is optional
+        try:
+            self.prefix = self.config.get_value(section, 'prefix')
+        except NoOptionError:
+            pass
+
+        # Tags are optional, comma separated key:value pairs.
+        try:
+            self.tags = self.config.get_value(section, 'tags')
+        except NoOptionError:
+            self.tags = ''
+
+        return True
+
+    def init(self):
+        """Init the connection to the OpenTSDB server."""
+        if not self.export_enable:
+            return None
+
+        try:
+            db = potsdb.Client(self.host,
+                               port=int(self.port),
+                               check_host=True)
+        except Exception as e:
+            logger.critical("Cannot connect to OpenTSDB server %s:%s (%s)" % (self.host, self.port, e))
+            sys.exit(2)
+
+        # Read tags
+        self.parse_tags()
+
+        return db
+
+    def export(self, name, columns, points):
+        """Export the stats to the Statsd server."""
+        for i in range(0, len(columns)):
+            if not isinstance(points[i], Number):
+                continue
+            stat_name = '{0}.{1}.{2}'.format(self.prefix, name, columns[i])
+            stat_value = points[i]
+            try:
+                self.client.send(stat_name, stat_value, **self.tags)
+            except Exception as e:
+                logger.error("Can not export stats %s to OpenTSDB (%s)" % (name, e))
+        logger.debug("Export {0} stats to OpenTSDB".format(name))
+
+    def exit(self):
+        """Close the OpenTSDB export module."""
+        # Waits for all outstanding metrics to be sent and background thread closes
+        self.client.wait()
+        # Call the father method
+        GlancesExport.exit(self)

man/glances.1

@@ -100,6 +100,9 @@ export stats to a CSV file
 .B \-\-export-influxdb
 export stats to an InfluxDB server (influxdb needed)
 .TP
+.B \-\-export-opentsdb
+export stats to an OpenTSDB server (potsdb needed)
+.TP
 .B \-\-export-statsd
 export stats to a StatsD server (statsd needed)
 .TP