Adds GELF logging

Author: tlex

.gitlab-ci.yml

@@ -1,6 +1,7 @@
 variables:
   DOCKER_DRIVER: overlay2
   IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME
+  PORT: 9308
 
 stages:
   - lint
@@ -14,7 +15,7 @@ pylint:
   stage: lint
   script:
     - curl -o .pylintrc https://tool.ix.ai/.pylintrc
-    - pip install prometheus_client pylint requests
+    - pip install prometheus_client pylint requests pygelf
     - pylint --rcfile=.pylintrc src/*.py
 
 build:
@@ -23,7 +24,8 @@ build:
   only:
     - /^latest$/
     - tags
+    - /(.*)-dev$/
   script:
     - docker login -u gitlab-ci-token -p ${CI_JOB_TOKEN} ${CI_REGISTRY}
-    - docker build -f Dockerfile -t ${IMAGE_TAG} .
+    - docker build -f Dockerfile -t ${IMAGE_TAG} --build-arg PORT="${PORT}" .
     - docker push ${IMAGE_TAG}

Dockerfile

@@ -1,12 +1,13 @@
 FROM hub.ix.ai/docker/alpine:latest
 LABEL ai.ix.maintainer="docker@ix.ai"
+ARG PORT
 
 RUN apk add --no-cache py3-requests
 
-ENV LOGLEVEL=INFO
+ENV LOGLEVEL=INFO PORT=${PORT}
 
 COPY src/etherscan-exporter.py /
 
-EXPOSE 9308
+EXPOSE ${PORT}
 
 ENTRYPOINT ["python3", "/etherscan-exporter.py"]

README.md

@@ -13,10 +13,13 @@ docker run --rm -it -p 9308:9308 \
 ```
 
 ## Supported variables
-* `API_KEY` (no default) - set this to your Etherscan API key
+* `API_KEY` (no default - **mandatory**) - set this to your Etherscan API key
 * `URL` (default: https://api.etherscan.io/api) - set this to your Etherscan API secret
 * `ADDRESSES` (no default) - a comma separated list of the ETH addresses to export
 * `TOKENS` (no default) - a JSON object with the list of tokens to export (see below)
+* `GELF_HOST` (no default) - if set, the exporter will also log to this [GELF](https://docs.graylog.org/en/3.0/pages/gelf.html) capable host on UDP
+* `GELF_PORT` (defaults to `12201`) - the port to use for GELF logging
+* `PORT` (defaults to `9308`) - the listen port for the exporter
 * `LOGLEVEL` (defaults to `INFO`)
 
 ## Tokens

src/etherscan-exporter.py

@@ -7,6 +7,7 @@
 import sys
 import json
 import requests
+import pygelf
 from prometheus_client import start_http_server
 from prometheus_client.core import REGISTRY, GaugeMetricFamily
 
@@ -19,6 +20,22 @@
 )
 
 
+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,
+        )
+        LOG.addHandler(GELF)
+        gelf_enabled = True
+    LOG.info('Initialized logging with GELF enabled: {}'.format(gelf_enabled))
+
+
 class EtherscanCollector:
     """ The EtherscanCollector class """
 
@@ -32,13 +49,16 @@ def __init__(self):
             'addresses': os.environ.get("ADDRESSES"),
             'tokens': [],
         }
+        if not self.settings.get('api_key'):
+            raise ValueError("Missing API_KEY environment variable.")
+
         if os.environ.get('TOKENS'):
             self.settings['tokens'] = (json.loads(os.environ.get("TOKENS")))
 
     def get_tokens(self):
         """ Gets the tokens from an account """
-        # Ensure that we don't get blocked
-        time.sleep(1)
+
+        time.sleep(1)  # Ensure that we don't get rate limited
         for account in self.accounts:
             for token in self.settings['tokens']:
                 request_data = {
@@ -59,7 +79,7 @@ def get_tokens(self):
                         requests.exceptions.ConnectionError,
                         requests.exceptions.ReadTimeout,
                 ) as error:
-                    LOG.warning(error)
+                    LOG.exception('Exception caught: {}'.format(error))
                     req = {}
                 if req.get('result') and int(req['result']) > 0:
                     self.tokens.update({
@@ -90,7 +110,7 @@ def get_balances(self):
                 requests.exceptions.ConnectionError,
                 requests.exceptions.ReadTimeout,
         ) as error:
-            LOG.warning(error)
+            LOG.exception('Exception caught: {}'.format(error))
             req = {}
         if req.get('message') == 'OK' and req.get('result'):
             for result in req.get('result'):
@@ -140,8 +160,10 @@ def collect(self):
 
 
 if __name__ == '__main__':
-    LOG.info("Starting")
+    configure_logging()
+    PORT = int(os.environ.get('PORT', 9308))
+    LOG.info("Starting on port {}".format(PORT))
     REGISTRY.register(EtherscanCollector())
-    start_http_server(9308)
+    start_http_server(PORT)
     while True:
         time.sleep(1)