Ya hemos visto anteriormente como funciona el sistema de tareas programadas de Magento2.
Ahora veremos como crear nuestros propias tareas cron (cron jobs) y como crear grupos de tareas para nuestros módulos.
En el caso de que nuestro módulo necesite la ejecución de una tarea programada periódicamente, tendremos que crear un crontab en nuestro módulo. Este crontab contendrá la configuración de las tareas.
Empezaremos creando el fichero crontab.xml en el directorio etc/ de nuestro módulo. La estructura del crontab es la siguiente:
|
1 2 3 4 5 6 7 |
<config> <group id="name"> <job name="name" instance="class" method="method"> <schedule><time></schedule> </job> </group> </config> |
Nuestro crontab se puede dividir en grupos y cada uno de ellos puede contener diferentes tareas. Veamos sus elementos y atributos:
- group id: Es el nombre de la tarea.
- job name: Identificador único de la tarea.
- job instance class: Es el Path donde será instanciada la clase y que ejecutará la tarea.
- job method: El método de la clase que será ejecutado.
- schedule time: Programación de la tarea en formato cron.
Un ejemplo real para poder probar nuestro crontab.xml prodría ser el siguiente:
|
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="UTF-8"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd"> <group id="default"> <job name="tarea1" instance="vendor\module\Cron\Log" method="execute"> <schedule>*/1 * * * *</schedule> </job> </group> </config> |
«Cada crontab puede contener varios grupos con una o más tareas».
Lo siguiente que tenemos que hacer es crear la clase que ejecutará nuestro crontab.xml. Para ello la crearemos en el directorio Cron/ de nuestro módulo.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
<?php namespace <vendor>\<module>\Cron; use \Psr\Log\LoggerInterface; class Log { protected $logger; public function __construct( LoggerInterface $logger ) { $this->_logger = $logger; } public function execute() { // system.log $this->_logger->info('Cron parece trabajar correctamente.'); } } |
Para probar si nuestra tarea funciona correctamente haremos un flush de nuestra cache y ejecutaremos el comando cron:run indicándole que el grupo al que pertenece de Magento es default.
|
1 2 |
php bin/magento cache:flush php bin/magento cron:run group="default" |
En caso de producirse un error al ejecutarse la tarea, Magento2 guardará el error que se produzca en el fichero exception.log en el directorio var/log/ y lo marcará como CRITICAL.
|
1 2 |
$ tail -f ./var/log/exception.log [2019-01-03 11:32:41] main.CRITICAL: Error when running a cron job {"exception":"[object] (RuntimeException(code: 0): ...... |
Si de lo contrario no se producen errores, los registros de la tarea son guardados en el fichero system.log en el directorio var/log/
|
1 2 3 4 |
$ tail -f ./var/log/system.log [2019-01-03 11:52:21] main.INFO: Cron Job tarea1 is run [] [] [2019-01-03 11:52:21] main.INFO: Cron parece trabajar correctamente. [] [] [2019-01-03 11:52:21] main.INFO: Cron Job tarea1 is successfully finished. Statistics: {"sum":0.0022339820861816,"count":1,"realmem":0,"emalloc":2416,"realmem_start":71303168,"emalloc_start":68788296} [] [] |
Recuerda que al pertenecer al grupo «default» se ejecutará junto a otras tareas default de Magento.
También podemos comprobar el estado actual de las tareas consultando la tabla cron_schedule que ya explicamos en nuestro post anterior.
|
1 2 3 |
$ mysql - u <userdb> -p mysql> use magento2-2.3.0; mysql> SELECT * from cron_schedule WHERE job_code like '%tarea1%' |
Opciones cron de grupo
Ya hemos visto que existen varios grupos cron en Magento2:
- default
- index
- customers
Opcionalmente podremos declarar un nuevo grupo y especificar sus opciones de configuración.
Para realizar esto debemos crear un fichero llamado cron_groups.xml en el directorio etc/ de nuestro módulo.
|
1 2 3 4 5 6 7 8 9 10 11 |
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd"> <group id="personal"> <schedule_generate_every>1</schedule_generate_every> <schedule_ahead_for>4</schedule_ahead_for> <schedule_lifetime>2</schedule_lifetime> <history_cleanup_every>10</history_cleanup_every> <history_success_lifetime>60</history_success_lifetime> <history_failure_lifetime>600</history_failure_lifetime> <use_separate_process>1</use_separate_process> </group> </config> |
Si vamos a nuestro gestor de Magento en Store > Configuration > System y desplegamos la pestaña Cron podremos ver que el nuevo grupo ha sido declarado.
Veamos con más detalle las opciones de configuración del nuevo grupo:
- schedule_generate_every: es la frecuencia (en minutos) que las tareas son escritas en la tabla cron_schedule de nuestra base de datos.
- schedule_ahead_for: Tiempo en minutos por adelantado en que una tarea es escrita en la base de datos.
- schedule_lifetime: El tiempo en minutos que tardará una tarea es ser considerada como fallida.
- history_cleanup_every: El tiempo en minutos que permanecerá la tarea en la base de datos.
- history_success_lifetime: Tiempo en minutos que una tarea completada con éxisto será mantenida en la base de datos.
- history_failure_lifetime: Tiempo en minutos que una tarea fallida será mantenida en la base de datos.
- use_separate_process: Ejecutar las tareas de este grupo por procesos separados de php.
Para ejecutar todas las tareas cron que pertenezcan a este grupo usaremos el mismo comando que hemos visto anteriormente pero indicándole el nuevo grupo que hemos creado:
|
1 |
$ php ./bin/magento cron:run --group="personal" |
Conclusiones
Las tareas programadas nos ahorraran mucho tiempo realizando tareas específicas, por lo que espero haber ayudado a entender como se realizan dichas tareas en Magento2.
