Cómo escribir registros de tareas

En este documento, se describe cómo escribir registros de tareas y cómo crear y ejecutar un trabajo por lotes que tenga registros de tareas.

Cuando se habilita el registro para un trabajo, los registros de tareas se generan a partir de los mensajes que imprimen los elementos ejecutables del trabajo durante el tiempo de ejecución. Si configuras tus elementos ejecutables para escribir registros de tareas, puedes mostrar información personalizada en Cloud Logging, lo que puede facilitar el análisis y la solución de problemas de tus trabajos. Para obtener más información sobre los registros, consulta Cómo analizar un trabajo con registros.

Antes de comenzar

  1. Si nunca antes usaste Batch, consulta Cómo comenzar a usar Batch y habilita Batch completando los requisitos previos para proyectos y usuarios.

  2. Para obtener los permisos que necesitas para crear un trabajo que escriba registros, pídele a tu administrador que te otorgue los siguientes roles de IAM:

    Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

    También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

Crea y ejecuta un trabajo que tenga registros de tareas

Para crear y ejecutar un trabajo que deseas que tenga registros de tareas, haz lo siguiente cuando crees el trabajo:

  1. Habilita los registros para la tarea. Esto permite que se generen todos los registros escritos para la tarea.

  2. Para cada registro de tareas que quieras que tenga el trabajo, agrega un comando que escriba un registro de tareas en un elemento ejecutable. Cuando se ejecuta el trabajo, se genera un registro de tareas cada vez que se ejecuta un comando para escribir un registro de tareas.

    Para aprender a escribir registros de tareas, consulta Cómo escribir registros de tareas en este documento.

Cómo escribir registros de tareas

Se escribe un registro de tareas para cualquier contenido que los elementos ejecutables de un trabajo impriman en la transmisión de salida estándar (stdout) o de error estándar (stderr) durante el tiempo de ejecución. Por ejemplo, puedes escribir registros de tareas con el comando echo. La estructura del registro de tareas resultante varía según el formato que le hayas asignado al contenido impreso. Específicamente, puedes escribir cada registro de tareas con una de las siguientes opciones:

Imprime una cadena para escribir un registro no estructurado

Los registros no estructurados te permiten definir un mensaje, que es una cadena que aparece en el campo textPayload del registro.

Para escribir un registro sin estructura, imprime una cadena sin formato, como se muestra en las siguientes secciones.

Ejemplo de registro no estructurado

Por ejemplo, supongamos que deseas un registro de tareas que contenga la siguiente cadena:

MESSAGE

Si imprimes esta cadena de ejemplo, se generará un registro de tareas similar al siguiente:

insertId: ...
labels: ...
logName: projects/PROJECT_ID/logs/batch_task_logs
receiveTimestamp: ...
resource: ...
severity: INFO
textPayload: MESSAGE
timestamp: ...

Reemplaza lo siguiente:

  • MESSAGE: Es el mensaje, que es una cadena que resume el propósito del registro de tareas, por ejemplo, The summary for a task log..
  • PROJECT_ID: Es el ID del proyecto de tu proyecto.

Puedes imprimir una cadena con una variedad de métodos, como incluir el siguiente comando echo en un elemento ejecutable:

echo MESSAGE

Para ver ejemplos completos de trabajos que usan el comando echo para escribir registros de tareas no estructurados, consulta Cómo crear y ejecutar un trabajo básico.

Imprime un objeto JSON para escribir un registro estructurado

Los registros estructurados te permiten definir cualquiera de los siguientes elementos:

Para escribir un registro estructurado, imprime un objeto JSON. En las siguientes secciones, se muestra cómo definir un registro con algunos de los campos estándar y personalizados. Si deseas obtener información para definir un registro con eventos de estado personalizados, consulta Cómo configurar eventos de estado personalizados.

Ejemplo de registro estructurado

Por ejemplo, supongamos que deseas un registro de tareas que contenga la información del siguiente objeto JSON, que define un mensaje, una gravedad y dos campos personalizados.

{
  "message": "MESSAGE"
  "severity": "SEVERITY"
  "CUSTOM_FIELD_1": CUSTOM_VALUE_1
  "CUSTOM_FIELD_2": CUSTOM_VALUE_2
}

