feat(cron): added custom cron logger class

The provided logger will allow developers to log to the cron log directly, so it's easier to debug issue or long-running tasks.
jeabakker · Aug 4, 2023 · 4e485ce · 4e485ce
1 parent b6f2565
commit 4e485ce
Show file tree

Hide file tree

Showing 7 changed files with 392 additions and 192 deletions.
diff --git a/docs/guides/events-list.rst b/docs/guides/events-list.rst
@@ -41,6 +41,12 @@ System events
 **cron, <period>** |results|
 	Triggered by cron for each period.
 
+	The ``$params`` array will contain:
+
+	 * ``time`` - the timestamp of when the cron command was started
+	 * ``dt`` - the ``\DateTime`` object of when the cron command was started
+	 * ``logger`` - instance of ``\Elgg\Logger\Cron`` to log any information to the cron log
+
 **cron:intervals, system** |results|
 	Allow the configuration of custom cron intervals