ENH: Add migas telemetry to nibabies (#226)

* ENH: Add migas telemetry to nibabies

* FIX: Use conda installation of git-annex

* ENH: Add migas envvar to enable tracking

* CI: Disable usage reporting for CI

Author: mgxd

.circleci/config.yml

@@ -338,7 +338,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 \
+                --network none --notrack \
                 --config $PWD/nipype.cfg -w /tmp/${DATASET}/work \
                 --fs-subjects-dir /tmp/data/${DATASET}/derivatives/infant-freesurfer \
                 --skull-strip-template UNCInfant:cohort-1 \
@@ -364,7 +364,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 \
+                --network none --notrack \
                 --config $PWD/nipype.cfg -w /tmp/${DATASET}/work \
                 --fs-subjects-dir /tmp/data/${DATASET}/derivatives/infant-freesurfer \
                 --skull-strip-template UNCInfant:cohort-1 \

Dockerfile

@@ -37,8 +37,7 @@ RUN curl -sSL "http://neuro.debian.net/lists/$( lsb_release -c | cut -f2 ).us-ca
     (apt-key adv --refresh-keys --keyserver hkp://ha.pool.sks-keyservers.net 0xA5D32F012649A5A9 || true)
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
-                    connectome-workbench=1.5.0-1~nd20.04+1 \
-                    git-annex-standalone=8.20211123+git12-g02e3756bd-1~ndall+1 && \
+                    connectome-workbench=1.5.0-1~nd20.04+1 && \
     apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
 # Installing ANTs 2.3.4 (NeuroDocker build)

nibabies/cli/run.py

@@ -13,6 +13,7 @@ def main():
     from pathlib import Path
 
     from ..utils.bids import write_bidsignore, write_derivative_description
+    from ..utils.misc import ping_migas
     from .parser import parse_args
     from .workflow import build_boilerplate, build_workflow
 
@@ -22,6 +23,10 @@ def main():
 
     parse_args()
 
+    # collect telemetry information - if `--notrack` is specified,
+    # nothing is sent.
+    ping_migas()
+
     if "participant" in config.workflow.analysis_level:
         _pool = None
         if config.nipype.plugin == "MultiProc":
@@ -54,6 +59,7 @@ def main():
         nibabies_wf = retval['workflow']
 
         if nibabies_wf is None:
+            ping_migas(status='error')
             if config.execution.reports_only:
                 sys.exit(int(retcode > 0))
             sys.exit(os.EX_SOFTWARE)
@@ -62,11 +68,13 @@ def main():
             nibabies_wf.write_graph(graph2use="colored", format="svg", simple_form=True)
 
         if retcode != 0:
+            ping_migas(status='error')
             sys.exit(retcode)
 
         # generate boilerplate
         build_boilerplate(nibabies_wf)
         if config.execution.boilerplate_only:
+            ping_migas(status='success')
             sys.exit(0)
 
         gc.collect()
@@ -91,12 +99,13 @@ def main():
             nibabies_wf.run(**_plugin)
         except Exception as e:
             config.loggers.workflow.critical("nibabies failed: %s", e)
+            ping_migas(status='error')
             raise
         else:
             config.loggers.workflow.log(25, "nibabies finished successfully!")
-
             # Bother users with the boilerplate only iff the workflow went okay.
             boiler_file = config.execution.nibabies_dir / "logs" / "CITATION.md"
+            ping_migas(status='success')
             if boiler_file.exists():
                 if config.environment.exec_env in (
                     "singularity",

nibabies/config.py

@@ -399,7 +399,7 @@ class execution(_Config):
     nibabies_dir = None
     """Root of NiBabies BIDS Derivatives dataset. Depends on output_layout."""
     notrack = False
-    """Do not monitor *nibabies* using Sentry.io."""
+    """Do not monitor *nibabies* using *migas*."""
     output_dir = None
     """Folder where derivatives will be stored."""
     me_output_echos = False

nibabies/utils/misc.py

@@ -2,6 +2,8 @@
 # vi: set ft=python sts=4 ts=4 sw=4 et:
 """Miscellaneous utilities."""
 
+from .. import __version__
+
 
 def fix_multi_source_name(in_files):
     """
@@ -111,3 +113,29 @@ def combine_meepi_source(in_files):
     entities = [ent for ent in in_file.split("_") if not ent.startswith("echo-")]
     basename = "_".join(entities)
     return os.path.join(base, basename)
+
+
+def ping_migas(status='pending'):
+    """Communicate with the migas telemetry server."""
+    import os
+
+    import migas
+
+    from ..config import execution
+
+    if execution.notrack:
+        return
+
+    os.environ['ENABLE_MIGAS'] = 'yes'
+    session_id = None
+    if execution.run_uuid:
+        session_id = execution.run_uuid.split('_')[1]
+
+    # TODO: check for bad versions
+    res = migas.add_project(
+        project="nipreps/nibabies",
+        project_version=__version__,
+        status=status,
+        session_id=session_id,  # uuid
+    )
+    return res

setup.cfg

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