Si imprimes este objeto JSON, se generará un registro de tareas similar al siguiente:

insertId: ...
jsonPayload:
  "CUSTOM_FIELD_1": CUSTOM_VALUE_1
  "CUSTOM_FIELD_2": CUSTOM_VALUE_2
  message: MESSAGE
labels: ...
logName: projects/PROJECT_ID/logs/batch_task_logs
receiveTimestamp: ...
resource: ...
severity: SEVERITY
timestamp: ...

Reemplaza lo siguiente:

  • MESSAGE: Es el mensaje, que es una cadena que resume el propósito del registro de tareas, por ejemplo, The summary for a task log..
  • SEVERITY: Es la gravedad del registro, que puedes usar como filtro cuando ves los registros de un trabajo. La gravedad debe ser una de las enums LogSeverity convertidas en una cadena con solo la primera letra en mayúscula. Por ejemplo, para la enumeración ERROR, especifica Error.
  • CUSTOM_FIELD_1 y CUSTOM_FIELD_2: Son los nombres de los campos personalizados para el registro de tareas, por ejemplo, custom_field_1 y custom_field_2.
  • CUSTOM_VALUE_1 y CUSTOM_VALUE_2: Son los valores de los campos personalizados para el registro de tareas, que pueden ser varios tipos de datos y que pueden necesitar comillas, por ejemplo, "the first custom field" y 2.
  • PROJECT_ID: Es el ID del proyecto de tu proyecto.

Puedes imprimir este ejemplo de objeto JSON con varios métodos. Por ejemplo, en los siguientes ejemplos, se muestran algunos de los métodos posibles para imprimir el objeto JSON de ejemplo:

  • Imprime una cadena equivalente con el comando echo.

  • Imprime un diccionario equivalente con Python.

Comando echo

Para imprimir el objeto JSON de ejemplo con el comando echo y una cadena equivalente, incluye el siguiente comando en un elemento ejecutable:

echo '{\"message\":\"MESSAGE\", \"severity\":\"SEVERITY\", \"CUSTOM_FIELD_1\":CUSTOM_VALUE_1, \"CUSTOM_FIELD_2\":CUSTOM_VALUE_2}'

Por ejemplo, supongamos que creas y ejecutas una tarea con el siguiente elemento ejecutable:

"script": {
  "text": "echo '{\"message\":\"The message for a structured log.\", \"severity\":\"Error\", \"custom_field_1\":\"the first custom field\", \"custom_field_2\":2}'"
}

Luego, el registro de tareas resultante es similar al siguiente:

insertId: ...
jsonPayload:
  custom_field_1: the first custom field
  custom_field_2: 2
  message: The summary for a structured task log with error severity.
labels: ...
logName: projects/PROJECT_ID/logs/batch_task_logs
receiveTimestamp: ...
resource: ...
severity: ERROR
timestamp: ...

Python

Para imprimir el objeto JSON de ejemplo con Python y un diccionario equivalente, incluye la siguiente muestra en un elemento ejecutable:

#!/usr/bin/env python3

import json

entry = dict(
    severity="SEVERITY",
    message="MESSAGE",
    CUSTOM_FIELD_1=CUSTOM_VALUE_1,
    CUSTOM_FIELD_2=CUSTOM_VALUE_2,
)
print(json.dumps(entry))

Por ejemplo, supongamos que creas y ejecutas una tarea con el siguiente elemento ejecutable:

"script": {
  "text": "#!/usr/bin/env python3\n\nimport json\n\nentry = dict(\nseverity=\"Error\",\nmessage=\"The summary for a structured task log with error severity.\",\ncustom_field_1=\"the first custom field\",\ncustom_field_2=2,\n)\nprint(json.dumps(entry))"
}

Luego, el registro de tareas resultante es similar al siguiente:

insertId: ...
jsonPayload:
  custom_field_1: the first custom field
  custom_field_2: 2
  message: The summary for a structured task log with error severity.
labels: ...
logName: projects/PROJECT_ID/logs/batch_task_logs
receiveTimestamp: ...
resource: ...
severity: ERROR
timestamp: ...

¿Qué sigue?