Events

MoonGuard uses and registers multiple events to execute actions through listeners. We have created a series of events related to Uptime checks, SSL Certificate checks, Exceptions, and Server Monitoring:

UptimeCheckFailedEvent

When a site's Uptime Check fails this event is triggered. This commonly happens when the site is unreachable, MoonGuard utilizes a listener (UptimeCheckFailedListener) that listen for this event to send out a notification (UptimeCheckFailedNotification) to all users, notifying them of the failure.

UptimeCheckRecoveredEvent

This event is triggered when the Uptime Check for a site recovers. If a site was down before and is now available again, this event will be sent out. MoonGuard uses a UptimeCheckRecoveredListener to send a UptimeCheckRecoveredNotification to all users.

RequestTookLongerThanMaxDurationEvent

This event is triggered when a request takes longer than the maximum allotted time. MoonGuard utilizes a listener (RequestTookLongerThanMaxDurationListener) to listen for this event and sends out a notification (RequestTookLongerThanMaxDurationNotification) to all users, notifying them of the issue.

SslCertificateExpiresSoonEvent

This event is triggered when an SSL certificate is close to expiring. MoonGuard utilizes a listener (SslCertificateExpiresSoonListener) to listen for this event and sends out a notification (SslCertificateExpiresSoonNotification) to all users, notifying them of the issue.

SslCertificateCheckFailedEvent

This event is triggered when an SSL certificate check fails. This may happen if the SSL certificate check is not valid. MoonGuard utilizes a listener (SslCertificateCheckFailedListener) to listen for this event and sends out a notification (SslCertificateCheckFailedNotification) to all users, notifying them of the issue.

ExceptionLogGroupCreatedEvent

This event is triggered when a new exception log group is created. MoonGuard utilizes a listener (ExceptionLogGroupCreatedListener) to listen for this event and sends out a notification (ExceptionLogGroupNotification) to all users, notifying them of the creation.

ExceptionLogGroupUpdatedEvent

This event is triggered when an existing exception log group is modified. This is useful when multiple repeated exceptions are received in a single batch. MoonGuard utilizes a listener (ExceptionLogGroupUpdatedListener) to listen for this event and sends out a notification (ExceptionLogGroupNotification) to all users, notifying them of the update.

ServerMetricAlertEvent

This event is triggered when the CPU load, memory, or disk space exceeds the limit set in the site configuration, any threshold exceeded will trigger alert notifications. MoonGuard utilizes the listener (ServerMetricAlertListener) to listen for this event and sends out notification the (ServerMetricNotification) to all users.

In case you want to customize the behavior of this event listeners, they can be replaced by your own listeners in the MoonGuard configuration file:

<?php

[
  //...
    'events' => [
        /*
         * The events that can be listened for.
         * You can add your own listeners here.
         */
        'listen' => [
            \Taecontrol\MoonGuard\Events\UptimeCheckRecoveredEvent::class => [
                \Taecontrol\MoonGuard\Listeners\UptimeCheckRecoveredListener::class,
            ],
            \Taecontrol\MoonGuard\Events\UptimeCheckFailedEvent::class => [
                \Taecontrol\MoonGuard\Listeners\UptimeCheckFailedListener::class,
            ],
            \Taecontrol\MoonGuard\Events\RequestTookLongerThanMaxDurationEvent::class => [
                \Taecontrol\MoonGuard\Listeners\RequestTookLongerThanMaxDurationListener::class,
            ],
            \Taecontrol\MoonGuard\Events\SslCertificateExpiresSoonEvent::class => [
                \Taecontrol\MoonGuard\Listeners\SslCertificateExpiresSoonListener::class,
            ],
            \Taecontrol\MoonGuard\Events\SslCertificateCheckFailedEvent::class => [
                \Taecontrol\MoonGuard\Listeners\SslCertificateCheckFailedListener::class,
            ],
            \Taecontrol\MoonGuard\Events\ExceptionLogGroupCreatedEvent::class => [
                \Taecontrol\MoonGuard\Listeners\ExceptionLogGroupCreatedListener::class,
            ],
            \Taecontrol\MoonGuard\Events\ExceptionLogGroupUpdatedEvent::class => [
                \Taecontrol\MoonGuard\Listeners\ExceptionLogGroupUpdatedListener::class,
            ],
            \Taecontrol\MoonGuard\Events\ServerMetricAlertEvent::class => [
                \Taecontrol\MoonGuard\Listeners\ServerMetricAlertListener::class,
            ],
        ],
    ],
    //...
];