Add Hub Mode for inspector

sanic/cli/app.py

@@ -146,11 +146,14 @@ def _inspector(self):
         action = kwargs.pop("action") or "info"
         api_key = kwargs.pop("api_key")
         positional = kwargs.pop("positional", None)
+        as_json = kwargs.pop("json", False)
         if action == "<custom>" and positional:
             action = positional[0]
             if len(positional) > 1:
                 kwargs["args"] = positional[1:]
-        InspectorClient(host, port, secure, raw, api_key).do(action, **kwargs)
+        InspectorClient(host, port, secure, raw, api_key).do(
+            action, as_json=as_json, **kwargs
+        )
 
     def _repl(self, app: Sanic):
         if is_atty():

sanic/cli/inspector.py

@@ -59,6 +59,16 @@ def make_inspector_parser(parser: ArgumentParser) -> None:
         title="  Subcommands",
         parser_class=InspectorSubParser,
     )
+    info = subparsers.add_parser(
+        "info",
+        help="Display information about the application instance",
+        formatter_class=SanicHelpFormatter,
+    )
+    info.add_argument(
+        "--json",
+        action="store_true",
+        help="Output the information in JSON format",
+    )
     reloader = subparsers.add_parser(
         "reload",
         help="Trigger a reload of the server workers",

sanic/cli/inspector_client.py

@@ -41,9 +41,9 @@ def __init__(
                 self.scheme = scheme
                 self.host = self.host[len(full) :]  # noqa E203
 
-    def do(self, action: str, **kwargs: Any) -> None:
+    def do(self, action: str, *, as_json: bool = False, **kwargs: Any) -> None:
         if action == "info":
-            self.info()
+            self.info(as_json)
             return
         result = self.request(action, **kwargs).get("result")
         if result:
@@ -54,21 +54,60 @@ def do(self, action: str, **kwargs: Any) -> None:
             )
             sys.stdout.write(out + "\n")
 
-    def info(self) -> None:
-        out = sys.stdout.write
+    def info(self, as_json: bool = False) -> None:
         response = self.request("", "GET")
         if self.raw or not response:
             return
         data = response["result"]
         display = data.pop("info")
+        nodes = data.pop("nodes", {})
+        if as_json:
+            data = {
+                "info": display,
+                **data,
+            }
+            if nodes:
+                data["nodes"] = {
+                    node: _data["info"] for node, _data in nodes.items()
+                }
+                data["workers"] = {
+                    f"{name} (Hub)": {"node": "Hub", **info}
+                    for name, info in data["workers"].items()
+                } | {
+                    f"{name} ({node})": {"node": node, **info}
+                    for node, _data in nodes.items()
+                    for name, info in _data["workers"].items()
+                }
+            sys.stdout.write(dumps(data) + "\n")
+
+            return
+        self._display_info(display)
+        self._display_workers(data["workers"], None if not nodes else "Hub")
+        if nodes:
+            for name, node in nodes.items():
+                # info = node.pop("info")
+                workers = node.pop("workers")
+                # self._display_info(info)
+                self._display_workers(workers, name)
+
+    def _display_info(self, display: Dict[str, Any]) -> None:
         extra = display.pop("extra", {})
+        out = sys.stdout.write
         display["packages"] = ", ".join(display["packages"])
         MOTDTTY(get_logo(), self.base_url, display, extra).display(
             version=False,
             action="Inspecting",
             out=out,
         )
-        for name, info in data["workers"].items():
+
+    def _display_workers(
+        self, workers: Dict[str, Dict[str, Any]], node: Optional[str] = None
+    ) -> None:
+        out = sys.stdout.write
+        for name, info in workers.items():
+            name = f"{Colors.BOLD}{Colors.SANIC}{name}{Colors.END}"
+            if node:
+                name += f" {Colors.BOLD}{Colors.YELLOW}({node}){Colors.END}"
             info = "\n".join(
                 f"\t{key}: {Colors.BLUE}{value}{Colors.END}"
                 for key, value in info.items()
@@ -78,7 +117,7 @@ def info(self) -> None:
                 + indent(
                     "\n".join(
                         [
-                            f"{Colors.BOLD}{Colors.SANIC}{name}{Colors.END}",
+                            name,
                             info,
                         ]
                     ),

sanic/config.py

@@ -51,6 +51,9 @@
     "INSPECTOR_TLS_KEY": _default,
     "INSPECTOR_TLS_CERT": _default,
     "INSPECTOR_API_KEY": "",
+    "INSPECTOR_HUB_MODE": _default,
+    "INSPECTOR_HUB_HOST": "",
+    "INSPECTOR_HUB_PORT": 0,
     "KEEP_ALIVE_TIMEOUT": 120,
     "KEEP_ALIVE": True,
     "LOCAL_CERT_CREATOR": LocalCertCreator.AUTO,
@@ -112,6 +115,9 @@ class Config(dict, metaclass=DescriptorMeta):
     INSPECTOR_TLS_KEY: Union[Path, str, Default]
     INSPECTOR_TLS_CERT: Union[Path, str, Default]
     INSPECTOR_API_KEY: str
+    INSPECTOR_HUB_MODE: Union[bool, Default]
+    INSPECTOR_HUB_HOST: str
+    INSPECTOR_HUB_PORT: int
     KEEP_ALIVE_TIMEOUT: int
     KEEP_ALIVE: bool
     LOCAL_CERT_CREATOR: Union[str, LocalCertCreator]

sanic/mixins/startup.py

@@ -1137,8 +1137,12 @@ def serve(
                     primary.config.INSPECTOR_API_KEY,
                     primary.config.INSPECTOR_TLS_KEY,
                     primary.config.INSPECTOR_TLS_CERT,
+                    primary.config.INSPECTOR_HUB_MODE,
+                    primary.config.INSPECTOR_HUB_HOST,
+                    primary.config.INSPECTOR_HUB_PORT,
                 )
-                manager.manage("Inspector", inspector, {}, transient=False)
+                # TODO: Change back to false
+                manager.manage("Inspector", inspector, {}, transient=True)
 
             primary._inspector = inspector
             primary._manager = manager