Sie können den Verlauf einer bestimmten Workflowausführung als Liste von Schritteinträgen abrufen. Jeder Schritteintrag enthält Informationen, die Ihnen beim Analysieren, Debuggen oder Optimieren eines Workflows helfen können. Sie können beispielsweise überprüfen, welche Schritte tatsächlich ausgeführt wurden, und die Dauer und den Erfolg eines Schritts bestimmen. Dies kann besonders beim Debugging eines großen oder komplizierten nicht linearen Workflows (z. B. eines mit vielen parallelen Zweigen) hilfreich sein.
Ein Schritteintrag stellt entweder einen tatsächlichen Schritt im Quellcode (z. B. assign oder call) oder einen Befehlsblock (z. B. eine for-Schleife oder einen try/retry/except-Block) dar. Eine vollständige Liste der Schritttypen finden Sie unter StepType.
Schritteinträge abrufen
Sie können Schritteinträge abrufen, indem Sie entweder eine Anfrage an die Workflow Executions REST API senden oder die Google Cloud Console verwenden:
Google Cloud Console: In diesem Dokument finden Sie weitere Informationen unter Schritteinträge in der Console ansehen.
Zusätzlich zur Auflistung der Schritteinträge und der zugehörigen Details bietet die Console eine grafische Darstellung der Ausführungsschritte, die die Anzeige und Analyse des Pfads einer Workflowausführung erleichtert.
Workflow Executions REST API – in diesem Dokument finden Sie weitere Informationen unter Schritteintrag abrufen und Schritteinträge auflisten.
Informationen zur Schritteingabe
Ein Schritteintrag umfasst die folgenden Informationen. Weitere Informationen in diesem Dokument finden Sie unter Beispiele.
| Name | Vollständiger Ressourcenname des Schritteintrags. Dies ist eine eindeutige ID im folgenden Format, wobei STEPENTRY_ID ein zunehmender Zähler ist:
Beispiel:
|
| Erstellungs- und Aktualisierungszeiten | Zeitstempel für den Erstellungszeitpunkt des Schritteintrags und seine letzte Aktualisierung. Wenn ein Schritteintrag abgeschlossen ist, gibt updateTime die Zeit für den Abschluss an.
|
| Namen von Abläufen und Schritten | Namen der Routine und des Schritts, zu denen der Schritteintrag gehört. Der Name eines Ablaufs ist der Name des untergeordneten Workflows, der im YAML- oder JSON-Quellcode definiert ist. Der Name des Ablaufs auf oberster Ebene lautet „main“.
|
| Status und Fortschrittstyp | Status des Schritteintrags, z. B. ob der Eintrag erfolgreich war oder fehlgeschlagen ist oder ob ein Schritteintrag gerade ausgeführt wird, und die Art des Fortschritts. Eine vollständige Liste der Status und Fortschrittstypen finden Sie unter State und ProgressType. |
| Navigationsinformationen | Position des Schritteintrags, damit Sie die Hierarchie und den Ablauf des Workflows besser verstehen können, z. B. welche Schritteinträge vor oder nach dem aktuellen Schritteintrag stehen oder welche über- oder untergeordnete Elemente des Schritteintrags sind. Weitere Informationen finden Sie unter NavigationInfo. |
| Metadaten | Daten, die sich auf einen iterativen Schritteintrag beziehen, einschließlich einer ID, die den untergeordneten Thread (z. B. STEP_PARALLEL_BRANCH_ENTRY in STEP_PARALLEL_BRANCH) oder die Iteration einer for-Schleife (z. B. STEP_FOR_ITERATION in STEP_FOR) angibt. Weitere Informationen finden Sie unter StepEntryMetadata.
|
| Ausnahmen | Nutzlast für alle Ausnahmen, die beschreibt, warum ein Schritteintrag fehlgeschlagen ist. |
Schritteinträge in der Console ansehen
Sie können die Schritteinträge für eine bestimmte Workflowausführung in der Google Cloud Console ansehen.
Öffnen Sie in der Google Cloud Console die Seite Workflows.
Klicken Sie auf den Namen des Workflows, um die zugehörige Seite Workflowdetails aufzurufen.
Wenn Sie Details zu einer bestimmten Ausführung sehen möchten, klicken Sie auf die entsprechende Ausführungs-ID.
Auf dem Tab Summary (Zusammenfassung) finden Sie Informationen zur gesamten Ausführung, einschließlich aller Ausnahmen, die zum Fehlschlagen der Ausführung geführt haben. Weitere Informationen finden Sie unter Fehler bei der Ausführung.
Wenn Sie den Verlauf der Workflowausführung als Liste von Schritteinträgen ansehen möchten, klicken Sie auf den Tab Schritte.
Alle Schritteinträge für die Workflowausführung werden aufgelistet.
Verwenden Sie zum Filtern der Schritteinträge das Feld Filter oben in der Tabelle, um ein Attribut und einen Wert auszuwählen, z. B.
State: Failed.Klicken Sie auf einen bestimmten Schritteintrag, um Links für die Einträge Parent (Übergeordnete Elemente), Childs (Untergeordnete Elemente), Next (Weiter) und Previous (Zurück) aufzurufen.
Wenn Sie auf einen Link klicken, werden die anderen Links automatisch aktualisiert. Beispielsweise erstellt Parent eine Verknüpfung zum übergeordneten Element des Schritteintrags, auf den Sie geklickt haben.
Der Bereich Visualisierung enthält eine grafische Darstellung der Schritte im Workflow und hilft Ihnen, den Workflowpfad besser nachzuvollziehen.
Beispiel für einen Visualisierungsbereich
Klicken Sie auf das Diagramm, um es zu vergrößern:
Beachten Sie, dass die Visualisierung von den Schritteinträgen abweichen kann. Beispielsweise wird ein
for-Block als einzelne Komponente in der Visualisierung dargestellt. Je nach Anzahl der Iterationen können jedoch mehrere Schritteinträge vorhanden sein.Im Bereich haben Sie folgende Möglichkeiten:
- Die Visualisierung heran- oder herauszoomen
- Übergeordnete Schritteinträge minimieren oder maximieren
- Auf einen Schritteintrag klicken und den vorherigen und den nächsten Eintrag ansehen
- Bestätigen Sie erfolgreiche und fehlgeschlagene Schritteingaben, wie durch ein grünes Häkchen oder ein rotes Ausrufezeichen gekennzeichnet.
- Schließen Sie den Bereich Visualisierung, indem Sie auf den Erweiterungspfeil klicken. Klicken Sie noch einmal darauf, um das Steuerfeld zu öffnen.
Vor dem Abrufen eines Schritteintrags
Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle „Workflows-Administrator“ (workflows.stepEntries.get) für Ihr Projekt zu gewähren, damit Sie die Berechtigungen erhalten, die Sie zum Abrufen eines Schritteintrags benötigen.
Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten.
Möglicherweise können Sie die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.
Schritteintrag abrufen
Verwenden Sie die Methode projects.locations.workflows.executions.stepEntries.get, um einen Schritteintrag für eine bestimmte Workflowausführung abzurufen.
Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:
PROJECT_NUMBER: Ihre Google Cloud-Projektnummer, die auf der Seite IAM & Verwaltung aufgeführt ist.LOCATION: die Region, in der der Workflow bereitgestellt wird, z. B.us-central1.WORKFLOW_ID: der benutzerdefinierte Name des Workflows, z. B.myFirstWorkflow.EXECUTION_ID: die eindeutige ID für eine Workflowausführung, die nach der Ausführung eines Workflows zurückgegeben wird.STEPENTRY_ID: die eindeutige ID für einen Schritteintrag, z. B.1.
Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:
Sie sollten in etwa folgende JSON-Antwort erhalten:
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/STEPENTRY_ID",
"createTime": "2023-10-19T13:49:56.522717646Z",
"updateTime": "2023-10-19T13:49:56.525439354Z",
"routine": "main",
"step": "checkSearchTermInInput",
"stepType": "STEP_CONDITION",
"state": "STATE_SUCCEEDED",
"entryId": "2",
"navigationInfo": {
"children": [
"3"
],
"parent": "1",
"next": "3",
"previous": "1"
}
}
Bevor Sie Schritteinträge auflisten
Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle „Workflows-Administrator“ (workflows.stepEntries.list) für Ihr Projekt zu gewähren, damit Sie die Berechtigungen erhalten, die Sie zum Auflisten von Schritteinträgen benötigen.
Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten.
Möglicherweise können Sie die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.
Schritteinträge auflisten
Verwenden Sie die Methode projects.locations.workflows.executions.stepEntries.list, um die Schritteinträge für eine bestimmte Workflowausführung aufzulisten. Standardmäßig werden die Ergebnisse in aufsteigender Reihenfolge der createTime der Schritteinträge zurückgegeben.
Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:
PROJECT_NUMBER: Ihre Google Cloud-Projektnummer, die auf der Seite IAM & Verwaltung aufgeführt ist.LOCATION: die Region, in der der Workflow bereitgestellt wird, z. B.us-central1.WORKFLOW_ID: der benutzerdefinierte Name des Workflows, z. B.myFirstWorkflow.EXECUTION_ID: die eindeutige ID für eine Workflowausführung, die nach der Ausführung eines Workflows zurückgegeben wird.
Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:
Sie sollten in etwa folgende JSON-Antwort erhalten:
{
"stepEntries": [
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/1",
"createTime": "2023-10-19T13:49:56.522705770Z",
"updateTime": "2023-10-19T13:49:56.525439429Z",
"routine": "main",
"step": "checkSearchTermInInput",
"stepType": "STEP_SWITCH",
"state": "STATE_SUCCEEDED",
"entryId": "1",
"navigationInfo": {
"children": [
"2"
],
"next": "2"
}
},
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/2",
"createTime": "2023-10-19T13:49:56.522717646Z",
"updateTime": "2023-10-19T13:49:56.525439354Z",
"routine": "main",
"step": "checkSearchTermInInput",
"stepType": "STEP_CONDITION",
"state": "STATE_SUCCEEDED",
"entryId": "2",
"navigationInfo": {
"children": [
"3"
],
"parent": "1",
"next": "3",
"previous": "1"
}
},
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/3",
"createTime": "2023-10-19T13:49:56.525379814Z",
"updateTime": "2023-10-19T13:49:56.525439285Z",
"routine": "main",
"step": "checkSearchTermInInput.condition1",
"stepType": "STEP_ASSIGN",
"state": "STATE_SUCCEEDED",
"entryId": "3",
"navigationInfo": {
"parent": "2",
"next": "4",
"previous": "2"
}
},
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/4",
"createTime": "2023-10-19T13:49:56.525440360Z",
"updateTime": "2023-10-19T13:49:56.716973793Z",
"routine": "main",
"step": "readWikipedia",
"stepType": "STEP_CALL",
"state": "STATE_SUCCEEDED",
"entryId": "4",
"navigationInfo": {
"next": "5",
"previous": "3"
}
},
{
"name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_ID/executions/EXECUTION_ID/stepEntries/5",
"createTime": "2023-10-19T13:49:56.717263008Z",
"updateTime": "2023-10-19T13:49:56.717353199Z",
"routine": "main",
"step": "returnOutput",
"stepType": "STEP_RETURN",
"state": "STATE_SUCCEEDED",
"entryId": "5",
"navigationInfo": {
"previous": "4"
}
}
],
"totalSize": 5
}
Beispiele
Workflow mit einem for-Block
Workflow
YAML
- assignStep:
assign:
- sum: 0
- forStep:
for:
range: [1, 2]
value: v
steps:
- sumStep:
assign:
- sum: ${sum + v}
- returnStep:
return: ${sum}
JSON
[
{
"assignStep": {
"assign": [
{
"sum": 0
}
]
}
},
{
"forStep": {
"for": {
"range": [
1,
2
],
"value": "v",
"steps": [
{
"sumStep": {
"assign": [
{
"sum": "${sum + v}"
}
]
}
}
]
}
}
},
{
"returnStep": {
"return": "${sum}"
}
}
]
Diagramm
Schritteinträge
{
"stepEntries": [
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/74785b43-5b9f-4adf-bde7-a9880d0e100a/stepEntries/1",
"createTime": "2023-10-20T17:19:37.889232683Z",
"updateTime": "2023-10-20T17:19:37.889275457Z",
"routine": "main",
"step": "assignStep",
"stepType": "STEP_ASSIGN",
"state": "STATE_SUCCEEDED",
"entryId": "1",
"navigationInfo": {
"next": "2"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/74785b43-5b9f-4adf-bde7-a9880d0e100a/stepEntries/2",
"createTime": "2023-10-20T17:19:37.889276124Z",
"updateTime": "2023-10-20T17:19:37.889474759Z",
"routine": "main",
"step": "forStep",
"stepType": "STEP_FOR",
"state": "STATE_SUCCEEDED",
"entryId": "2",
"navigationInfo": {
"children": [
"3",
"5"
],
"next": "3",
"previous": "1"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/74785b43-5b9f-4adf-bde7-a9880d0e100a/stepEntries/3",
"createTime": "2023-10-20T17:19:37.889313107Z",
"updateTime": "2023-10-20T17:19:37.889382353Z",
"routine": "main",
"step": "forStep",
"stepType": "STEP_FOR_ITERATION",
"state": "STATE_SUCCEEDED",
"entryId": "3",
"navigationInfo": {
"children": [
"4"
],
"parent": "2",
"next": "4",
"previous": "2"
},
"stepEntryMetadata": {
"progressType": "PROGRESS_TYPE_FOR",
"progressNumber": "1"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/74785b43-5b9f-4adf-bde7-a9880d0e100a/stepEntries/4",
"createTime": "2023-10-20T17:19:37.889317653Z",
"updateTime": "2023-10-20T17:19:37.889382265Z",
"routine": "main",
"step": "sumStep",
"stepType": "STEP_ASSIGN",
"state": "STATE_SUCCEEDED",
"entryId": "4",
"navigationInfo": {
"parent": "3",
"next": "5",
"previous": "3"
},
"stepEntryMetadata": {
"progressType": "PROGRESS_TYPE_FOR",
"progressNumber": "1"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/74785b43-5b9f-4adf-bde7-a9880d0e100a/stepEntries/5",
"createTime": "2023-10-20T17:19:37.889383134Z",
"updateTime": "2023-10-20T17:19:37.889474707Z",
"routine": "main",
"step": "forStep",
"stepType": "STEP_FOR_ITERATION",
"state": "STATE_SUCCEEDED",
"entryId": "5",
"navigationInfo": {
"children": [
"6"
],
"parent": "2",
"next": "6",
"previous": "4"
},
"stepEntryMetadata": {
"progressType": "PROGRESS_TYPE_FOR",
"progressNumber": "2"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/74785b43-5b9f-4adf-bde7-a9880d0e100a/stepEntries/6",
"createTime": "2023-10-20T17:19:37.889384893Z",
"updateTime": "2023-10-20T17:19:37.889474649Z",
"routine": "main",
"step": "sumStep",
"stepType": "STEP_ASSIGN",
"state": "STATE_SUCCEEDED",
"entryId": "6",
"navigationInfo": {
"parent": "5",
"next": "7",
"previous": "5"
},
"stepEntryMetadata": {
"progressType": "PROGRESS_TYPE_FOR",
"progressNumber": "2"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/74785b43-5b9f-4adf-bde7-a9880d0e100a/stepEntries/7",
"createTime": "2023-10-20T17:19:37.889475882Z",
"updateTime": "2023-10-20T17:19:37.889483477Z",
"routine": "main",
"step": "returnStep",
"stepType": "STEP_RETURN",
"state": "STATE_SUCCEEDED",
"entryId": "7",
"navigationInfo": {
"previous": "6"
}
}
],
"totalSize": 7
}
Workflow mit einem untergeordneten Workflowaufruf
Workflow
YAML
main:
steps:
- callStep:
call: square
args:
x: 10
result: t
- retStep:
return: ${t}
square:
params: [x]
steps:
- assignStep:
assign:
- y: ${x*x}
- retStep:
return: ${y}
JSON
{
"main": {
"steps": [
{
"callStep": {
"call": "square",
"args": {
"x": 10
},
"result": "t"
}
},
{
"retStep": {
"return": "${t}"
}
}
]
},
"square": {
"params": [
"x"
],
"steps": [
{
"assignStep": {
"assign": [
{
"y": "${x*x}"
}
]
}
},
{
"retStep": {
"return": "${y}"
}
}
]
}
}
Diagramm
Schritteinträge
{
"stepEntries": [
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/69da2159-1039-4f88-8d8a-12baf398f372/stepEntries/1",
"createTime": "2023-10-21T15:25:55.406007695Z",
"updateTime": "2023-10-21T15:25:55.412984492Z",
"routine": "main",
"step": "callStep",
"stepType": "STEP_CALL",
"state": "STATE_SUCCEEDED",
"entryId": "1",
"navigationInfo": {
"children": [
"2",
"3"
],
"next": "2"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/69da2159-1039-4f88-8d8a-12baf398f372/stepEntries/2",
"createTime": "2023-10-21T15:25:55.412921902Z",
"updateTime": "2023-10-21T15:25:55.412967631Z",
"routine": "square",
"step": "assignStep",
"stepType": "STEP_ASSIGN",
"state": "STATE_SUCCEEDED",
"entryId": "2",
"navigationInfo": {
"parent": "1",
"next": "3",
"previous": "1"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/69da2159-1039-4f88-8d8a-12baf398f372/stepEntries/3",
"createTime": "2023-10-21T15:25:55.412968712Z",
"updateTime": "2023-10-21T15:25:55.412978913Z",
"routine": "square",
"step": "retStep",
"stepType": "STEP_RETURN",
"state": "STATE_SUCCEEDED",
"entryId": "3",
"navigationInfo": {
"parent": "1",
"next": "4",
"previous": "2"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/69da2159-1039-4f88-8d8a-12baf398f372/stepEntries/4",
"createTime": "2023-10-21T15:25:55.412992302Z",
"updateTime": "2023-10-21T15:25:55.412998396Z",
"routine": "main",
"step": "retStep",
"stepType": "STEP_RETURN",
"state": "STATE_SUCCEEDED",
"entryId": "4",
"navigationInfo": {
"previous": "3"
}
}
],
"totalSize": 4
}
Workflow mit einem fehlgeschlagenen Schritteintrag
Workflow
YAML
- tryStep:
try:
return: ${1 / 0}
except:
return: 0
JSON
[
{
"tryStep": {
"try": {
"return": "${1 / 0}"
},
"except": {
"return": 0
}
}
}
]
Diagramm
Schritteinträge
{
"stepEntries": [
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/8ec49dae-ab0c-4b55-b1c4-b809244be913/stepEntries/1",
"createTime": "2023-10-20T18:06:50.395938752Z",
"updateTime": "2023-10-20T18:06:50.396525946Z",
"routine": "main",
"step": "tryStep",
"stepType": "STEP_TRY_RETRY_EXCEPT",
"state": "STATE_SUCCEEDED",
"entryId": "1",
"navigationInfo": {
"children": [
"2",
"4"
],
"next": "2"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/8ec49dae-ab0c-4b55-b1c4-b809244be913/stepEntries/2",
"createTime": "2023-10-20T18:06:50.395942598Z",
"updateTime": "2023-10-20T18:06:50.396497992Z",
"routine": "main",
"step": "tryStep",
"stepType": "STEP_TRY",
"state": "STATE_FAILED",
"entryId": "2",
"navigationInfo": {
"children": [
"3"
],
"parent": "1",
"next": "3",
"previous": "1"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/8ec49dae-ab0c-4b55-b1c4-b809244be913/stepEntries/3",
"createTime": "2023-10-20T18:06:50.395944871Z",
"updateTime": "2023-10-20T18:06:50.396497499Z",
"routine": "main",
"step": "tryStep.try",
"stepType": "STEP_RETURN",
"state": "STATE_FAILED",
"exception": {
"payload": "{\"message\":\"ZeroDivisionError: division by zero\",\"tags\":[\"ZeroDivisionError\",\"ArithmeticError\"]}"
},
"entryId": "3",
"navigationInfo": {
"parent": "2",
"next": "4",
"previous": "2"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/8ec49dae-ab0c-4b55-b1c4-b809244be913/stepEntries/4",
"createTime": "2023-10-20T18:06:50.396506860Z",
"updateTime": "2023-10-20T18:06:50.396525900Z",
"routine": "main",
"step": "tryStep",
"stepType": "STEP_EXCEPT",
"state": "STATE_SUCCEEDED",
"entryId": "4",
"navigationInfo": {
"children": [
"5"
],
"parent": "1",
"next": "5",
"previous": "3"
}
},
{
"name": "projects/200478149810/locations/us-central1/workflows/ck-for-block/executions/8ec49dae-ab0c-4b55-b1c4-b809244be913/stepEntries/5",
"createTime": "2023-10-20T18:06:50.396516994Z",
"updateTime": "2023-10-20T18:06:50.396525818Z",
"routine": "main",
"step": "tryStep.except",
"stepType": "STEP_RETURN",
"state": "STATE_SUCCEEDED",
"entryId": "5",
"navigationInfo": {
"parent": "4",
"previous": "4"
}
}
],
"totalSize": 5
}