summaryrefslogtreecommitdiffstats
path: root/glances/exports/glances_influxdb2.py
diff options
context:
space:
mode:
Diffstat (limited to 'glances/exports/glances_influxdb2.py')
-rw-r--r--glances/exports/glances_influxdb2.py136
1 files changed, 136 insertions, 0 deletions
diff --git a/glances/exports/glances_influxdb2.py b/glances/exports/glances_influxdb2.py
new file mode 100644
index 00000000..1e619642
--- /dev/null
+++ b/glances/exports/glances_influxdb2.py
@@ -0,0 +1,136 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Glances.
+#
+# Copyright (C) 2020 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/>.
+
+"""InfluxDB (from to InfluxDB 1.8+) interface class."""
+
+import sys
+
+from glances.logger import logger
+from glances.exports.glances_export import GlancesExport
+
+from influxdb_client import InfluxDBClient, WriteOptions
+
+
+class Export(GlancesExport):
+ """This class manages the InfluxDB export module."""
+
+ def __init__(self, config=None, args=None):
+ """Init the InfluxDB export IF."""
+ super(Export, self).__init__(config=config, args=args)
+
+ # Mandatories configuration keys (additional to host and port)
+ self.org = None
+ self.bucket = None
+ self.token = None
+
+ # Optionals configuration keys
+ self.protocol = 'http'
+ self.prefix = None
+ self.tags = None
+
+ # Load the InfluxDB configuration file
+ self.export_enable = self.load_conf('influxdb2',
+ mandatories=['host', 'port',
+ 'user', 'password',
+ 'org', 'bucket', 'token'],
+ options=['protocol',
+ 'prefix',
+ 'tags'])
+ if not self.export_enable:
+ sys.exit(2)
+
+ # Init the InfluxDB client
+ self.client = self.init()
+
+ def init(self):
+ """Init the connection to the InfluxDB server."""
+ if not self.export_enable:
+ return None
+
+ url = '{}://{}:{}'.format(self.protocol, self.host, self.port)
+ try:
+ client = InfluxDBClient(url=url,
+ enable_gzip=False,
+ org=self.org,
+ token=self.token)
+ except Exception as e:
+ logger.critical("Cannot connect to InfluxDB server '%s' (%s)" % (url, e))
+ sys.exit(2)
+ else:
+ logger.info("Connected to InfluxDB server version {} ({})".format(client.health().version,
+ client.health().message))
+
+
+ # Create the write client
+ write_client = client.write_api(write_options=WriteOptions(batch_size=500,
+ flush_interval=10000,
+ jitter_interval=2000,
+ retry_interval=5000,
+ max_retries=5,
+ max_retry_delay=30000,
+ exponential_base=2))
+ return write_client
+
+ def _normalize(self, name, columns, points):
+ """Normalize data for the InfluxDB's data model."""
+
+ for i, _ in enumerate(points):
+ # Supported type:
+ # https://docs.influxdata.com/influxdb/v2.0/reference/syntax/line-protocol/
+ if points[i] is None:
+ # Ignore points with None value
+ del(points[i])
+ del(columns[i])
+ continue
+ try:
+ points[i] = float(points[i])
+ except (TypeError, ValueError):
+ pass
+ else:
+ continue
+ try:
+ points[i] = str(points[i])
+ except (TypeError, ValueError):
+ pass
+ else:
+ continue
+
+ return [{'measurement': name,
+ 'tags': self.parse_tags(self.tags),
+ 'fields': dict(zip(columns, points))}]
+
+ def export(self, name, columns, points):
+ """Write the points to the InfluxDB server."""
+ # Manage prefix
+ if self.prefix is not None:
+ name = self.prefix + '.' + name
+ # Write input to the InfluxDB database
+ if len(points) == 0:
+ logger.debug("Cannot export empty {} stats to InfluxDB".format(name))
+ else:
+ try:
+ self.client.write(self.bucket,
+ self.org,
+ self._normalize(name, columns, points),
+ time_precision="s")
+ except Exception as e:
+ # Log level set to debug instead of error (see: issue #1561)
+ logger.debug("Cannot export {} stats to InfluxDB ({})".format(name, e))
+ else:
+ logger.debug("Export {} stats to InfluxDB".format(name))