use CLUSTERMQ_AUTO_LIBZMQ to always enable crash monitor

Author: mschubert

NEWS.md

@@ -3,6 +3,7 @@
 * Random seed initialization now starts from the supplied seed
 * Worker errors now report the random seed if used
 * Worker memory is now reported for the process instead of R only
+* Installation: `CLUSTERMQ_AUTO_LIBZMQ=1` will ensure crash monitor is enabled
 
 # clustermq 0.10.0
 

README.md

@@ -11,6 +11,7 @@ cluster with a minimal interface provided by the `Q` function:
 
 ```r
 # install/load the package if you haven't done so yet
+Sys.setenv(CLUSTERMQ_AUTO_LIBZMQ=1)
 install.packages('clustermq')
 library(clustermq)
 

configure

@@ -14,8 +14,13 @@ if [ -z "$CLUSTERMQ_USE_SYSTEM_LIBZMQ" ]; then
       echo "* libzmq has DRAFT API -> enabling crash monitor feature"
       CLUSTERMQ_USE_SYSTEM_LIBZMQ=1
     else
-      echo "* libzmq without DRAFT API found -> disabling crash monitor feature"
-      CLUSTERMQ_USE_SYSTEM_LIBZMQ=1
+      if [ -z "$CLUSTERMQ_AUTO_LIBZMQ" ]; then
+        echo "* libzmq without DRAFT API found -> disabling crash monitor feature"
+        CLUSTERMQ_USE_SYSTEM_LIBZMQ=1
+      else
+        echo "* libzmq without DRAFT API found -> using bundled library instead"
+        CLUSTERMQ_USE_SYSTEM_LIBZMQ=0
+      fi
     fi
   else
     echo "* no system libzmq>=4.3.0 found -> using bundled libzmq"

vignettes/userguide.Rmd

@@ -40,7 +40,7 @@ the bundled library:
 #   If your system has `libzmq` installed but you want to enable the worker
 #   crash monitor, set the environment variable below to use the bundled
 #   `libzmq` library with the required feature (`-DZMQ_BUILD_DRAFT_API=1`):
-Sys.setenv(CLUSTERMQ_USE_SYSTEM_LIBZMQ=0)
+Sys.setenv(CLUSTERMQ_AUTO_LIBZMQ=1)
 install.packages("clustermq")
 ```
 
@@ -51,7 +51,7 @@ compilation:
 ```{r eval=FALSE}
 if (!requireNamespace("remotes", quietly=TRUE))
     install.packages("remotes")
-Sys.setenv(CLUSTERMQ_USE_SYSTEM_LIBZMQ=0)
+Sys.setenv(CLUSTERMQ_AUTO_LIBZMQ=1)
 remotes::install_github("mschubert/clustermq")
 # remotes::install_github("mschubert/clustermq@develop") # dev version
 ```