Restructures the project and cleans up the code

Closes #2
Closes #3

build.sh

@@ -1,4 +1,6 @@
 #!/usr/bin/env sh
 
-echo "Setting VERSION='${CI_COMMIT_REF_NAME}-${CI_COMMIT_SHORT_SHA}' in src/constants.py"
-echo "VERSION = '${CI_COMMIT_REF_NAME}-${CI_COMMIT_SHORT_SHA}'" >> src/constants.py
+echo "Setting VERSION"
+find . -name .git -type d -prune -o -type f -name constants.py -exec sed -i "s/^VERSION.*/VERSION\ =\ \'${CI_COMMIT_REF_NAME:-None}\'/g" {} + -exec grep VERSION {} +
+echo "Setting BUILD"
+find . -name .git -type d -prune -o -type f -name constants.py -exec sed -i "s/^BUILD.*/BUILD\ =\ \'${CI_COMMIT_SHORT_SHA:-None}\'/g" {} + -exec grep BUILD {} +

stellar-exporter.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+exec python3 -m "stellar-exporter.stellar-exporter" "$@"

stellar-exporter/__init__.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+""" initializes alertmanager_notifier """
+
+import os
+from .lib import log as logging
+
+log = logging.setup_logger(
+    name=__package__,
+    level=os.environ.get('LOGLEVEL', 'INFO'),
+)

stellar-exporter/lib/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-

src/constants.py → stellar-exporter/lib/constants.py

@@ -3,3 +3,4 @@
 """ Constants declarations """
 
 VERSION = None
+BUILD = None

stellar-exporter/lib/log.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+""" Global logging configuration """
+
+import logging
+
+
+def setup_logger(name=__package__, level='INFO'):
+    """ sets up the logger """
+    logging.basicConfig(handlers=[logging.NullHandler()])
+    formatter = logging.Formatter(
+        fmt='%(asctime)s.%(msecs)03d %(levelname)s [%(module)s.%(funcName)s] %(message)s',
+        datefmt='%Y-%m-%d %H:%M:%S',
+    )
+    logger = logging.getLogger(name)
+    logger.setLevel(level)
+
+    handler = logging.StreamHandler()
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)
+
+    return logger

src/stellar-exporter.py → stellar-exporter/stellar-exporter.py

@@ -3,55 +3,31 @@
 import logging
 import time
 import os
-import sys
-import pygelf
 from stellar_sdk.server import Server
 from prometheus_client import start_http_server
 from prometheus_client.core import REGISTRY, GaugeMetricFamily
-import constants
+from .lib import constants
 
-LOG = logging.getLogger(__name__)
-logging.basicConfig(
-    stream=sys.stdout,
-    level=os.environ.get("LOGLEVEL", "INFO"),
-    format='%(asctime)s.%(msecs)03d %(levelname)s {%(module)s} [%(funcName)s] %(message)s',
-    datefmt='%Y-%m-%d %H:%M:%S'
-)
-
-FILENAME = os.path.splitext(sys.modules['__main__'].__file__)[0]
-
-
-def configure_logging():
-    """ Configures the logging """
-    gelf_enabled = False
-
-    if os.environ.get('GELF_HOST'):
-        GELF = pygelf.GelfUdpHandler(
-            host=os.environ.get('GELF_HOST'),
-            port=int(os.environ.get('GELF_PORT', 12201)),
-            debug=True,
-            include_extra_fields=True,
-            _ix_id=FILENAME
-        )
-        LOG.addHandler(GELF)
-        gelf_enabled = True
-    LOG.info('Initialized logging with GELF enabled: {}'.format(gelf_enabled))
+log = logging.getLogger(__package__)
+version = f'{constants.VERSION}-{constants.BUILD}'
 
 
 class StellarCollector:
     """ The StellarCollector class """
     accounts = {}
     settings = {}
 
-    def __init__(self):
-        server = os.environ.get('HORIZON_URL') if os.environ.get('HORIZON_URL') else 'https://horizon.stellar.org/'
+    def __init__(self, **kwargs):
         self.settings = {
-            'accounts': os.environ.get("ACCOUNTS", '').split(','),
-            'server': Server(horizon_url=server),
+            'accounts': [],
+            'server': Server(horizon_url=kwargs['horizon_url']),
         }
+        if kwargs.get('accounts'):
+            self.settings['accounts'] = kwargs['accounts'].split(',')
 
     def get_accounts(self):
         """ Connects to the Stellar network and retrieves the account information """
+        log.info('Retrieving accounts')
         for account in self.settings['accounts']:
             balances = self.settings['server'].accounts().account_id(account).call().get('balances')
             if isinstance(balances, list):
@@ -63,14 +39,14 @@ def get_accounts(self):
                     else:
                         currency = balance.get('asset_type')
                     self.accounts.update({
-                        '{}-{}'.format(account, currency): {
+                        f'{account}-{currency}': {
                             'account': account,
                             'currency': currency,
                             'balance': float(balance.get('balance'))
                         }
                     })
 
-        LOG.debug('Found the following accounts: {}'.format(self.accounts))
+        log.debug(f'Found the following accounts: {self.accounts}')
 
     def describe(self):
         """ Just a needed method, so that collect() isn't called at startup """
@@ -82,15 +58,14 @@ def collect(self):
             'account_balance': GaugeMetricFamily(
                 'account_balance',
                 'Account Balance',
-                labels=['source_currency', 'currency', 'account', 'type']
+                labels=['currency', 'account', 'type']
             ),
         }
         self.get_accounts()
         for a in self.accounts:
             metrics['account_balance'].add_metric(
                 value=self.accounts[a]['balance'],
                 labels=[
-                    self.accounts[a]['currency'],
                     self.accounts[a]['currency'],
                     self.accounts[a]['account'],
                     'stellar',
@@ -100,14 +75,28 @@ def collect(self):
             yield metric
 
 
+def _test(collector):
+    for metric in collector.collect():
+        log.info(f"{metric}")
+
+
 if __name__ == '__main__':
-    configure_logging()
-    PORT = int(os.environ.get('PORT', 9188))
-    # pylint: disable=no-member
-    LOG.info("Starting {} {} on port {}".format(FILENAME, constants.VERSION, PORT))
-    REGISTRY.register(StellarCollector())
-    TEST = os.environ.get('TEST', False)
-    if not TEST:
-        start_http_server(PORT)
+    port = int(os.environ.get('PORT', 9188))
+    settings = {
+        'horizon_url': os.environ.get('HORIZON_URL', 'https://horizon.stellar.org/'),
+        'accounts': os.environ.get("ACCOUNTS", []),
+    }
+    log.warning(f"Starting {__package__} {version} on port {port}")
+
+    if os.environ.get('TEST', False):
+        _test(StellarCollector(
+            horizon_url='https://horizon.stellar.org/',
+            accounts='GA5XIGA5C7QTPTWXQHY6MCJRMTRZDOSHR6EFIBNDQTCQHG262N4GGKTM'  # kraken
+            ',GD6RMKTCHQGEOGYWIKSY5G7QWXPZOAEZIKPKEVZUAXOQCZRVBRRFGLJM'  # NydroEnergy
+            ',GCNSGHUCG5VMGLT5RIYYZSO7VQULQKAJ62QA33DBC5PPBSO57LFWVV6P'  # InterstellarExchange
+            ))
+    else:
+        REGISTRY.register(StellarCollector(**settings))
+        start_http_server(port)
         while True:
             time.sleep(1)

test.sh

@@ -1,3 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 
-TEST=true python3 src/${CI_PROJECT_NAME}.py
+export TEST=true
+./stellar-exporter.sh