MMOframework
Why AI Playground Libraries Documentation Search Agency
FR EN
Index

HubShellController

MMO\admin\controllers · 1 symbol · generated 27 Oct 2026

class

HubShellController

HubShellController.php:27

A monitoring hub from the command line: php hub.php <command> in the hub's folder (Hub).

class MMO\admin\controllers\HubShellController extends MMO\core\classes\aShellController
Namespace
MMO\admin\controllers
Extends
aShellController
- `collect [--subjects=ovh1,client1] [--probes=system,http] [-q]` runs the probes now: what cron does every few minutes; - `status` the fleet, one line per server and site; `incidents [--all]` what went wrong; `ack --id= [--note=]`; - `watch [--interval=300]` collects again and again, in a terminal left open, when there is no cron; - `tool --subject=ovh1 --tool=processes` a read-only tool ([`Tools`](https://mmoframework.fr/en/documentation/mmo.admin/php/monitoring/Tools.md#tools)), `tool --subject=ovh1` lists them; - `serve [--port=]` the hub's page on http://127.0.0.1:{port} (`hub.json`'s `port`), run as you: with your ssh agent; - `check` reads hub.json and the declarations, then reaches every server once; - `cron` the crontab line collecting at the hub's interval; `token` a token for the sites' MetricsController; - `prune` forgets what is older than the retention (a collection does it once a day). `-m` answers in json.
php hub.php collectphp hub.php tool --subject=server:ovh1 --tool=connectionsphp hub.php serve

Constants1

COLOURS

the colour of each status in a terminal

const COLOURS = ['ok' => '', 'warning' => '', 'critical' => '', 'unknown' => '']

Properties3

exitCode

protected int $exitCode = 0
Type
int

hub

string $hub = '{root}/hub.json'
Type
string

instance

protected ?MMO\admin\monitoring\Hub $instance = null
Type
null | Hub

Methods19

getExitCode()

HubShellController.php:44
function getExitCode(): int
returnsint1 when the last collect or status found something critical, for a script or a cron to act on

route_ack($route)

HubShellController.php:103
#[MMO\core\attributes\InteractiveCommand('ack', 'acknowledge an incident: --id= --note=')] function route_ack(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

route_check($route)

HubShellController.php:139
#[MMO\core\attributes\InteractiveCommand('check', 'read hub.json and the declarations, then reach every server once')] function route_check(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

route_collect($route)

HubShellController.php:47
#[MMO\core\attributes\InteractiveCommand('collect', 'run the probes on the servers and sites now: --subjects=a,b --probes=system,http -q')] function route_collect(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

route_cron($route)

HubShellController.php:170
#[MMO\core\attributes\InteractiveCommand('cron', 'the crontab line that collects at the hub\'s interval')] function route_cron(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

route_incidents($route)

HubShellController.php:95
#[MMO\core\attributes\InteractiveCommand('incidents', 'what went wrong: the open incidents, --all with the resolved ones')] function route_incidents(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

route_prune($route)

HubShellController.php:189
#[MMO\core\attributes\InteractiveCommand('prune', 'forget what is older than the retention')] function route_prune(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

route_serve($route)

HubShellController.php:162
#[MMO\core\attributes\InteractiveCommand('serve', 'the hub\'s page on http://127.0.0.1:--port= (hub.json\'s), run as you: with your ssh agent')] function route_serve(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

route_status($route)

HubShellController.php:65
#[MMO\core\attributes\InteractiveCommand('status', 'the fleet: every server and site, its status and its main numbers')] function route_status(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

route_token($route)

HubShellController.php:180
#[MMO\core\attributes\InteractiveCommand('token', 'a token for the sites\' MetricsController: the token for hub.credentials.json, its hash for the site')] function route_token(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

route_tool($route)

HubShellController.php:124
#[MMO\core\attributes\InteractiveCommand('tool', 'a read-only tool on a server or a site: --subject=ovh1 --tool=processes (no --tool: the list)')] function route_tool(MMO\core\server\Route $route): void
$routeRoute
returnsvoid

route_watch($route)

HubShellController.php:110
#[MMO\core\attributes\InteractiveCommand('watch', 'collect again and again, every --interval= seconds (the hub\'s by default), until Ctrl+C or --times=')] function route_watch(MMO\core\server\Route $route): void
$routeRoute
returnsvoid
Inherited members (65)
ConstantsDeclared byDescription
ALERTiLogLevelAlert: Action must be taken immediately.
ALLiLogLevelMask for all
ALL_PLUSiLogLeveldebug everything
BACKTRACEiLogLevel
CRITICALiLogLevelCritical: Critical conditions.
DEBUGiLogLevelDebug: Detailed debug information.
DEEPiLogLeveldebug everything with arguments
EMERGENCYiLogLevelEmergency: System is unusable.
ERRORiLogLevelError: Runtime errors that do not require immediate action but should typically be logged and monitored.
ERROR_PLUSiLogLevelMask for all error
FATALiLogLevelMask for all fatal error
INFOiLogLevelInfo: Interesting events.
INFO_PLUSiLogLevelMask for all errors/warning/notices/info
MEMORYiLogLevelinclude backtrace object
NOTICEiLogLevelNotice: Normal but significant events.
NOTICE_PLUSiLogLevelMask for all errors/warning/notices/info
TRACEiLogLevelinclude backtrace as origins
WARNINGiLogLevelWarning: Exceptional occurrences that are not errors.
WARNING_PLUSiLogLevelMask for all errors and warnings
PropertiesDeclared byDescription
interactiveaShellController
verbosityaModule
MethodsDeclared byDescription
alert($message, $context)aModuleAction must be taken immediately.
backtraces($message, $context)aModuleForce-log a message at INFO level together with a full stack trace/memory snapshot (iLogLevel::BACKTRACE), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
callInteractiveCommand($route, $cmd)aShellControllerInvoke the method behind $cmd (looked up via InteractiveCommands), or print an "unknown command" message if $cmd doesn't match any registered interactive command.
Configure($config)aModuleMerge $config into this module's configuration in the shared Configuration.
critical($message, $context)aModuleCritical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
debug($message, $context)aModuleDetailed debug information.
debugName()aModuleHuman-readable identifier used as the default {origin} in this instance's log messages.
DefaultConfig()aModuleThe config a module starts from before anything loaded via Configuration is merged in.
emergency($message, $context)aModuleSystem is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
error($message, $context)aModuleRuntime errors that do not require immediate action but should typically be logged and monitored.
ExtractRoutes($config)aControllerExtract all the APIRoute from this class, regardless of the fact they are registered in the application
getVerbosity()aModule
hasOtherCommand($route)aShellControllerTell if another shell controller matched a command of its own (anything but its index) for $route
HasRoutes()aControllerTells if any APIRoute are registered in the application
index($route)aShellControllerThe built-in interactive REPL: shows the splash + command list, then loops reading a command name (with autocompletion, via ask) and dispatching it through callInteractive…
info($message, $context)aModuleInteresting events. No-op if INFO is currently filtered out by the verbosity mask.
Instantiate($config)aModule(Re)create the shared instance immediately, configured with $config merged into the class's existing config.
InteractiveCommands()aShellControllerEvery #[InteractiveCommand(...)]-decorated method on this class, keyed by its command name.
IsShared()aModule
Link($method, $data)aControllerBuild a Link (URL + label/icon/description/title, taken from the route's APIRoute metadata) for a registered route.
log($level, $message, $context)aModuleLogs with an arbitrary level.
notice($message, $context)aModuleNormal but significant events.
offsetExists($key)aModule\ArrayAccess::offsetExists -- tells whether $key is a declared property at all, regardless of whether it is currently readable/writable through array access.
offsetGet($key)aModule\ArrayAccess::offsetGet -- reads a property directly, unless it has a #[Serialize(serialize: 'methodName')] attribute, in which case that zero-argument method is called instead (e.g.
offsetSet($key, $value)aModule\ArrayAccess::offsetSet -- sets a property directly, unless it has a #[Serialize(unserialize: 'methodName')] attribute, in which case that method is called with $value instead (e.g.
offsetUnset($key)aModule\ArrayAccess::offsetUnset -- equivalent to $module[$key] = null.
onRoute($route)aShellControllerSame as aController::onRoute, plus: forces the response to shell/text output, and decides whether to fall back to the built-in interactive index command -- it stays active only if this is…
Route($method)aControllerGet a registered APIRoute WARNING: if this class was not registered in the application, it will return null.
Routes()aControllerGet a list of registered APIRoutes (from this class) in the application WARNING: if this class was not registered in the application, it will return an empty array.
route_help($route)aShellControllerPrint CLI usage for every 'SHELL'-method route on this controller: the command line to type, each argument's name/required-ness/description, and any declared usage examples.
serialize($path, $serializer)aModule\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
setInteractive($interactive)aShellController
setVerbosity($verb)aModuleSet the current verbosity mask, replacing whatever it was before.
Shared()aModuleGet the shared instance, creating (and configuring) it on first call.
showInteractiveCommands()aShellControllerPrint the list of available interactive commands, plus the [ENTER]/[ESC]/q hints.
showSplash()aShellControllerPrint the application's icon/version/title/description banner.
testVerbosity($level)aModuleTest whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
traitUnshare($serialize)aModuleRemove the shared instance, so the next Shared() call creates a fresh one.
unserialize($data, $path, $instances)aModule\MMO\core\interfaces\iSerializable::unserialize -- merges $data onto DefaultConfig, runs it through the (possibly overridden) constructor, then applies each resulting value to its property (via
Unshare($serialize)aModuleLike tSingleton::Unshare, but also disconnects this module's instance from every event it was listening to (via Event::DisconnectListeners) before dropping it.
Url($method, $data)aControllerBuild the URL for a registered route, filling in any {placeholder} from $data.
warning($message, $context)aModuleExceptional occurrences that are not errors.
__construct($config)aModuleprotected constructor, so it is not possible to do new Module(...) called by the serialization process just before being injected with data.
__wakeup()aControllerCalled automatically right after the controller's shared instance is built (aModule::unserialize): registers onRoute as a Route listener with a low priority (-10), so it…