Cron-Job
Der Cron-Prozess von Moodle ist ein PHP-Skript, das zum Moodle-Standardpaket gehört, und das regelmäßig im Hintergrund ausgeführt werden muss. Das Moodle-Cron-Skript führt in verschiedenen Zeitabständen verschiedene Aufgaben aus.
Wichtig: Sie müssen den Cron-Prozess unbedingt aufsetzen, andernfalls funktioniert Ihre Moodle-Site nicht richtig.
Es wird empfohlen, den Cron-Job jede Minute laufen zu lassen, wie es für das asynchrone Löschen von Aktivitäten bei Verwendung des Papierkorbs erforderlich ist.
Das Cron-Programm (welches das Moodle-Cron-Skript ausführt) ist Kernbestandteil jedes UNIX-basierten Systems (inkl. Linux und OSX). Es wird verwendet, um alle Arten von zeitabhängigen Diensten laufen zu lassen. Unter Windows ist die einfachste Lösung das Anlegen eines Tasks im Windows Task Scheduler, das in regelmäßigen Zeitabständen ausgeführt wird.
Einen Cron-Job einrichten bedeutet im Wesentlichen, eine Zeile in die Liste der Cron-Prozesse auf Ihrem Server einzutragen. Auf Unix-basierten Systemen ist diese Liste eine Datei crontab, die alle Nutzer/innen des Servers haben.
Allgemeines
Dieser Abschnitt gibt einige allgemeine Hintergrundinformationen. Serverabhängige Informationen finden Sie weiter unten.
Das Aufsetzen eines Cron-Prozesses erfordert zwei Schritte:
- Das richtige Kommando identifizieren, das ausgeführt werden muss.
- Die richtige Stelle auf Ihrem Server finden, an der das Kommando eingetragen werden muss.
Das richtige Kommando identifizieren
In Moodle gibt es zwei Möglichkeiten, das Cron-Skript auszuführen:
- CLI-Skript (CLI = command line interpreter, Kommandozeileninterpreter): Der Pfad zu diesem Skript ist <moodle_installationsverzeichnis>/admin/cli/cron.php. Dieses Skript muss von einem PHP CLI Programm auf Ihrem Server ausgeführt werden, z.B. durch folgendes Kommando:
/usr/bin/php <moodle_installationsverzeichnis>/admin/cli/cron.php
Sie können (und sollten) diesen Befehl von Kommandozeile aus testen, um zu sehen, ob er funktioniert. Hinweis: Prüfen Sie, ob Ihre Kommandozeilen-PHP-Version kompatibel mit Ihrer Moodle-Version ist. Das Kommandozeilen-PHP-Programm ist nicht dasselbe PHP-Programm, das Ihre Website nutzt und beide PHP-Programme haben nicht immer dieselbe Version.
- Wenn Sie aus irgendeinem Grund nicht das CLI-Skript verwenden können, dann gibt es als Alternative ein webbasiertes Skript. Dieses Skript ist allerdings als "veraltet/deprecated" markiert und kann in zukünftigen Moodle-Versionen gelöscht sein. Dieses Skript muss im Webbrowser aufgerufen werden, der Zugriff erfolgt über die URL <code>http://Ihre.Moodle.Site/admin/cron.php</code>. Sie können einen kommandozeilen-basierten Webbrowser verwenden (z.B.
wget), d.h. das Kommando könnte z.B. lauten:
/usr/bin/wget http://Ihre.Moodle.Site/admin/cron.php
Der Vorteil dieses Kommandos besteht darin, dass es von überall ausgeführt werden kann, also nicht notwendigerweise von Ihrem Moodle-Server aus (auf den Sie evtl. gar keinen Zugriff haben), sondern von irgend einem Server aus, auf den Sie zugreifen dürfen.
Das webbasierte Moodle-Cron-Skript
- Wenn Sie die Wahl haben, verwenden Sie NICHT das webbasierte Skript. Es wird wahrscheinlich in zukünftigen Moodle-Version nicht mehr mit ausgeliefert.
- Ab Moodle 2.9 kann der Cron-Job standardmäßig nicht mehr über den Browser gestartet werden. Wenn Sie es doch versuchen, erhalten Sie eine Fehlermeldung:
Der Internetzugriff für diese Seite wurde deaktiviert. bzw. !!! Sorry, internet access to this page has been disabled by the administrator. !!!
- Sie können diese Einstellung auf der Seite Website-Administration (oder im Block Einstellungen > Website-Administration) > Sicherheit > Sicherheitsregeln der Website ändern, indem Sie das Häkchen bei Cron nur über die Befehlszeile ausführen entfernen.
- Warnung: Das Ausführen des Cron-Skripts über den Browser kann sensible Daten für Unbefugte anzeigen. Deshalb wird empfohlen, nur das CLI-Cron-Skript oder das webbasierte Cron-Skript mit Passwortschutz zu verwenden.
- Das Passwort können Sie auf derselben Seite in der Einstellung Kennwort für cron eintragen. Wenn Sie das Feld leer lassen, dann läuft das webbasierte Cron-Skript ohne Passwortschutz.
- Der Aufruf des webbasierten Cron-Skripts mit Passwortschutz lautet:
http://Ihre.Moodle.Site/admin/cron.php?password=IhrPasswort
Den richtigen Platz auf dem Server finden
Dieser Platz hängt ganz wesentlich von Ihrem System ab. Lesen Sie die Dokumentation für Ihre Plattform oder von Ihrem Hosting-Provider. In den meisten Fällen müssen Sie das richtige Kommando (siehe vorheriger Abschnitt) in eine Datei eintragen - entweder über eine ggeignete Benutzerschnittstelle oder durch direktes Editieren dieser Datei.
Wenn Sie das CLI-Skript verwenden, dann müssen Sie außerdem sicherstellen, dass es vom richtigen Nutzer (des Servers) ausgeführt wird. Diese Einschränkung gilt nicht, wenn Sie das webbasierte Skript verwenden.
Beispiel: Einrichten des Cron-Prozesses unter Ubuntu/Debian Linux, angemeldet als Nutzer root:
- Verwende das crontab-Kommando, um den Crontab-Editor für den Nutzer
www-datazu öffnen (das ist der Apache Webservernutzer auf Debian-basierten Systemen):
$ crontab -u www-data -e
- Ergänzen Sie im Crontab-Editor folgende Zeile, um das CLI-Skript jede Minute auszuführen:
* * * * * /usr/bin/php /path/to/moodle/admin/cli/cron.php >/dev/null
- Hinweis: Der Eintrag
>/dev/nullam Ende der Zeile sendet alle Ausgaben des Skripts an "bin" und und verhindert, dass Sie jede Minute eine E-Mail erhalten.
Den Cron-Job auf Ihrem System einrichten
Wählen Sie die passende Information für Ihren Server (englisch):
- Cron unter Unix/Linux
- Cron unter Windows
- Cron unter Mac OS X
- Cron unter Webhosting
- Cron unter 1and1 Server
Cron-Dienste von Drittanbietern
Neben der Verwendung von cron auf Ihrem eigenen Server gehostet wird, können Sie Cron-Dienste (in der Regel als Webcron) von Drittanbieterbn nutzen:
- cron-job.org ist ein kostenloser Service mit deutscher Webseite, der auch minütlich funktioniert.
- EasyCron ist ein Webcron Dienstleister, der die Notwendigkeit von crontab oder andere Aufgabenplaner, um cron-Job eingestellt beseitigt.
- WebCron ist ein freier und einfacher Webcron-Service-Provider.
Cron-Einstellungen in Moodle
Die Moodle-Administration kann auf der Seite Website-Adminidtration > Allgemein > Sicherheit > Sicherheitseinstellungen die Cron-Ausführung ausschließlich über die Befehlszeile oder über ein Cron-Passwort für den Fernzugriff festlegen.
Remote-Cron
Bei Verwendung der webbasierten Version von Cron ist es völlig in Ordnung, den Cron-Prozess auf einem anderen Rechner als dem Moodle-Server auszuführen. So kann beispielsweise der Cron-Dienst auf einem Unix-Server die Cron-Webseite auf einem Windows-basierten Moodle-Server aufrufen.
Cron-Einstellungen in Moodle
Als Administrator/in können Sie auf der Seite Website-Administration (oder im Block Einstellungen > Website-Administration) > Sicherheit > Sicherheitsregeln der Website verschiedene Einstellungen für den Cron-Prozess vornehmen.
Planung der einzelnen Cron-Jobs
Als Administrator/in können Sie auf den Seiten unter Website-Administration > Server > Tasks die Ausführung der einzelnen Cron-Jobs detailliert festlegen, siehe Tasks.
Cron-Jobs für verschiedene Moodle-Server laufen lassen
- Die Cron-Jobs können parallel laufen. Die Prozesse verwenden "Locking". Auf diese Weise können mehrere Webserver den Cron-Job für ein und dieselbe Moodle-Instanz anstoßen.
- Wenn Sie verschiedene Moodle-Instanzen auf ein und demselben Server betreiben, dann muss für jede Instanz ein Cron-Job eingerichtet werden. Es kann sogar ein einzelner Webserver verschiedene Moodle-Instanzen in verschiedenen Domänen betreiben (über virtuelle Maschinen, siehe https://httpd.apache.org/docs/2.2/vhosts/index.html)
Protokollierung und Überwachung
Idealerweise sollten Sie die Ausgabe von cron auch irgendwo protokollieren und auf Probleme überwachen. Sie können den Gesamtstatus von cron überprüfen, um sicherzustellen, dass keine Fehler vorliegen, indem Sie die Seite Website-Administration > Berichte > Berichte > Systemstatus aufrufen.
Sie können diesen Statusbericht auch über die Check-API (https://docs.moodle.org/dev/Check_API), CLI-Befehle oder mithilfe von Plugins wie https://github.com/catalyst/moodle-tool_heartbeat mit Tools wie Icinga oder Nagios verknüpfen.
/admin/cli/checks.php
Sollten Fehler auftreten, können Sie weitere Details zu kürzlich ausgeführten Tasks auf der Seite Website-Administration > Server > Tasks > Geplante Tasks in der Spalte Logdaten einsehen; hier werden jedoch keine Fehler bei Ad-hoc-Tasks angezeigt.
Um Fehler bei Ad-hoc-Tasks zu sehen, müssen Sie den Task entweder selbst manuell erneut ausführen und die Fehler einsehen oder Sie müssen die Logdaten bereits zur Überprüfung gesammelt haben. Bei einem Moodle, das auf einem einzelnen Rechner läuft, könnten Sie die Logdaten in einer einfachen Protokolldatei speichern, bei einem Cluster sollten Sie vielleicht syslogd oder ein ähnliches Programm verwenden, z.B.
* * * * * /usr/bin/php /path/to/moodle/admin/cli/cron.php 2>&1 | /usr/bin/logger ...
Ad-hoc-Tasks mit geringer Latenz
Bei jeder Ausführung von cron werden nach den geplanten Tasks auch die Ad-hoc-Tasks ausgeführt. Während geplante Tasks höchstens einmal pro Minute ausgeführt werden können, können Ad-hoc-Tasks jederzeit in die Warteschlange gestellt werden. In der Regel soll die Verarbeitung dieser Tasks so schnell wie möglich erfolgen, ohne dass zunächst die Ausführung der geplanten Tasks abgewartet werden muss. Wenn Sie lediglich die normale Datei admin/cli/cron.php ausführen, muss diese möglicherweise nicht nur warten, bis alle geplanten Aufgaben abgearbeitet sind, sondern Sie müssen auch die nächste Minute abwarten, bis cron wieder startet, damit die Verarbeitung erfolgen kann.
Stattdessen können Sie einen oder mehrere dedizierte Ad-hoc-Taskprozessoren ausführen, die parallel zum Haupt-Cron-Prozess laufen.
* * * * * /usr/bin/php /path/to/moodle/admin/cli/adhoc_task.php --execute --keep-alive=59 * * * * * /usr/bin/php /path/to/moodle/admin/cli/adhoc_task.php --execute --keep-alive=59 ...
Die Option keep-alive läuft als Daemon. Wenn die Warteschlange leer ist, wird das Programm nicht beendet, sondern wartet auf neue Tasks, die in die Warteschlange gestellt werden, damit es so schnell wie möglich mit der Verarbeitung beginnen kann.
Skalierung von Cron mit mehreren Prozessen
Wenn Ihre Moodle-System wächst, dauert die Ausführung vieler geplanter Tasks länger, und es stehen zudem mehr Ad-hoc-Tasks in der Warteschlange, die bearbeitet werden müssen. Das Cron-System ist für den parallelen Betrieb ausgelegt, doch da jeder einzelne Prozess jeweils nur einen Task bearbeiten kann, müssen Sie mehrere Cron-CLIs ausführen. In der Regel können Sie eine recht hohe Anzahl von Cron-Prozessen auf einer dedizierten Cron-Instanz ausführen, bevor Sie mehrere Cron-Instanzen betreiben müssen. Um mehr als einen Prozess auszuführen, starten Sie einfach jede Minute mehrere Cron-Prozesse:
* * * * * /usr/bin/php /path/to/moodle/admin/cli/cron.php * * * * * /usr/bin/php /path/to/moodle/admin/cli/cron.php * * * * * /usr/bin/php /path/to/moodle/admin/cli/cron.php ⋮ * * * * * /usr/bin/php /path/to/moodle/admin/cli/adhoc_task.php --execute --keep-alive=59 * * * * * /usr/bin/php /path/to/moodle/admin/cli/adhoc_task.php --execute --keep-alive=59 * * * * * /usr/bin/php /path/to/moodle/admin/cli/adhoc_task.php --execute --keep-alive=59 ⋮
Es kann besonders wichtig sein, die Anzahl der adhoc_task.php-Prozesse zu erhöhen, da bestimmte Plugins und Systeme sehr viele Ad-hoc-Tasks generieren können oder Tasks, deren Verarbeitung viel Zeit in Anspruch nimmt. Insbesondere Tasks wie Dokumentkonvertierungen und automatisierte Backups können sich schneller ansammeln, als sie verarbeitet werden, wenn die Standardeinstellungen beibehalten werden.
Standardmäßig können nur drei geplante Tasks und drei Ad-hoc-Tasks gleichzeitig ausgeführt werden. Wenn Sie also weitere Prozesse hinzufügen, müssen Sie auf der Seite Website-Administration > Server > Tasks > Taskverarbeitung den Grad der zulässigen Parallelität zu erhöhen.
Alternativ können Sie auch eine entsprechende Einstellung in der Moodle-Konfigurationsdatei config.php vornehmen:
$CFG->task_scheduled_concurrency_limit = 20; // Defaults to 3
$CFG->task_adhoc_concurrency_limit = 50; // Defaults to 3
Unabhängig davon, welche Werte Sie hier festlegen, stellen Sie sicher, dass der Server, auf dem diese Dienste gehostet werden, diese Anzahl an Prozessen problemlos bewältigen kann. Oftmals liegt der Engpass bei einem gemeinsam genutzten Dienst, in der Regel bei der Datenbank.
Möglicherweise stellen Sie fest, dass bestimmte Arten von sehr lang andauernden Tasks alle verfügbaren Task-Prozesse beanspruchen, was bedeutet, dass keine anderen Tasks mehr ausgeführt werden können. Wenn Sie beispielsweise über fünf CLI-Prozesse verfügen, in der Task-Warteschlange jedoch 20 Ad-hoc-Tasks für eine automatisierte Datensicherung vorliegen, deren Ausführung jeweils zehn Minuten dauert, werden sehr schnell alle fünf Prozesse von den Datensicherungen beansprucht, sodass keine anderen Tasks mehr ausgeführt werden können. Andere kleine, sehr schnelle und ressourcenschonende Tasks wie die Konvertierung von Dokumenten oder E-Mails aus Foren werden erst versendet, wenn die Backups abgeschlossen sind und ein Prozess frei wird. Um dies zu steuern, können Sie die Parallelität bestimmter Arten von Ad-hoc-Tasks begrenzen. Eine gute Faustregel lautet: Wenn alle ressourcenintensiven Tasks ihre jeweiligen Limits vollständig ausschöpfen, sollten dennoch noch einige Prozesse im Leerlauf bereitstehen, die auf weitere Tasks warten, die der Warteschlange hinzugefügt werden könnten.
Automatisierte Backups sind die größten bekannten Ressourcenfresser. Wenn Sie also hypothetisch 50 Ad-hoc-Task-Prozesse gleichzeitig ausführen, könnte eine sinnvolle Beschränkung darin bestehen, die Backups so zu begrenzen, dass sie nicht mehr als die Hälfte dieser Prozesse beanspruchen, d.h. höchstens 25. Die entsprechende Einstellung in der Moodle-Konfigurationsdatei config.php lautet:
$CFG->task_concurrency_limit = [
'core\task\course_backup_task' => 25,
'core_course\task\course_delete_modules' => 5,
];
Siehe auch
Diskussionsbeiträge im Kurs Using Moodle auf moodle.org:
