Prometheus, InfluxDB, Copyright

- Fix #58: Add Prometheus output
- InfluxDB: fix timestamp option
- Update Copyright year

Author: jelu

LICENSE

@@ -1,6 +1,6 @@
 DSC DataTool
 
-Copyright (c) 2016-2020 OARC, Inc.
+Copyright (c) 2016-2022 OARC, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

debian/copyright

@@ -3,11 +3,11 @@ Upstream-Name: dsc-datatool
 Source: https://github.com/DNS-OARC/dsc-datatool
 
 Files: *
-Copyright: 2016-2020 OARC, Inc.
+Copyright: 2016-2022 OARC, Inc.
 License: BSD-3-Clause
 
 Files: debian/*
-Copyright: 2020 Jerry Lundström <lundstrom.jerry@gmail.com>
+Copyright: 2022 Jerry Lundström <lundstrom.jerry@gmail.com>
 License: BSD-3-Clause
 
 License: BSD-3-Clause

debian/manpages

@@ -2,6 +2,7 @@ man/man7/dsc-datatool-transformer-reranger.7
 man/man7/dsc-datatool-generator-client_subnet_country.7
 man/man7/dsc-datatool-generator-client_subnet_authority.7
 man/man7/dsc-datatool-output-influxdb.7
+man/man7/dsc-datatool-output-prometheus.7
 man/man7/dsc-datatool-transformer-labler.7
 man/man7/dsc-datatool-transformer-netremap.7
 man/man5/dsc-datatool.conf.5

dsc_datatool/__init__.py

@@ -29,7 +29,7 @@ class ExampleOutput(Output):
         def process(self, datasets)
             ...
 
-:copyright: 2020 OARC, Inc.
+:copyright: 2022 OARC, Inc.
 """
 
 __version__ = '1.0.2'

dsc_datatool/generator/client_subnet_authority.py

@@ -4,7 +4,7 @@
 
 Part of dsc_datatool.
 
-:copyright: 2020 OARC, Inc.
+:copyright: 2022 OARC, Inc.
 """
 
 import csv

dsc_datatool/generator/client_subnet_country.py

@@ -4,7 +4,7 @@
 
 Part of dsc_datatool.
 
-:copyright: 2020 OARC, Inc.
+:copyright: 2022 OARC, Inc.
 """
 
 import maxminddb

dsc_datatool/input/dat.py

@@ -4,7 +4,7 @@
 
 Part of dsc_datatool.
 
-:copyright: 2020 OARC, Inc.
+:copyright: 2022 OARC, Inc.
 """
 
 import re

dsc_datatool/input/xml.py

@@ -4,7 +4,7 @@
 
 Part of dsc_datatool.
 
-:copyright: 2020 OARC, Inc.
+:copyright: 2022 OARC, Inc.
 """
 
 import logging

dsc_datatool/output/influxdb.py

@@ -4,14 +4,14 @@
 
 Part of dsc_datatool.
 
-:copyright: 2020 OARC, Inc.
+:copyright: 2022 OARC, Inc.
 """
 
 import re
 import sys
 import atexit
 
-from dsc_datatool import Output,args
+from dsc_datatool import Output, args
 
 
 _re = re.compile(r'([,=\s])')
@@ -60,7 +60,7 @@ def __init__(self, opts):
         if timestamp == 'start':
             pass
         elif timestamp == 'stop':
-            self.timestamp = False
+            self.start_timestamp = False
         else:
             raise Exception('timestamp option invalid')
         file = opts.get('file', None)

dsc_datatool/output/prometheus.py

@@ -0,0 +1,110 @@
+"""dsc_datatool.output.prometheus
+
+See `man dsc-datatool-output prometheus`.
+
+Part of dsc_datatool.
+
+:copyright: 2022 OARC, Inc.
+"""
+
+import re
+import sys
+import atexit
+
+from dsc_datatool import Output, args
+
+
+_re = re.compile(r'([\\\n"])')
+
+
+def _key(key):
+    return re.sub(_re, r'\\\1', key)
+
+
+def _val(val):
+    ret = re.sub(_re, r'\\\1', val)
+    if ret == '':
+        return '""'
+    return '"%s"' % ret
+
+
+class Prometheus(Output):
+    show_timestamp = True
+    start_timestamp = True
+    fh = None
+    type_def = ""
+    type_printed = False
+
+
+    def __init__(self, opts):
+        Output.__init__(self, opts)
+        timestamp = opts.get('timestamp', 'start')
+        if timestamp == 'hide':
+            self.show_timestamp = False
+        elif timestamp == 'start':
+            pass
+        elif timestamp == 'stop':
+            self.start_timestamp = False
+        else:
+            raise Exception('timestamp option invalid')
+        file = opts.get('file', None)
+        append = opts.get('append', False)
+        if file:
+            if append:
+                self.fh = open(file, 'a')
+            else:
+                self.fh = open(file, 'w')
+            atexit.register(self.close)
+        else:
+            self.fh = sys.stdout
+
+
+    def close(self):
+        if self.fh:
+            self.fh.close()
+            self.fh = None
+
+
+    def _process(self, tags, timestamp, dimension, fh):
+        if dimension.dimensions is None:
+            return
+
+        if len(dimension.dimensions) > 0:
+            if not (dimension.name == 'All' and dimension.value == 'ALL'):
+                tags += ',%s=%s' % (_key(dimension.name.lower()), _val(dimension.value))
+            for d2 in dimension.dimensions:
+                self._process(tags, timestamp, d2, fh)
+            return
+
+        if dimension.values is None:
+            return
+
+        if len(dimension.values) > 0:
+            tags += ',%s=' % _key(dimension.name.lower())
+
+            for k, v in dimension.values.items():
+                if not self.type_printed:
+                    print(self.type_def, file=fh)
+                    self.type_printed = True
+                if self.show_timestamp:
+                    print('%s%s} %s %s' % (tags, _val(k), v, timestamp), file=fh)
+                else:
+                    print('%s%s} %s' % (tags, _val(k), v), file=fh)
+
+
+    def process(self, datasets):
+        for dataset in datasets:
+            self.type_def = '# TYPE %s gauge' % _key(dataset.name.lower())
+            self.type_printed = False
+            tags = '%s{server=%s,node=%s' % (_key(dataset.name.lower()), _val(args.server), _val(args.node))
+            if self.start_timestamp:
+                timestamp = dataset.start_time * 1000
+            else:
+                timestamp = dataset.end_time * 1000
+
+            for d in dataset.dimensions:
+                self._process(tags, timestamp, d, self.fh)
+
+
+if sys.version_info[0] == 3 and sys.version_info[1] == 5: # pragma: no cover
+    Output.__init_subclass__(Prometheus)