Referencia de cron.xml para herramientas basadas en el SDK de App Engine

Usa el archivo cron.xml a fin de definir tareas programadas para tu aplicación.

Para obtener más información sobre cómo programar tareas y cómo probar, implementar o borrar trabajos cron, consulta Programa tareas con cron.

Ejemplo

A continuación, se muestra un ejemplo de un archivo cron.xml:

<?xml version="1.0" encoding="UTF-8"?>
<cronentries>
  <cron>
    <url>/recache</url>
    <description>Repopulate the cache every 2 minutes</description>
    <schedule>every 2 minutes</schedule>
  </cron>
  <cron>
    <url>/weeklyreport</url>
    <description>Mail out a weekly report</description>
    <schedule>every monday 08:30</schedule>
    <timezone>America/New_York</timezone>
  </cron>
  <cron>
    <url>/weeklyreport</url>
    <description>Mail out a weekly report</description>
    <schedule>every monday 08:30</schedule>
    <timezone>America/New_York</timezone>
    <target>version-2</target>
  </cron>
</cronentries>

En el caso de un XSD que describa el formato, verifica el archivo docs/cron.xsd en el SDK.

Sintaxis

El archivo cron.xml debe residir en el directorio WEB-INF junto con appengine-web.xml: cron.xml configura las tareas programadas para tu aplicación de Java 8.

Definiciones del trabajo cron

Elemento Descripción
<description> Opcional. La descripción está visible en GCP Console y en la interfaz de administrador del servidor de desarrollo.
<retry-parameters> Opcional. Si el controlador de solicitudes de un trabajo cron muestra un código de estado HTTP que no está entre 200 y 299 (inclusive), App Engine considera que el trabajo falló. Según la configuración predeterminada, no se reintentan los trabajos con errores. Para hacer que se vuelvan a procesar trabajos con errores, incluye un bloque de parámetros de reintento en tu archivo de configuración.

Consulta la sección Reintentos de cron para obtener más información.

<schedule> Obligatorio. Define el programa de cuándo deseas que se ejecute el trabajo cron; consulta la sintaxis a continuación.
<target>

La string target se agrega al nombre de host de tu app. Por lo general, es el nombre de un servicio. El trabajo cron se enruta a la versión del servicio asignado que se configura para tráfico.

Si no se encuentra el nombre del servicio especificado para target, la solicitud cron se enruta al servicio default o a la versión de la app configurada para recibir tráfico.Para obtener más información sobre el enrutamiento, consulta Cómo se enrutan las solicitudes.

<timezone> El elemento timezone debe ser el nombre de una zona horaria estándar (información de zona horaria). Si no especificas una zona horaria, los trabajos se ejecutarán en UTC (también conocido como GMT).
<url> Obligatorio. El campo <url> es solo una URL presente en tu aplicación. Si el elemento <url> contiene los caracteres especiales de XML &, <, >, ' o ", debes usarlos con escape.

Cómo definir el schedule del trabajo cron

Los trabajos cron se programan en intervalos periódicos y se especifican con un formato similar al del inglés. Puedes definir una programación de modo que tu trabajo se ejecute varias veces al día, o en días y meses específicos.

Intervalos menores que un día

