Aller au contenu

Référence

phil/monitoring-bundle

Classes

ClasseRôle
Phil\MonitoringBundle\PhilMonitoringBundleLe bundle et sa configuration ; HEALTH_CHECK_TAG
…\Domain\Status\HealthStatusUp, Degraded, Down ; worst(), isAvailable()
…\Domain\Status\HeartbeatStateOnTime, Late, Never
…\Domain\ValueObject\NameLa règle des noms des vérifications et des tâches ; PATTERN, check()
…\Domain\ValueObject\CheckOutcomeUn état et un résumé d'une ligne ; up(), degraded(), down(), SUMMARY_LENGTH
…\Domain\ValueObject\CheckResultUne vérification telle qu'elle s'est exécutée : name, outcome, durationMilliseconds, status()
…\Domain\ValueObject\HealthReportUne ronde de vérifications : results, checkedAt, status()
…\Domain\ValueObject\ExpectedTaskUne tâche déclarée : name, periodSeconds, graceSeconds, dueBy(), stateAt()
…\Domain\ValueObject\HeartbeatStatusUne tâche dans son état actuel : task, state, lastBeatAt, dueBy, lateSince()
…\Domain\ValueObject\MaintenanceStatesince, retryAfterSeconds
…\Domain\Contract\HealthCheckUne vérification : name(), check()
…\Domain\Contract\HeartbeatStoreLe stockage des battements
…\Domain\Contract\MaintenanceStoreLe stockage du mode maintenance
…\Domain\Exception\MonitoringException, InvalidValueToute exception du bundle ; une valeur refusée
…\Application\Contract\MonitoringStatusLe modèle de lecture pour un autre bundle
…\Application\Contract\HeartbeatTaskUn message planifié qui émet le battement d'une tâche
…\Application\HealthCheckerExécute et chronomètre les vérifications : report()
…\Application\Heartbeatsbeat(), statuses()
…\Application\DeadManSwitchwatch() : les tâches signalées par une ronde ; LOCK_PREFIX, le préfixe du nom du verrou d'une tâche
…\Application\Maintenanceenable(), disable(), current()
…\Application\MonitoringL'implémentation de MonitoringStatus
…\Application\Message\WatchHeartbeatsLe message d'une ronde de l'interrupteur
…\Application\Check\HeartbeatsCheckLes tâches sous forme de vérification ; NAME
…\Application\Queue\Queuesoverview(), failureTransports(), isFailureTransport(), failed(), retry(), remove()
…\Application\Queue\QueueSummary, FailedMessageUn transport, un message en échec, tels que la page les montre
…\Infrastructure\Check\DatabaseCheck, CachePoolCheck, MessengerTransportCheck, FilesystemCheck, FlysystemCheckLes vérifications de la configuration
…\Infrastructure\Store\CacheHeartbeatStoreLes battements dans un pool PSR-6, sous KEY_PREFIX
…\Infrastructure\Store\FileMaintenanceStore, CacheMaintenanceStore, MaintenanceRecordLa maintenance sous forme de fichier indicateur ou de clé, et leur enregistrement commun
…\Infrastructure\Http\HealthControllerlive(), ready(), details() ; les noms des routes
…\Infrastructure\Http\MaintenanceListenerLe 503 du mode maintenance
…\Infrastructure\Http\QueuesControllerindex(), retry(), remove() ; les noms des routes et CSRF_TOKEN_ID
…\Infrastructure\Console\HealthCommand, HeartbeatCommand, WatchCommand, MaintenanceCommandLes commandes
…\Infrastructure\Scheduler\HeartbeatOnScheduledRunLe battement d'un message planifié
…\Infrastructure\Messenger\WatchHeartbeatsHandlerLe handler de WatchHeartbeats
…\Infrastructure\DependencyInjection\MonitoringServices, MonitoringPassLes services de la configuration ; les transports des files d'attente

Services et étiquette

IdentifiantEnregistré quandCe que c'est
Phil\MonitoringBundle\Application\Contract\MonitoringStatustoujoursLe modèle de lecture, public
…\Application\HealthChecker, Heartbeats, DeadManSwitch, MaintenancetoujoursLes services à injecter
…\Domain\Contract\HeartbeatStoretoujoursAlias de CacheHeartbeatStore, ou de heartbeats.store
…\Domain\Contract\MaintenanceStoretoujoursAlias du stockage que choisit maintenance.store
phil_monitoring.check.<name>une vérification est configuréeUne vérification de la configuration
…\Application\Check\HeartbeatsCheckune tâche est déclaréeLes tâches sous forme de vérification
…\Infrastructure\Http\MaintenanceListenertoujoursSur kernel.request, après le routeur et le pare-feu
…\Infrastructure\Scheduler\HeartbeatOnScheduledRunScheduler est installéSur PostRunEvent
…\Infrastructure\Messenger\WatchHeartbeatsHandlertoujoursTraite WatchHeartbeats
…\Application\Queue\Queuesqueues.enabled et un bus MessengerLes files d'attente
…\Infrastructure\Http\QueuesControllerles files d'attente, Twig, le routeur, le vérificateur d'autorisation et le gestionnaire de jetons CSRFLa page des files d'attente
étiquette phil_monitoring.health_checktoujoursLes vérifications ; donnée par autoconfiguration à chaque HealthCheck

Routes

NomFichierMéthode et chemin
phil_monitoring_liveconfig/routes/health.phpGET /live
phil_monitoring_readyconfig/routes/health.phpGET /ready
phil_monitoring_detailsconfig/routes/health.phpGET /details
phil_monitoring_queuesconfig/routes/queues.phpGET /
phil_monitoring_queues_retryconfig/routes/queues.phpPOST /{transport}/{id}/retry
phil_monitoring_queues_removeconfig/routes/queues.phpPOST /{transport}/{id}/remove

Commandes

CommandeCe qu'elle fait
phil:monitoring:healthExécute les vérifications ; échoue tant que l'une est hors service
phil:monitoring:heartbeat <task>Émet le battement d'une tâche ; échoue pour une tâche non déclarée
phil:monitoring:watchLance une ronde de l'interrupteur d'homme mort ; échoue tant qu'une tâche est en retard
phil:monitoring:maintenance [enable|disable|status] [--retry-after=N]Active, désactive ou affiche le mode maintenance

Gabarits

GabaritCe que c'est
@PhilMonitoring/maintenance.html.twigLa page de maintenance, autonome ; variable maintenance
@PhilMonitoring/queues.html.twigLa page des files d'attente ; étend layout
@PhilMonitoring/layout.html.twigUne mise en page simple avec les blocs title et content