Supervisa flujos de trabajo

En esta página, se proporciona información para ayudarte a supervisar las implementaciones y ejecuciones de flujos de trabajo.

Accede a los registros de implementación y eliminación de flujos de trabajo

Puedes acceder a los registros de errores relacionados con la implementación y eliminación de un flujo de trabajo en el Consola de Google Cloud

1. En la consola de Google Cloud, ve a la página Workflows.

   Ir a Workflows

2. Haz clic en el nombre del flujo de trabajo para mostrar la página Detalles del flujo de trabajo.

3. Haz clic en la pestaña Registros.

4. Para filtrar los registros por gravedad, en la lista Predeterminada, selecciona el tipo de registro que se mostrará.

Accede a los resultados de la ejecución del flujo de trabajo

Puedes acceder a los resultados de la ejecución del flujo de trabajo en la consola de Google Cloud o con gcloud CLI.

Mapas de errores de ejecución

Cuando un flujo de trabajo arroja un error durante la ejecución que no está capturado en una bloque try/except, ejecución falla y un mapa de errores (un diccionario JSON) que describe el error que se devuelven.

Los errores arrojados durante la ejecución del flujo de trabajo contienen etiquetas para ayudarte a identificar causó el error. Por ejemplo, el error que muestra un conector puede tener dos claves (tags y message) similares a las siguientes:

{'tags': ['SystemError'], 'message': 'an error has occurred'}

Puede haber más de una etiqueta. Para verificar si hay una etiqueta específica, puedes usar un expresión. Por ejemplo:

${'SystemError' in e.tags}

Los datos de errores de acceso se muestran como una cadena

Algunos conectores y APIs de HTTP serializan errores como cadenas antes de devolver los errores. Puedes usar funciones de biblioteca estándar para restablecer una carga útil error original. Por ejemplo, para convertir una cadena de error en un mapa, puedes usar las funciones json.decode y text.encode:

json.decode(text.encode(ERROR_FROM_API))

Etiquetas de error

En la siguiente tabla, se describe el significado de diferentes etiquetas de error.

También puedes generar errores personalizados mediante la sintaxis raise.

Verifica el estado de las ejecuciones

Existen varios comandos que te ayudan a verificar el estado de la ejecución de un flujo de trabajo.

• Para recuperar una lista de los intentos de ejecución de un flujo de trabajo y sus IDs, ingresa el siguiente comando:

  gcloud workflows executions list WORKFLOW_NAME

  Reemplaza WORKFLOW_NAME por el nombre del flujo de trabajo.

  El comando muestra un valor NAME similar al siguiente:

  projects/PROJECT_NUMBER/locations/REGION/workflows/WORKFLOW_NAME/executions/EXECUTION_ID

  Copia el ID de ejecución para usarlo en el siguiente comando.

• Para verificar el estado de un intento de ejecución y esperar a que el intento finaliza, ingresa el siguiente comando:

  gcloud workflows executions wait EXECUTION_ID

  Reemplaza EXECUTION_ID por el ID del intento de ejecución.

  El comando espera a que finalice el intento de ejecución y, luego, muestra el resultados.

• Para esperar hasta que se complete la última ejecución y, luego, mostrar el resultado de la ejecución completada, ingresa el siguiente comando:

  gcloud workflows executions wait-last

  Si realizaste un intento de ejecución anterior en la misma sesión de gcloud, el comando espera a que finalice el intento de ejecución anterior y, luego, muestra los resultados de la ejecución completada. Si no existe ningún intento anterior, gcloud muestra el siguiente error:

  ERROR: (gcloud.workflows.executions.wait-last) [NOT FOUND] There are no cached executions available.
  

• Para obtener el estado de la última ejecución, ingresa el siguiente comando:

  gcloud workflows executions describe-last

  Si realizaste un intento de ejecución anterior en la misma sesión de gcloud, el muestra los resultados de la última ejecución, incluso si está en ejecución. Si no existe ningún intento anterior, gcloud muestra el siguiente error:

  ERROR: (gcloud.beta.workflows.executions.describe-last) [NOT FOUND] There are no cached executions available.
  

Filtrar ejecuciones

Puedes aplicar filtros a la lista de ejecuciones de flujos de trabajo que muestra el método workflows.executions.list.

Puedes filtrar por los siguientes campos:

• createTime
• disableOverflowBuffering
• duration
• endTime
• executionId
• label
• startTime
• state
• stepName
• workflowRevisionId

Por ejemplo, para filtrar en una etiqueta (labels."fruit":"apple"), puedes realizar una solicitud a la API similar a la siguiente:

GET https://workflowexecutions.googleapis.com/v1/projects/MY_PROJECT/locations/MY_LOCATION/workflows/MY_WORKFLOW/executions?view=full&filter=labels.%22fruit%22%3A%22apple%22"

Aquí:

• view=full especifica una vista que define qué campos se deben completar en la ejecuciones devueltas; En este caso, todos los datos
• labels.%22fruit%22%3A%22apple%22 es la sintaxis del filtro codificada en URL.

Para obtener más información, consulta Filtrado de AIP-160.

Envía registros a Cloud Logging

Workflows genera automáticamente registros de ejecución para el flujo de trabajo. ejecuciones en Cloud Logging.