Usa un intervalo menor que un día de duración para ejecutar un trabajo varias veces al día con una programación repetitiva. Puedes definir un intervalo según la hora de finalización o la hora de inicio:

  • Intervalo de hora de finalización: define el tiempo entre la “hora de finalización” de un trabajo y el momento en el que se inicia el siguiente; la “hora de finalización” se refiere al horario en el que se completa el trabajo o se agota el tiempo de espera. El servicio cron ejecuta trabajos en este tipo de intervalos durante las 24 horas del día, comienza a las 00:00 y espera durante el tiempo especificado entre cada trabajo.

    Ejemplo: Para la programación every 5 minutes, el trabajo se ejecuta a diario mediante un intervalo de 5 minutos. Si una instancia de un trabajo que se ejecuta según este programa se completa a las 2:01, el siguiente trabajo esperará 5 minutos y comenzará de nuevo a las 2:06.

  • Intervalo de hora de inicio: Define un intervalo regular para que el servicio cron inicie cada trabajo. A diferencia del intervalo de hora de finalización, el de hora de inicio ejecuta cada trabajo de forma independiente del momento en que finaliza o se agota el tiempo de espera. Puedes establecer un intervalo de tiempo dentro del cual deseas que se ejecute tu trabajo o ejecutar trabajos las 24 horas del día a partir de las 00:00.

    Dado que la hora de inicio de un trabajo es estricta, si la instancia de un trabajo se ejecuta por más tiempo que el definido en el intervalo, el servicio cron puede omitir el trabajo. Se puede omitir una hora de inicio individual en el intervalo si el trabajo anterior no se completó o si se agotó el tiempo de espera.

    Ejemplo: Para la programación every 5 minutes from 10:00 to 14:00, el primer trabajo se ejecuta a las 10:00, y luego, cada 5 minutos. Si ese primer trabajo se ejecuta durante 7 minutos, se omitirá el trabajo de las 10:05 y, por lo tanto, el servicio cron no ejecutará otra instancia de trabajo hasta las 10:10.

Intervalo personalizado

Puedes usar un intervalo personalizado para definir un programa en el que tu trabajo pueda ejecutarse una vez al día en uno o más días seleccionados, y en uno o más meses definidos. Los trabajos que se ejecutan con una programación personalizada lo hacen durante todo el año, solo durante un tiempo específico en los días y meses determinados.

Ejemplo: Para la programación 1,2,3 of month 07:00, el trabajo se ejecuta una vez a las 07:00 en los tres primeros días de cada mes.

Consideraciones importantes para schedule:

  • Debes decidir si deseas usar un intervalo menor de un día o un intervalo personalizado. No puedes combinar y usar elementos de los diferentes tipos de intervalos. A continuación, se presenta un ejemplo de una definición de programa no válida: <schedule>every 6 hours mon,wed,fri</schedule>.
  • Solo se debe ejecutar una instancia de trabajo a la vez. El servicio cron está diseñado para proporcionar una entrega “al menos una vez”. Esto significa que, si hay un trabajo programado, App Engine envía la solicitud de trabajo al menos una vez. En circunstancias excepcionales, es posible que se soliciten varias instancias de un mismo trabajo; por lo tanto, el controlador de las solicitudes deberá ser idempotente, y tu código deberá garantizar que no existan efectos secundarios perjudiciales en estos casos.

Define el formato de schedule

Para especificar cuándo se ejecuta el trabajo, debes definir el elemento schedule con la siguiente sintaxis:

<schedule>[TYPE] [INTERVAL_VALUE] [INTERVAL_SCOPE]</schedule>

Elige un tipo de intervalo para definir tu elemento schedule:

Intervalo de hora de finalización
  • [TYPE]: Los intervalos diarios deben incluir el prefijo every.

    Ejemplo: <schedule>every 12 hours</schedule>

  • [INTERVAL_VALUE]: un valor de número entero y la unidad de tiempo correspondiente. Los valores válidos para la unidad de tiempo son los siguientes:
    • minutes o mins
    • hours
  • [INTERVAL_SCOPE]: No aplicable. Para establecer una hora de inicio o un rango específicos dentro de los que desees que se ejecuten tus trabajos, consulta la sintaxis del Intervalo de hora de inicio o del Intervalo personalizado.
Ejemplos de intervalo de hora de finalización
Usa los siguientes ejemplos para entender cómo definir los programas de trabajos que usan un intervalo de hora de finalización:
  • Se ejecuta todos los días a las 00:00 y aguarda 5 minutos entre cada trabajo. Una vez que finaliza cada trabajo, el servicio cron espera 5 minutos antes de ejecutar el próximo:
    <schedule>every 5 minutes</schedule>
  • Se ejecuta todos los días a las 00:00 y aguarda 30 minutos entre cada trabajo. Una vez finalizado cada trabajo, el servicio Cron espera 30 minutos antes de ejecutar el próximo:
    <schedule>every 30 mins</schedule>
