oat-sa/extension-tao-system-status

TAO system status


README

extension-tao-system-status

Extension supposed to be used to monitor the status of some services and the correct configuration of the TAO.

Installation

Requires the following CRON job on ALL instances (web and workers):

*/5 * * * * root cd /var/www/html/tao && /usr/bin/flock -n /var/lock/tao-InstanceCheck.lock -c "sudo -u www-data nohup /usr/bin/php index.php 'oat\taoSystemStatus\scripts\tools\RunInstanceCheck' 2>&1 >>/var/log/tao/InstanceCheck.log &"

NOTE: For AWS environemnts make sure that both Web Server Role and Worker Server Role have rights to perform:

  • elasticache:DescribeCacheClusters
  • rds:DescribeDBInstances
  • cloudwatch:GetMetricData

Link to the help desk:

Configure \oat\taoSystemStatus\model\SystemStatus\SystemStatusService::OPTION_SUPPORT_PORTAL_LINK of SystemStatusService service with appropriate url to show the link to the Help Desk portal on the Tao's system status page

Sending alerts:

For sending alerts to any additional services the AlarmNotificationService should be configured For example sending alerts to OpsGenie config/tao/AlarmNotificationService.conf.php:

<?php
/**
 * Default config header created during install
 */

return new oat\tao\model\notifications\AlarmNotificationService([
    'notifiers' => [
        [
            'class' => '\\oat\\tao\\model\\notifiers\\OpsGenieNotifier',
            'params' => ['api-key']
        ]
    ],
    'dispatchTypes' => [
        \oat\oatbox\reporting\Report::TYPE_ERROR //type of reports for sending 
    ]
]);