MMOframework
Why AI Playground Libraries Documentation Search Agency
FR EN
Index

HubController

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

class

HubController

HubController.php:31

The api of a monitoring hub (Hub): what its pages' elements ask ({MMO\admin}/monitoring/pages, <mmo-hub-bar>, <mmo-hub-ack>, <mmo-hub-tools>), and what a script asks.

class MMO\admin\controllers\HubController extends MMO\core\classes\aDataController
Namespace
MMO\admin\controllers
Extends
aDataController
Every route reads what the last collection kept; only `collect.json` and the tools reach the servers, and the tools only run the read-only commands [`Tools`](https://mmoframework.fr/en/documentation/mmo.admin/php/monitoring/Tools.md#tools) writes. Nothing here changes a server or a site: deploying, rolling back, restoring stay the project's `php scripts/admin.php`. A hub runs on this machine, for its owner: by default the routes answer this machine only ([`$localOnly`](https://mmoframework.fr/en/documentation/mmo.admin/php/controllers/HubController.md#hubcontroller-localonly)). Served by `php hub.php serve`, the collections run as you, with your ssh agent; served by Apache, as Apache's user -- which usually has neither your agent nor the right to read the project's credentials: let cron collect (`php hub.php cron`) and switch [`$canCollect`](https://mmoframework.fr/en/documentation/mmo.admin/php/controllers/HubController.md#hubcontroller-cancollect) off. Declared by the hub's application (scripts/new-hub.php writes it): "MMO\\admin\\controllers\\HubController": {"hub": "{root}/hub.json"}
curl http://127.0.0.1:8765/api/hub.json curl http://127.0.0.1:8765/api/hub/servers/ovh1.json?range=604800 curl -X POST http://127.0.0.1:8765/api/hub/collect.json -d '{"subjects": ["ovh1"]}'

Properties6

canCollect

bool $canCollect = true
Type
bool

collectAfter

?int $collectAfter = null
Type
null | int

hub

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

instance

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

localOnly

bool $localOnly = true
Type
bool

Methods17

guard($route, $reach)

HubController.php:203
protected function guard(MMO\core\server\Route $route, bool $reach = false): ?array
$routeRoute
$reach = falseboolwhether the route reaches the servers
returnsnull | arraystring}|null why the request is refused, null when it is not

range($route)

HubController.php:219
protected function range(MMO\core\server\Route $route): int
$routeRoute
returnsintseconds of curves asked: between an hour and the retention

routeAcknowledge($route)

HubController.php:125
#[MMO\core\attributes\APIRoute('POST|api/hub/incidents/{id}/acknowledge.json', 'Acknowledge an incident: {note, by}', mediaTypes: ['json'])] function routeAcknowledge(MMO\core\server\Route $route): array
$routeRoutea JSON body {note, by}
returnsarray{incident}

routeCollect($route)

HubController.php:139
#[MMO\core\attributes\APIRoute('POST|api/hub/collect.json', 'Collect now: {subjects, probes}', mediaTypes: ['json'])] function routeCollect(MMO\core\server\Route $route): array
$routeRoutea JSON body {subjects, probes}, both optional: everything by default
returnsarray{readings, seconds, skipped, events, statuses}: how many readings, by status, and the incidents' events

routeDeployments($route)

HubController.php:155
#[MMO\core\attributes\APIRoute('GET|api/hub/deployments.json', 'The deployments this machine knows of: ?target=&count=', mediaTypes: ['json'])] function routeDeployments(MMO\core\server\Route $route): array
$routeRoute?target= one target's, &count= (50)
returnsarray{deployments}: what this machine knows was deployed (mmo.admin's history: sync, releases)

routeIncidents($route)

HubController.php:115
#[MMO\core\attributes\APIRoute('GET|api/hub/incidents.json', 'The incidents, the open ones first: ?all=1 adds the resolved ones', mediaTypes: ['json'])] function routeIncidents(MMO\core\server\Route $route): array
$routeRoute?all=1 for the resolved ones as well
returnsarray{incidents}

routeOverview($route)

HubController.php:61
#[MMO\core\attributes\APIRoute('GET|api/hub.json', 'The fleet: servers, targets, their status, the open incidents', mediaTypes: ['json'])] function routeOverview(MMO\core\server\Route $route): array
$routeRoute
returnsarraythe hub, every server and target with its status and key metrics, the open incidents (Hub::overview)

routeSeries($route)

HubController.php:96
#[MMO\core\attributes\APIRoute('GET|api/hub/series.json', 'Curves of several subjects: ?subjects=&metrics=&range=&points=', mediaTypes: ['json'])] function routeSeries(MMO\core\server\Route $route): array
$routeRoute?subjects=server:ovh1,target:client1&metrics=cpu.usedPercent,disk.*.usedPercent&range=&points=
returnsarray{series: {subject: curves}} (MonitorStore::series): several sites' response times on one chart

routeServer($route)

HubController.php:77
#[MMO\core\attributes\APIRoute('GET|api/hub/servers/{name}.json', 'One server: its readings, curves, incidents and sites: ?range=&points=', mediaTypes: ['json'])] function routeServer(MMO\core\server\Route $route): array
$routeRoute?range= seconds of curves (a day), &points= per curve (120)
returnsarrayone server: its readings, curves, incidents, targets (Hub::subject)

routeSettings($route)

HubController.php:181
#[MMO\core\attributes\APIRoute('GET|api/hub/settings.json', 'The rules, the probes and the notification channels in force', mediaTypes: ['json'])] function routeSettings(MMO\core\server\Route $route): array
$routeRoute
returnsarray{rules, probes, notify, ...}: the thresholds in force, the probes and the channels

routeTarget($route)

HubController.php:86
#[MMO\core\attributes\APIRoute('GET|api/hub/targets/{name}.json', 'One site: its readings, curves, incidents and deployments: ?range=&points=', mediaTypes: ['json'])] function routeTarget(MMO\core\server\Route $route): array
$routeRoute?range= seconds of curves (a day), &points= per curve (120)
returnsarrayone target: its readings, curves, incidents, deployments (Hub::subject)

routeTool($route)

HubController.php:166
#[MMO\core\attributes\APIRoute('POST|api/hub/tools/{tool}.json', 'Run a read-only tool on a server or a site: {subject}', mediaTypes: ['json'])] function routeTool(MMO\core\server\Route $route): array
$routeRoutea JSON body {subject}: server:ovh1, target:client1
returnsarray{tool, label, subject, command, output, ok, seconds} (Tools::Run)
Inherited members (62)
ConstantsDeclared byDescription
ALERTiLogLevelAlert: Action must be taken immediately.
ALLiLogLevelMask for all
ALL_PLUSiLogLeveldebug everything
BACKTRACEiLogLevel
COLORSaDataControllerNamed color palettes for chart/report endpoints, e.g.
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
repositoriesaDataController
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).
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
getMainRepository()aDataController
getRepositories()aDataController
getRepository($repo)aDataController
getVerbosity()aModule
HasRoutes()aControllerTells if any APIRoute are registered in the application
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.
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)aDataControllerSame as aController::onRoute, plus forcing the response to JSON (Response::Json) for every route this controller claims.
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.
serialize($path, $serializer)aModule\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
setRepositories($repositories)aDataControllerRegister the repositories this controller can query, keyed by name (e.g.
setVerbosity($verb)aModuleSet the current verbosity mask, replacing whatever it was before.
Shared()aModuleGet the shared instance, creating (and configuring) it on first call.
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…