Intervalo de hora de inicio
  • [TYPE]: Los intervalos diarios deben incluir el prefijo every.

    Ejemplo: <schedule>every 12 hours</schedule>

  • [INTERVAL_VALUE]: un valor de número entero y la unidad de tiempo correspondiente. Los valores válidos para la unidad de tiempo son los siguientes:
    • minutes o mins
    • hours
  • [INTERVAL_SCOPE]: Especifica una cláusula que se corresponde con el [INTERVAL_VALUE]. Puedes definir un intervalo de tiempo personalizado o usar la opción synchronized de 24 horas.
    • Incluye la cláusula from [HH:MM] to [HH:MM] para definir una hora de inicio y un rango en el que desees que se ejecuten los trabajos.

      Debes especificar los valores de tiempo en el formato de 24 horas, HH:MM, en los que sucede lo siguiente:

      • HH son números enteros del 00 al 23.
      • MM son números enteros del 00 al 59.
    • Usa synchronized para especificar un intervalo de tiempo de 24 horas (from 00:00 to 23:59) que se divide de manera uniforme según el valor [INTERVAL_VALUE].

      Importante: El [INTERVAL_VALUE] debe dividir 24 en un número entero; de lo contrario, se producirá un error. Los valores válidos para [INTERVAL_VALUE] incluyen los siguientes: 1, 2, 3, 4, 6, 8, 12 o 24.

Ejemplos de intervalo de hora de inicio
Usa los siguientes ejemplos para entender cómo definir programas de trabajo que emplean un intervalo de hora de inicio:
  • Se ejecuta cada 5 minutos de 10:00 a 14:00, todos los días:
    <schedule>every 5 minutes from 10:00 to 14:00</schedule>
  • Se ejecuta una vez por hora de 08:00 a 16:00, todos los días:
    <schedule>every 1 hours from 08:00 to 16:00</schedule>
  • Se ejecuta una vez cada dos horas, todos los días, a partir de las 00:00:
    <schedule>every 2 hours synchronized</schedule>
Intervalo personalizado
  • [TYPE]: Los intervalos personalizados pueden incluir el prefijo every para definir un intervalo repetitivo, o puedes definir una lista específica de días y meses:
    • Para definir un intervalo repetitivo, puedes usar el prefijo every.

      Ejemplos:

      <schedule>every day 00:00</schedule>
      <schedule>every monday 09:00</schedule>

    • Para definir días específicos, debes usar números ordinales. Los valores válidos van desde el primer día de un mes hasta el máximo de días posibles en ese mes, por ejemplo:
      • 1st o first
      • 2nd o second
      • 3rd o third
      • Y hasta: 31st o thirtyfirst

      Ejemplo:

      <schedule>1st,3rd tuesday</schedule>
      <schedule>2nd,third wednesday of month 09:00</schedule>

  • [INTERVAL_VALUE]: Los intervalos personalizados incluyen una lista de los días específicos en los que deseas que se ejecute el trabajo. La lista se debe definir en una lista separada por comas y puede incluir cualquiera de los siguientes valores:
    • El valor del número entero desde el día del mes hasta un máximo de 31 días, por ejemplo:
      • 1
      • 2
      • 3
      • Y hasta: 31
    • El nombre del día en una combinación de cualquiera de los siguientes valores largos o abreviados:
      • monday o mon
      • tuesday o tue
      • wednesday o wed
      • thursday o thu
      • friday o fri
      • saturday o sat
      • sunday o sun
      • Usa day para especificar todos los días de la semana.

    Ejemplos:

    <schedule>2nd monday,thu</schedule>
    <schedule>1,8,15,22 of month 09:00</schedule>
    <schedule>1st mon,wednesday,thu of sep,oct,nov 17:00</schedule>

  • [INTERVAL_SCOPE]: Especifica una cláusula que se corresponda con el [INTERVAL_VALUE] especificado. Los intervalos personalizados pueden incluir la cláusula of [MONTH], que especifica un solo mes en un año, o una lista separada por comas de varios meses. También debes definir una hora específica en la que desees que se ejecute el trabajo, por ejemplo: of [MONTH] [HH:MM].

    Según la configuración predeterminada, si se excluye la cláusula of, el intervalo personalizado se ejecutará todos los meses.

    • [MONTH]: Debes especificar los meses en una lista separada por comas y puedes incluir una combinación de los siguientes valores largos o abreviados:
      • january o jan
      • february o feb
      • march o mar
      • april o apr
      • may
      • june o jun
      • july o jul
      • august o aug
      • september o sep
      • october o bien oct
      • november o nov
      • december o dec
      • Usa month para especificar todos los meses del año.
    • [HH:MM]: Debes especificar los valores horarios en el formato de 24 horas, HH:MM, en los que sucede lo siguiente:
      • HH son números enteros del 00 al 23.
      • MM son números enteros del 00 al 59.
    • Ejemplo:

      <schedule>1st monday of sep,oct,nov 09:00</schedule>
      <schedule>1 of jan,april,july,oct 00:00</schedule>

