Merge pull request #21762 from jitendrapurohit/job-alert

Add system status warning to display scheduled job failures
civicrm · Dec 16, 2021 · f0b7645 · f0b7645
2 parents 2a7d161 + 62f17a5
commit f0b7645
Showing 1 changed file with 48 additions and 0 deletions.
diff --git a/CRM/Utils/Check/Component/Env.php b/CRM/Utils/Check/Component/Env.php
@@ -689,6 +689,54 @@ public function checkExtensions() {
     return $messages;
   }
 
+  /**
+   * @return CRM_Utils_Check_Message[]
+   */
+  public function checkScheduledJobLogErrors() {
+    $jobs = civicrm_api3('Job', 'get', [
+      'sequential' => 1,
+      'return' => ["id", "name", "last_run"],
+      'is_active' => 1,
+      'options' => ['limit' => 0],
+    ]);
+    $html = '';
+    foreach ($jobs['values'] as $job) {
+      $lastExecutionMessage = civicrm_api3('JobLog', 'get', [
+        'sequential' => 1,
+        'return' => ["description"],
+        'job_id' => $job['id'],
+        'options' => ['sort' => "id desc", 'limit' => 1],
+      ])['values'][0]['description'] ?? NULL;
+      if (!empty($lastExecutionMessage) && strpos($lastExecutionMessage, 'Failure') !== FALSE) {
+        $viewLogURL = CRM_Utils_System::url('civicrm/admin/joblog', "jid={$job['id']}&reset=1");
+        $html .= '<tr>
+          <td>' . $job['name'] . ' </td>
+          <td>' . $lastExecutionMessage . '</td>
+          <td>' . $job['last_run'] . '</td>
+          <td><a href="' . $viewLogURL . '">' . ts('View Job Log') . '</a></td>
+        </tr>';
+      }
+    }
+    if (empty($html)) {
+      return [];
+    }
+
+    $message = '<p>' . ts('The following scheduled jobs failed on the last run:') . '</p>
+      <p><table><thead><tr><th>' . ts('Job') . '</th><th>' . ts('Message') . '</th><th>' . ts('Last Run') . '</th><th></th>
+      </tr></thead><tbody>' . $html . '
+      </tbody></table></p>';
+
+    $msg = new CRM_Utils_Check_Message(
+      __FUNCTION__,
+      $message,
+      ts('Scheduled Job Failures'),
+      \Psr\Log\LogLevel::WARNING,
+      'fa-server'
+    );
+    $messages[] = $msg;
+    return $messages;
+  }
+
   /**
    * Checks if there are pending extension upgrades.
    *