Implement Docker Health Checks

Implements health check server from
NeonGeckoCom/neon-utils#551
Adds a CLI option to enable health check server on a specified port
Adds a script and updates Dockerfile to enable Docker health checks

Author: NeonDaniel

Dockerfile

@@ -11,19 +11,20 @@ EXPOSE 18181
 
 RUN apt-get update && \
     apt-get install -y \
+    git \
     gcc \
     g++ \
     python3-dev \
     swig \
     libssl-dev \
     libfann-dev
 
-ADD . /neon_gui
+COPY . /neon_gui
 WORKDIR /neon_gui
 
-RUN pip install wheel \
-    && pip install .[docker]
+RUN pip install --no-cache-dir wheel \
+    && pip install --no-cache-dir .[docker]
 
 COPY docker_overlay/ /
-
-CMD ["neon-gui", "run"]
+HEALTHCHECK CMD "/opt/neon/healthcheck.sh"
+CMD ["neon-gui", "run", "-p", "8000"]

docker_overlay/opt/neon/healthcheck.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2025 Neongecko.com Inc.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+port=8000
+# Perform the health check using curl
+resp_content=$(curl -s http://localhost:${port}/status)
+if [ "${resp_content}" == "Ready" ]; then
+  exit 0  # Success
+else
+  echo "Health check failed with response: ${resp_content}" >&2
+  exit 1  # Failure
+fi

neon_gui/__main__.py

@@ -30,16 +30,24 @@
 from ovos_utils.log import LOG
 from neon_gui.service import NeonGUIService
 from neon_utils.log_utils import init_log
-from neon_utils.process_utils import start_malloc, snapshot_malloc, print_malloc
+from neon_utils.process_utils import (
+    start_malloc,
+    snapshot_malloc,
+    print_malloc,
+)
 from ovos_utils.process_utils import reset_sigint_handler
 
 
 def main(*args, **kwargs):
     init_log(log_name="gui")
     malloc_running = start_malloc(stack_depth=4)
     reset_sigint_handler()
-
+    health_check_server_port = kwargs.pop("health_check_server_port", None)
     gui = NeonGUIService(*args, **kwargs)
+    if health_check_server_port is not None:
+        from neon_utils.process_utils import start_health_check_server
+
+        start_health_check_server(gui.status, health_check_server_port)
     gui.start()
     wait_for_exit_signal()
     if malloc_running:
@@ -52,8 +60,10 @@ def main(*args, **kwargs):
 
 def deprecated_entrypoint():
     from ovos_utils.log import log_deprecation
-    log_deprecation("Use `neon-gui run` in place of "
-                    "`neon_gui_service`", "2.0.0")
+
+    log_deprecation(
+        "Use `neon-gui run` in place of `neon_gui_service`", "2.0.0"
+    )
     main()
 
 

neon_gui/cli.py

@@ -28,6 +28,7 @@
 
 import click
 
+from typing import Optional
 from os import environ
 from click_default_group import DefaultGroup
 from neon_utils.packaging_utils import get_package_version_spec
@@ -36,21 +37,36 @@
 environ.setdefault("OVOS_CONFIG_FILENAME", "neon.yaml")
 
 
-@click.group("neon-gui", cls=DefaultGroup,
-             no_args_is_help=True, invoke_without_command=True,
-             help="Neon GUI module Commands\n\n"
-                  "See also: neon COMMAND --help")
-@click.option("--version", "-v", is_flag=True, required=False,
-              help="Print the current version")
+@click.group(
+    "neon-gui",
+    cls=DefaultGroup,
+    no_args_is_help=True,
+    invoke_without_command=True,
+    help="Neon GUI module Commands\n\nSee also: neon COMMAND --help",
+)
+@click.option(
+    "--version",
+    "-v",
+    is_flag=True,
+    required=False,
+    help="Print the current version",
+)
 def neon_gui_cli(version: bool = False):
     if version:
-        click.echo(f"neon_gui version "
-                   f"{get_package_version_spec('neon_gui')}")
+        click.echo(f"neon_gui version {get_package_version_spec('neon_gui')}")
 
 
 @neon_gui_cli.command(help="Start Neon GUI module")
-def run():
+@click.option(
+    "--health-check-server-port",
+    "-p",
+    type=int,
+    default=None,
+    help="Port for health check server to listen on",
+)
+def run(health_check_server_port: Optional[int] = None):
     from neon_gui.__main__ import main
+
     click.echo("Starting GUI Service")
-    main()
+    main(health_check_server_port=health_check_server_port)
     click.echo("GUI Service Shutdown")

requirements/requirements.txt

@@ -1,8 +1,9 @@
-neon-utils[network]~=1.6
+#neon-utils[network]~=1.6
+neon-utils[network] @ git+https://github.com/neongeckocom/neon-utils@FEAT_HttpStatusServer#egg=neon-utils
 ovos-utils~=0.0,>=0.0.34
 ovos-config~=0.0,>=0.0.10
 click~=8.0
 click-default-group~=1.2
 tornado~=6.0
 ovos-bus-client~=0.0,>=0.0.6
-ovos-gui~=0.2
+ovos-gui~=0.2