Ejemplos de intervalos personalizados
Usa los siguientes ejemplos para entender cómo definir los programas de trabajo que emplean un intervalo personalizado:
  • Se ejecuta todos los días a las 00:00:
    <schedule>every day 00:00</schedule>
  • Se ejecuta todos los lunes a las 09:00:
    <schedule>every monday 09:00</schedule>
  • Se ejecuta una vez el segundo miércoles de marzo a las 17:00:
    <schedule>2nd wednesday of march 17:00</schedule>
  • Se ejecuta seis veces en mayo. Durante las dos primeras semanas, se ejecuta una vez cada lunes, miércoles y viernes a las 10:00:
    <schedule>1st,second mon,wed,fri of may 10:00</schedule>
  • Se ejecuta una vez a la semana. Cada siete días, a partir del primer día de cada mes, se ejecuta una vez a las 09:00:
    <schedule>1,8,15,22 of month 09:00</schedule>
  • Se ejecuta cada dos semanas. En el primer y tercer lunes de cada mes, se ejecuta una vez a las 4:00:
    <schedule>1st,third monday of month 04:00</schedule>
  • Se ejecuta tres veces al año. En el primer lunes de septiembre, octubre y noviembre, se ejecuta una vez a las 9:00:
    <schedule>1st monday of sep,oct,nov 09:00</schedule>
  • Se ejecuta una vez cada trimestre. En el primer día de enero, abril, julio y octubre, se ejecuta una vez a las 00:00.
    <schedule>1 of jan,april,july,oct 00:00</schedule>

Reintentos de cron

Si el controlador de solicitudes de un trabajo cron muestra un código de estado que no está entre 200 y 299 (inclusive), App Engine considera que el trabajo falló. Según la configuración predeterminada, no se reintentan los trabajos con errores. Para hacer que se vuelvan a procesar los trabajos con errores, incluye un bloque <retry-parameters> en tu archivo de configuración.

Este es un archivo cron.xml de muestra que contiene un solo trabajo cron y está configurado para reintentarse hasta cinco veces (de manera predeterminada) con una retirada inicial de 2.5 segundos que se duplica cada vez.

<cronentries>
  <cron>
    <url>/retry</url>
    <description>Retry on jsdk</description>
    <schedule>every 10 minutes</schedule>
    <retry-parameters>
      <min-backoff-seconds>2.5</min-backoff-seconds>
      <max-doublings>5</max-doublings>
    </retry-parameters>
  </cron>
</cronentries>

Sintaxis de reintentos de Cron

Los parámetros de reintento se describen en la siguiente tabla.

