Adds inactivity detection

.github/workflows/check-image.yml

@@ -9,14 +9,14 @@ jobs:
       - name: Checkout repo content
         uses: actions/checkout@v2
       - name: ooil version
-        uses: docker://itisfoundation/ci-service-integration-library:v1.0.3-dev-4
+        uses: docker://itisfoundation/ci-service-integration-library:v1.0.4
         with:
           args: ooil --version
-      - name: Assemble docker-compose spec
-        uses: docker://itisfoundation/ci-service-integration-library:v1.0.3-dev-4
+      - name: Assemble docker compose spec
+        uses: docker://itisfoundation/ci-service-integration-library:v1.0.4
         with:
           args: ooil compose
       - name: Build all images if multiple
-        uses: docker://itisfoundation/ci-service-integration-library:v1.0.3-dev-4
+        uses: docker://itisfoundation/ci-service-integration-library:v1.0.4
         with:
           args: docker compose build

.gitignore

@@ -53,4 +53,4 @@ docker-compose.yml
 # ignore all files in validation
 validation/
 
-*.ignore.*
+*.ignore.*

.osparc/jupyter-math/runtime.yml

@@ -18,3 +18,8 @@ paths-mapping:
   outputs_path: /home/jovyan/work/outputs
   state_paths:
     - /home/jovyan/work/workspace
+callbacks-mapping:
+  inactivity:
+    service: container
+    command: ["python", "/usr/local/bin/service-monitor/activity.py"]
+    timeout: 1

Dockerfile

@@ -75,8 +75,8 @@ RUN jupyter serverextension enable voila && \
 # Import matplotlib the first time to build the font cache.
 ENV XDG_CACHE_HOME /home/$NB_USER/.cache/
 RUN MPLBACKEND=Agg .venv/bin/python -c "import matplotlib.pyplot" && \
-fix-permissions /home/$NB_USER
-  # run fix permissions only once. This can be probably optimized, so it is faster to build
+  fix-permissions /home/$NB_USER
+# run fix permissions only once. This can be probably optimized, so it is faster to build
 
 # copy README and CHANGELOG
 COPY --chown=$NB_UID:$NB_GID CHANGELOG.md ${NOTEBOOK_BASE_DIR}/CHANGELOG.md
@@ -92,6 +92,29 @@ ENV JP_LSP_VIRTUAL_DIR="/home/${NB_USER}/.virtual_documents"
 # Copying boot scripts
 COPY --chown=$NB_UID:$NB_GID docker /docker
 
+# install service activity monitor
+ARG ACTIVITY_MONITOR_VERSION=v0.0.1
+
+# Detection thresholds for application
+ENV ACTIVITY_MONITOR_BUSY_THRESHOLD_CPU_PERCENT=0.5
+ENV ACTIVITY_MONITOR_BUSY_THRESHOLD_DISK_READ_BPS=0
+ENV ACTIVITY_MONITOR_BUSY_THRESHOLD_DISK_WRITE_BPS=0
+ENV ACTIVITY_MONITOR_BUSY_THRESHOLD_NETWORK_RECEIVE_BPS=1024
+ENV ACTIVITY_MONITOR_BUSY_THRESHOLD_NETWORK_SENT_BPS=1024
+
+# TODO: above values require some tewaking otherwise this will always be considered in use
+
+# install service activity monitor
+RUN apt-get update && \
+  apt-get install -y curl && \
+  # install using curl
+  curl -sSL https://raw.githubusercontent.com/ITISFoundation/service-activity-monitor/main/scripts/install.sh | \
+  bash -s -- ${ACTIVITY_MONITOR_VERSION} && \
+  # cleanup and remove curl
+  apt-get purge -y --auto-remove curl && \
+  rm -rf /var/lib/apt/lists/*
+
+
 RUN echo 'export PATH="/home/${NB_USER}/.venv/bin:$PATH"' >> "/home/${NB_USER}/.bashrc"
 
 EXPOSE 8888

Makefile

@@ -29,13 +29,14 @@ devenv: .venv  ## create a python virtual environment with tools to dev, run and
 requirements: devenv ## runs pip-tools to build requirements.txt that will be installed in the JupyterLab
 	# freezes requirements
 	pip-compile kernels/python-maths/requirements.in --resolver=backtracking --output-file kernels/python-maths/requirements.txt
+	pip-compile requirements/test.in --resolver=backtracking --output-file requirements/test.txt
 
 # Builds new service version ----------------------------------------------------------------------------
 define _bumpversion
 	# upgrades as $(subst $(1),,$@) version, commits and tags
 	@docker run -it --rm -v $(PWD):/${DOCKER_IMAGE_NAME} \
 		-u $(shell id -u):$(shell id -g) \
-		itisfoundation/ci-service-integration-library:v1.0.3-dev-4 \
+		itisfoundation/ci-service-integration-library:v1.0.4 \
 		sh -c "cd /${DOCKER_IMAGE_NAME} && bump2version --verbose --list --config-file $(1) $(subst $(2),,$@)"
 endef
 
@@ -49,7 +50,7 @@ version-patch version-minor version-major: .bumpversion.cfg ## increases service
 compose-spec: ## runs ooil to assemble the docker-compose.yml file
 	@docker run -it --rm -v $(PWD):/${DOCKER_IMAGE_NAME} \
 		-u $(shell id -u):$(shell id -g) \
-		itisfoundation/ci-service-integration-library:v1.0.3-dev-4 \
+		itisfoundation/ci-service-integration-library:v1.0.4 \
 		sh -c "cd /${DOCKER_IMAGE_NAME} && ooil compose"
 
 build: | compose-spec	## build docker image

docker/entrypoint.bash

@@ -74,4 +74,5 @@ chmod gu-w "/home/${NB_USER}/work"
 
 echo
 echo "$INFO" "Starting notebook ..."
+exec gosu "$NB_USER" python /usr/local/bin/service-monitor/activity_monitor.py &
 exec gosu "$NB_USER" /docker/boot_notebook.bash

kernels/python-maths/requirements.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
-#    pip-compile --output-file=kernels/python-maths/requirements.txt --resolver=backtracking kernels/python-maths/requirements.in
+#    pip-compile --output-file=kernels/python-maths/requirements.txt kernels/python-maths/requirements.in
 #
 aiofiles==22.1.0
     # via ypy-websocket