Add sentry support

Author: frodrigo

INSTALL.md

@@ -109,6 +109,7 @@ password while processing the files.
 
 See https://wiki.postgresql.org/wiki/Pgpass for more info.
 
+You may use `SENTRY_DSN` environment variable to enable error report centralization.
 
 Run Tests
 ---------

docker/README.md

@@ -23,6 +23,8 @@ To build the docker image run this command from the docker folder:
 docker-compose build
 ```
 
+For production setup, you may fill the `SENTRY_DSN` field in
+`docker-compose.yml` to enable error report centralization.
 
 Running on a single country
 ===========================

docker/docker-compose.yml

@@ -40,6 +40,7 @@ services:
     environment:
       - DB_HOST=postgis
       - JUPYTER_RUNTIME_DIR=/tmp
+      #- SENTRY_DSN=
     user: "1000:1000"
     command: ./osmose_run.py --country=monaco --analyser=osmosis_highway_floating_islands
     networks:

osmose_run.py

@@ -40,6 +40,11 @@
 import dateutil.parser
 import requests
 
+try:
+    import sentry_sdk
+except:
+    pass
+
 ###########################################################################
 
 def get_version():
@@ -205,6 +210,9 @@ def execc(conf, logger, analysers, options, osmosis_manager):
     lunched_analyser_resume = []
 
     for analyser in analysers:
+        if os.getenv('SENTRY_DSN'):
+            sentry_sdk.set_tag('analyser', analyser)
+
         if not options.analyser and analyser not in conf.analyser:
             continue
 
@@ -319,14 +327,19 @@ def execc(conf, logger, analysers, options, osmosis_manager):
                         if not update_finished:
                             err_code |= 1
 
-        except:
+        except Exception as e:
             tb = traceback.format_exc()
             logger.sub().err("error on analyse {0}...".format(analyser))
             for l in tb.splitlines():
                 logger.sub().sub().log(l)
             err_code |= 2
+            if os.getenv('SENTRY_DSN'):
+                sentry_sdk.capture_exception(e)
             continue
 
+    if os.getenv('SENTRY_DSN'):
+        sentry_sdk.set_tag('analyser', None)
+
     if not options.no_clean:
         for (obj, analyser_conf) in lunched_analyser:
             analyser_conf.error_file = None
@@ -426,6 +439,9 @@ def main(options):
 
     logger.log("osmose backend version: %s" % get_version())
 
+    if os.getenv('SENTRY_DSN'):
+        sentry_sdk.init(dsn=os.getenv('SENTRY_DSN'), traces_sample_rate=1.0, release=get_version())
+
     old_path = list(sys.path)
     sys.path.insert(0, analysers_path)
 
@@ -459,6 +475,8 @@ def main(options):
 
     for country in options.country:
         country_conf = config.config[country]
+        if os.getenv('SENTRY_DSN'):
+            sentry_sdk.set_tag('country', country)
 
         # acquire lock
         try:
@@ -487,6 +505,9 @@ def main(options):
         # free lock
         del lock
 
+    if os.getenv('SENTRY_DSN'):
+        sentry_sdk.set_tag('country', None)
+
     logger.log(logger.log_av_green+u"end of analyses"+logger.log_ap)
     return err_code
 

requirements.txt

@@ -14,6 +14,7 @@ git+https://github.com/jocelynj/PyEasyArchive.git
 protobuf < 4 # 4.x binary not yet compatible with system package, deps of vt2geojson
 vt2geojson
 tiletanic
+sentry-sdk
 
 # Tests
 pytest