También puedes habilitar el registro de llamadas. O bien, puedes crear registros personalizados que usen la función sys.log en tu fuente. El registro de llamadas y los registros personalizados te permiten controlar cuándo se envían los registros a Logging durante la ejecución de un flujo de trabajo y pueden ser especialmente útiles cuando depuras tu flujo de trabajo.

Para obtener más detalles, incluidos los archivos de proto de registro engine_call y executions_system, consulta este repositorio de GitHub.

Registros de ejecución

Cada ejecución de flujo de trabajo activa automáticamente al menos dos registros de ejecución: una al inicio de una ejecución y otra al final.

Para obtener más información sobre los registros de la plataforma Workflows que están disponibles en Logging, consulta los registros de la plataforma de Google Cloud.

Registro de llamadas

Puedes establecer una marca para que se registre cada paso de llamada durante la ejecución de tu flujo de trabajo y se muestren los nombres de los pasos, los nombres de las funciones, los argumentos de las funciones y las respuestas de las llamadas. También puedes registrar excepciones que se detectan o que detienen una llamada.

Solo se registran los pasos explícitos de la llamada. por ejemplo, llamadas a subflujos de trabajo o las funciones de biblioteca. Llamadas desde las expresiones o desde la interfaz funciones de biblioteca (por ejemplo, http.post en sys.log) y conectores internos no se registran.

Los encabezados de solicitud Authorization HTTP se ocultan de los registros de las llamadas HTTP.

Al aplicar el registro de llamadas a un definición del flujo de trabajo o a la la ejecución de un flujo de trabajo puedes especificar el nivel de registro requerido. El nivel de registro de ejecución tiene prioridad sobre cualquier nivel de registro de flujo de trabajo, a menos que no se especifique el nivel de registro de ejecución (predeterminado). En ese caso, se aplica el nivel de registro del flujo de trabajo.

Ten en cuenta que el límite de tamaño de entrada de registro que establece Cloud Logging también se aplica al registro de llamadas.

Registros personalizados

Para crear una entrada de registro en Logging durante la ejecución de un flujo de trabajo, Define un paso en el flujo de trabajo que realiza una llamada a la biblioteca estándar sys.log. función:

  - step1:
      assign:
          - varA: "Hello"
          - varB: "World"
  - logStep:
      call: sys.log
      args:
          text: TEXT
          severity: SEVERITY 
  - step2:
      return: ${varA + " " + varB}
    

    [
      {
        "step1": {
          "assign": [
            {
              "varA": "Hello"
            },
            {
              "varB": "World"
            }
          ]
        }
      },
      {
        "logStep": {
          "call": "sys.log",
          "args": {
            "text": "TEXT",
            "severity": "SEVERITY"
          }
        }
      },
      {
        "step2": {
          "return": "${varA + " " + varB}"
        }
      }
    ]
      

Cuando crees una entrada de registro, define lo siguiente:

• TEXT: Obligatorio. El texto que se registrará. Si necesitas Para registrar los valores de un mapa, usa ${json.encode_to_string(myMap)}.
• SEVERITY: es opcional. El nivel de gravedad del registro entrada. Por ejemplo, INFO, WARNING o CRITICAL.

Para obtener más información, consulta la referencia de la función sys.log.

Permisos necesarios

Para aplicar el registro de llamadas o enviar registros personalizados a Logging, un flujo de trabajo debe estar asociado con una cuenta de servicio que incluya la permiso logging.logEntries.create (por ejemplo, roles/logging.logWriter de seguridad en la nube). Si necesitas cambiar la cuenta de servicio actualizada con tu flujo de trabajo, consulta Actualiza un flujo de trabajo. Para obtener más información sobre cómo crear cuentas de servicio y asignar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Ver registros del flujo de trabajo

Puedes ver los registros en Flujos de trabajo o en Registro. Para ver los registros de un solo flujo de trabajo, usa la pestaña Registros en Flujos de trabajo. Para obtener una vista agregada de los registros de todos de tus flujos de trabajo, usa la página Explorador de registros en Logging.

Ver registros en Workflows

Para ver los registros de un flujo de trabajo en Workflows, haz lo siguiente:

1. En la consola de Google Cloud, ve a la página Workflows.

   Ir a Workflows

2. Para acceder a los registros de un flujo de trabajo, haz clic en su nombre para ir a la página Detalles.

3. Para ver los registros, haz clic en Registros.

4. Para filtrar los registros por gravedad, en la lista Predeterminada, selecciona el tipo de registro que deseas mostrar. De forma predeterminada, se muestran los registros de todos los niveles de gravedad.

En la pestaña Registros de la página Detalles de un flujo de trabajo, se muestran los siguientes tipos de registros:

• Registros enviados a Logging

• Registros de auditoría de cualquier operación realizada en el flujo de trabajo, como las actualizaciones de la definición del flujo de trabajo

Visualiza registros en Logging

Para ver los registros en Logging, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página Explorador de registros:
   

   Ir al Explorador de registros

2. En el Compilador de consultas, haz clic en Recurso y, luego, ingresa workflow. Seleccionar Cloud Workflow en la lista y haz clic en Agregar.

   

3. Haz clic en Ejecutar consulta.

Para obtener más información sobre la visualización de registros en Logging, consulta Usa el Explorador de registros.

¿Qué sigue?

• Descripción general de la depuración
• Soluciona problemas
• Problemas conocidos de Workflows