ENH: Improve migas telemetry (#257)

* MAINT: Improve migas telemetry

* CI: Test tracking and `--notrack` implementations

Author: mgxd

.circleci/config.yml

@@ -296,6 +296,7 @@ jobs:
       - FS_LICENSE: /tmp/fslicense/license.txt
       - DATASET: bcp
       - CHECK_BCP: true
+      - MIGAS_OPTOUT: "1"
     steps:
       - checkout
       - run: *check_skip_job
@@ -364,7 +365,7 @@ jobs:
             nibabies-wrapper docker /tmp/data/${DATASET} /tmp/${DATASET}/derivatives/nibabies participant \
                 -i nipreps/nibabies:latest \
                 -e NIBABIES_DEV 1 --user $(id -u):$(id -g) \
-                --network none --notrack \
+                --network none \
                 --config $PWD/nipype.cfg -w /tmp/${DATASET}/work \
                 --fs-subjects-dir /tmp/data/${DATASET}/derivatives/infant-freesurfer \
                 --skull-strip-template UNCInfant:cohort-1 \

nibabies/cli/run.py

@@ -15,7 +15,6 @@ def main():
     from pathlib import Path
 
     from ..utils.bids import write_bidsignore, write_derivative_description
-    from ..utils.telemetry import setup_migas
     from .parser import parse_args
     from .workflow import build_boilerplate, build_workflow
 
@@ -29,8 +28,10 @@ def main():
     # if `--notrack` is specified, nothing is done.
     global EXITCODE
     if not config.execution.notrack:
-        setup_migas(init_ping=True)
-        atexit.register(_migas_exit)
+        from nibabies.utils.telemetry import setup_migas
+
+        setup_migas(init=True)
+        atexit.register(migas_exit)
 
     if "participant" in config.workflow.analysis_level:
         _pool = None
@@ -151,18 +152,36 @@ def main():
             write_bidsignore(config.execution.nibabies_dir)
 
 
-def _migas_exit() -> None:
+def migas_exit() -> None:
     """
     Send a final crumb to the migas server signaling if the run successfully completed
-
-    This function is registered with `atexit` to run at termination.
+    This function should be registered with `atexit` to run at termination.
     """
-    global EXITCODE
-    status = 'error' if EXITCODE > 0 else 'success'
+    import sys
 
-    from ..utils.telemetry import ping_migas
+    from nibabies.utils.telemetry import send_breadcrumb
+
+    global EXITCODE
+    migas_kwargs = {'status': 'C'}
+    # `sys` will not have these attributes unless an error has been handled
+    if hasattr(sys, 'last_type'):
+        migas_kwargs = {
+            'status': 'F',
+            'status_desc': 'Finished with error(s)',
+            'error_type': sys.last_type,
+            'error_desc': sys.last_value,
+        }
+    elif EXITCODE != 0:
+        migas_kwargs.update(
+            {
+                'status': 'F',
+                'status_desc': f'Completed with exitcode {EXITCODE}',
+            }
+        )
+    else:
+        migas_kwargs['status_desc'] = 'Success'
 
-    ping_migas(status=status)
+    send_breadcrumb(**migas_kwargs)
 
 
 if __name__ == "__main__":

nibabies/utils/telemetry.py

@@ -3,25 +3,25 @@
 from .. import __version__, config
 
 
-def setup_migas(init_ping: bool = True) -> None:
+def setup_migas(init: bool = True) -> None:
     """
     Prepare the migas python client to communicate with a migas server.
-    If `init_ping` is `True`, send an initial breadcrumb.
+    If ``init`` is ``True``, send an initial breadcrumb.
     """
     # generate session UUID from generated run UUID
     session_id = None
     if config.execution.run_uuid:
         session_id = config.execution.run_uuid.split('_', 1)[-1]
 
     migas.setup(session_id=session_id)
-    if init_ping:
+    if init:
         # send initial status ping
-        ping_migas(status='pending')
+        send_breadcrumb(status='R', status_desc='workflow start')
 
 
-def ping_migas(*, status: str) -> dict:
+def send_breadcrumb(**kwargs) -> dict:
     """
     Communicate with the migas telemetry server. This requires `migas.setup()` to be called.
     """
-    res = migas.add_project("nipreps/nibabies", __version__, status=status)
+    res = migas.add_project("nipreps/nibabies", __version__, **kwargs)
     return res

setup.cfg

@@ -25,7 +25,7 @@ url = https://github.com/nipreps/nibabies
 python_requires = >= 3.8
 install_requires =
     attrs
-    migas
+    migas >= 0.3.0
     nibabel >= 3.0.1
     nipype >= 1.8.1
     nitime