Elemento Descripción
<job-retry-limit> La cantidad máxima de reintentos para un trabajo cron con errores no debe superar “5”. Si se especifica con <job-age-limit>, App Engine reintenta el trabajo cron hasta que se hayan alcanzado ambos límites. Cuando se omiten desde los parámetros, el límite se establece en “5” de forma predeterminada.
<job-age-limit> El límite de tiempo para reintentar un trabajo cron con errores medido desde la primera ejecución del trabajo. El valor es un número seguido de una unidad de tiempo, en el cual la unidad es s de segundos, m de minutos, h de horas o d de días. Por ejemplo, el valor 5d especifica un límite de cinco días después del primer intento de ejecución del trabajo cron. Si se especifica con <job-retry-limit>, App Engine reintenta el trabajo cron hasta que se hayan alcanzado ambos límites.
<min-backoff-seconds> La cantidad mínima de segundos que se espera antes de reintentar un trabajo cron después de la falla.
<max-backoff-seconds> La cantidad máxima de segundos que se espera antes de reintentar un trabajo cron después de la falla.
<max-doublings> La cantidad máxima de veces que se reintenta el intervalo entre un trabajo cron con errores se duplicará antes de que el aumento se vuelva constante. La constante es 2**(max_doublings - 1) * min_backoff.

Solicitudes de cron

Encabezados de solicitud

Las solicitudes del servicio cron contendrán un encabezado HTTP:

X-Appengine-Cron: true

Google App Engine configura de manera interna el encabezado X-Appengine-Cron. Si tu controlador de solicitudes encuentra este encabezado, puede confiar en que la solicitud es de un trabajo cron. Si el encabezado está presente en una solicitud de usuario externo a tu app, este se quitará. La excepción es para las solicitudes de los administradores que hayan accedido a la aplicación, ya que estos tienen permitido configurar el encabezado con fines de prueba.

Dirección IP de origen

Google App Engine genera solicitudes cron desde la dirección IP 0.1.0.1.

Plazos

El plazo de tiempo de espera de cron depende de la clase de instancia y del tipo de escalamiento que se configura para tu app:

Ajuste de escala automático
El tiempo de espera es de unos 10 minutos.
Ajuste de escala básico y manual
El tiempo de espera puede ser de hasta 24 horas.

Para obtener más información, consulta Tipos de escalamiento y clases de instancia.

Límites

Las aplicaciones gratuitas pueden tener hasta 20 tareas programadas. Las aplicaciones de pago pueden tener hasta 250 tareas programadas.

Asistencia de Cron en el servidor de desarrollo

El servidor de desarrollo no ejecuta tus trabajos cron de manera automática. Puedes usar tu cron de escritorio local o la interfaz de tareas programadas para activar las URL de tus trabajos con curl o una herramienta similar.

Cómo implementar trabajos cron

Puedes usar la herramienta appcfg.sh para implementar tus trabajos cron en App Engine.

Opción 1: subir toda la aplicación

Ejecuta el siguiente comando para subir toda la aplicación y actualizar el servicio Cron con las entradas del archivo cron.xml:

./appengine-java-sdk/bin/appcfg.sh -A your-app-id -V app-version update [YOUR_APP_DIR]
Opción 2: subir solo tus actualizaciones cron

Ejecuta el siguiente comando para actualizar solo la configuración cron sin subir el resto de la aplicación:

./appengine-java-sdk/bin/appcfg.sh -A your-app-id -V app-version update_cron [YOUR_APP_DIR]

Cómo borrar todos los trabajos cron

Sigue estos pasos para borrar todos los trabajos cron:

  1. Edita el contenido del archivo cron.xml en lo siguiente:

    <?xml version="1.0" encoding="UTF-8"?>
    <cronentries/>
    
  2. Implementa el archivo cron.xml en App Engine.

Asistencia de Cron en GCP Console

La página de lista de tareas en cola de GCP Console contiene una pestaña que muestra las tareas que están ejecutando trabajos cron.

También puedes visitar la página de registros para averiguar cuándo se agregaron o quitaron trabajos cron.

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Entorno estándar de App Engine para Java 8