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. Cuando configuras tus ejecutables para que escriban registros de tareas, puedes mostrar información personalizada en Cloud Logging, que puede facilitar tus trabajos para analizar y solucionar problemas. Para obtener más información sobre los registros, consulta Cómo analizar un trabajo con registros.
Antes de comenzar
- Si nunca antes usaste Batch, consulta Cómo comenzar a usar Batch y habilita Batch completando los requisitos previos para proyectos y usuarios.
-
Con el objetivo de obtener los permisos que necesitas para crear un trabajo que escriba registros, solicita a tu administrador que te otorgue el los siguientes roles de IAM:
-
Para crear un trabajo, sigue estos pasos:
-
Editor de trabajos por lotes (
roles/batch.jobsEditor
) en el proyecto -
Usuario de cuenta de servicio (
roles/iam.serviceAccountUser
) en la cuenta de servicio del trabajo, que, de forma predeterminada, es la cuenta de servicio predeterminada de Compute Engine
-
Editor de trabajos por lotes (
-
Para ver los registros, haz lo siguiente:
Visor de registros (
roles/logging.viewer
) en el proyecto
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.
-
Para crear un trabajo, sigue estos pasos:
Crear y ejecutar 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:
- Habilita los registros para el trabajo. Esto permite cualquier registro escrito para que se genere el trabajo.
Para cada registro de tareas que quieras que tenga el trabajo, agrega un comando que escribe un registro de tareas en un 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.
Escribe 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 hayas aplicado
contenido impreso. Específicamente, puedes escribir cada registro de tareas usando una de las
las siguientes opciones:
Escribe un registro no estructurado imprimiendo una cadena. Los registros no estructurados son simples y solo te permiten definir
textPayload
.Escribe un registro estructurado imprimiendo JSON. Los registros estructurados requieren formato JSON, que te permite definir varios campos. incluidos algunos campos de registro estándares, campos personalizados y eventos de estado personalizados.
Por ejemplo, puedes usar registros de tareas estructurados para definir la gravedad del registro, que puedes usar como filtro cuando visualizas los registros de un trabajo.
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
La impresión de esta cadena de ejemplo da como resultado 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
: el ID del proyecto de tu proyecto.
Imprime una cadena
Puedes imprimir una cadena utilizando distintos métodos, como incluir el
siguiente comando echo
en un ejecutable:
echo MESSAGE
Para obtener ejemplos completos de trabajos que usan el comando echo
para escribir
registros de tareas no estructuradas, consulta
Crea y ejecuta un trabajo básico.
Escribe un registro estructurado mediante la impresión de un objeto JSON
Los registros estructurados te permiten definir cualquiera de las siguientes opciones:
- Campos estándar compatibles con el agente de Cloud Logging
- Campos personalizados
- Eventos de estado personalizados
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 quieres aprender a definir un registro con eventos de estado personalizados, también consulta Configura 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
}
La impresión de este objeto JSON genera 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 lasLogSeverity
enumeraciones convertido en una cadena que solo contenga la primera letra en mayúscula. Por ejemplo, para la enumeraciónERROR
, especificaError
.CUSTOM_FIELD_1
yCUSTOM_FIELD_2
: Son los nombres de los campos personalizados para el registro de tareas, por ejemplo,custom_field_1
ycustom_field_2
.CUSTOM_VALUE_1
yCUSTOM_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"
y2
.PROJECT_ID
: Es el ID del proyecto de tu proyecto.
Imprime un objeto JSON.
Puedes imprimir este objeto JSON de ejemplo usando una variedad de 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 un trabajo con el siguiente 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 valor equivalente diccionario, incluye la siguiente muestra en un 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))"
}
Entonces, 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?
- Para obtener más información sobre el formato de los registros, consulta Registro estructurado en Documentación de Cloud Logging.
- Obtén información para escribir registros de tareas estructurados que incluyan eventos de estado personalizados.
- Obtén más información para ver los registros de tareas de un trabajo.
- Obtén más información sobre las opciones de creación de trabajos.