Improved logging and errors handling for sm-ssh-ide

Author: ivan-khvostishkov

SageMaker_SSH_IDE.ipynb

@@ -63,7 +63,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The next command will install the software for remote access, including SSH daemon and VNC server and XFCE4 desktop. If you don't want to run a VNC server or Jupyter notebook, pass the flag `--ssh-only` (comment the first line and uncomment the second). Also consider adding the same `--ssh-only` flag to the `sm-local-ssh-ide` command."
+    "The next command will install the software for remote access, including SSH daemon and VNC server and XFCE4 desktop. If you don't want to run a VNC server or Jupyter notebook, pass the flag `--ssh-only` (comment the first line and uncomment the second). Also consider adding the same flag to the `sm-local-ssh-ide` command."
    ]
   },
   {

sagemaker_ssh_helper/sm-ssh-ide

@@ -18,9 +18,11 @@ if [[ "$1" == "get-metadata" ]]; then
   echo "Domain: $(_print_sm_domain_id)"
   echo ""
   echo "Connect from local machine: sm-local-ssh-ide connect $(_print_sm_app_name)"
+  echo "Connect from local machine (SSH only): sm-local-ssh-ide connect $(_print_sm_app_name) --ssh-only"
 
 elif [[ "$1" == "configure" ]]; then
     OPTIONS=$2
+    echo "$OPTIONS" > ~/.sm-ssh-ide-options
 
     _install_helper_scripts
 
@@ -64,8 +66,6 @@ EOF
       fi
 
     else
-      echo "$OPTIONS" > ~/.sm-ssh-ide-options
-
       echo "sm-ssh-ide: Skipping VNC and GUI apps install"
     fi
 
@@ -155,7 +155,7 @@ elif [[ "$1" == "init-ssm" ]]; then
     sm-init-ssm | tee /proc/1/fd/1
 
 elif [[ "$1" == "start" ]]; then
-    OPTIONS=$(cat ~/.sm-ssh-ide-options)
+    OPTIONS=$(cat ~/.sm-ssh-ide-options || echo "")
 
     set -e
 
@@ -165,10 +165,13 @@ elif [[ "$1" == "start" ]]; then
 
     touch /tmp/.ssh-ide-local-lock
 
+    echo "sm-ssh-ide: Starting SSH service"
     service ssh start
 
     if [[ "$OPTIONS" != "--ssh-only" ]]; then
 
+      echo "sm-ssh-ide: Starting VNC server"
+
       export USER=root
       vncserver :1
 
@@ -177,24 +180,31 @@ elif [[ "$1" == "start" ]]; then
 
       echo "sm-ssh-ide: Using SageMaker Studio Python: $SM_STUDIO_PYTHON"
 
+      echo "sm-ssh-ide: Installing Jupyter notebook"
+
       "$SM_STUDIO_PYTHON_PREFIX"/bin/pip install -q notebook
 
       # TODO: remove the below temp fix for "cannot import name 'Callable' from 'traitlets" when starting notebook
       "$SM_STUDIO_PYTHON_PREFIX"/bin/pip install --force-reinstall traitlets
 
+      echo "sm-ssh-ide: Starting Jupyter notebook server"
+
       "$SM_STUDIO_PYTHON" -m jupyter notebook --no-browser --port=8889 --ip=127.0.0.1 --allow-root \
         >/tmp/jupyter-notebook.log 2>&1 &
 
       sleep 2
 
-      tail /tmp/jupyter-notebook.log
+      "$SM_STUDIO_PYTHON" -m jupyter notebook list
 
     else
       echo "sm-ssh-ide: Skipping VNC and Jupyter start"
     fi
 
+    echo "sm-ssh-ide: Started all services"
+
 elif [[ "$1" == "ssm-agent" ]]; then
 
+    echo "sm-ssh-ide: Starting SSM agent"
     /usr/bin/amazon-ssm-agent
 
 elif [[ "$1" == "status" ]]; then
@@ -227,26 +237,31 @@ elif [[ "$1" == "env-diagnostics" ]]; then
     find "$JUPYTER_PATH" -name 'kernel.json' -print0 | xargs -0 cat
 
 elif [[ "$1" == "stop" ]]; then
-    OPTIONS=$(cat ~/.sm-ssh-ide-options)
+    OPTIONS=$(cat ~/.sm-ssh-ide-options || echo "")
 
+    echo "sm-ssh-ide: Stopping SSM agent"
     pkill -ef amazon-ssm-agent || echo "sm-ssh-ide: SSM agent already stopped?"
 
+    echo "sm-ssh-ide: Stopping SSH service"
     service ssh stop
 
     if [[ "$OPTIONS" != "--ssh-only" ]]; then
 
-      vncserver -kill :1
+      echo "sm-ssh-ide: Stopping VNC server"
+      vncserver -kill :1 || echo "sm-ssh-ide: VNC server already stopped?"
 
       # Wait dbus to shop
       sleep 5
 
-      pkill -e Xtigervnc
-      pkill -e Xtightvnc
+      pkill -e Xtigervnc || :
+      pkill -e Xtightvnc || :
 
-      pkill -e ssh-agent
-      pkill -e gpg-agent
+      echo "sm-ssh-ide: Stopping SSH and GPG agents"
+      pkill -e ssh-agent || :
+      pkill -e gpg-agent || :
 
-      pkill -fe jupyter-notebook
+      echo "sm-ssh-ide: Stopping Jupyter notebook server"
+      pkill -fe jupyter-notebook || echo "sm-ssh-ide: Jupyter notebook already stopped?"
 
     else
       echo "sm-ssh-ide: Skipping VNC and Jupyter stop"
@@ -261,6 +276,8 @@ elif [[ "$1" == "stop" ]]; then
         echo "sm-ssh-ide: Local lock is missing, was not not running on this instance?"
     fi
 
+    echo "sm-ssh-ide: Stopped all services"
+
 else
 
     echo "sm-ssh-ide: Unknown command: $1"