Protocol Documentation

flyteidl/event/event.proto

DynamicWorkflowNodeMetadata

For dynamic workflow nodes we send information about the dynamic workflow definition that gets generated.

DynamicWorkflowNodeMetadata type fields

Field

Type

Label

Description

id

Identifier

id represents the unique identifier of the workflow.

compiled_workflow

CompiledWorkflowClosure

Represents the compiled representation of the embedded dynamic workflow.

ExternalResourceInfo

This message contains metadata about external resources produced or used by a specific task execution.

ExternalResourceInfo type fields

Field

Type

Label

Description

external_id

string

Identifier for an external resource created by this task execution, for example Qubole query ID or presto query ids.

NodeExecutionEvent

NodeExecutionEvent type fields

Field

Type

Label

Description

id

NodeExecutionIdentifier

Unique identifier for this node execution

producer_id

string

the id of the originator (Propeller) of the event

phase

NodeExecution.Phase

occurred_at

Timestamp

This timestamp represents when the original event occurred, it is generated by the executor of the node.

input_uri

string

output_uri

string

URL to the output of the execution, it encodes all the information including Cloud source provider. ie., s3://…

error

ExecutionError

Error information for the execution

output_data

LiteralMap

Raw output data produced by this node execution.

workflow_node_metadata

WorkflowNodeMetadata

task_node_metadata

TaskNodeMetadata

parent_task_metadata

ParentTaskExecutionMetadata

[To be deprecated] Specifies which task (if any) launched this node.

parent_node_metadata

ParentNodeExecutionMetadata

Specifies the parent node of the current node execution. Node executions at level zero will not have a parent node.

retry_group

string

Retry group to indicate grouping of nodes by retries

spec_node_id

string

Identifier of the node in the original workflow/graph This maps to value of WorkflowTemplate.nodes[X].id

node_name

string

Friendly readable name for the node

ParentNodeExecutionMetadata

ParentNodeExecutionMetadata type fields

Field

Type

Label

Description

node_id

string

Unique identifier of the parent node id within the execution This is value of core.NodeExecutionIdentifier.node_id of the parent node

ParentTaskExecutionMetadata

ParentTaskExecutionMetadata type fields

Field

Type

Label

Description

id

TaskExecutionIdentifier

ResourcePoolInfo

This message holds task execution metadata specific to resource allocation used to manage concurrent executions for a project namespace.

ResourcePoolInfo type fields

Field

Type

Label

Description

allocation_token

string

Unique resource ID used to identify this execution when allocating a token.

namespace

string

Namespace under which this task execution requested an allocation token.

TaskExecutionEvent

Plugin specific execution event information. For tasks like Python, Hive, Spark, DynamicJob.

TaskExecutionEvent type fields

Field

Type

Label

Description

task_id

Identifier

ID of the task. In combination with the retryAttempt this will indicate the task execution uniquely for a given parent node execution.

parent_node_execution_id

NodeExecutionIdentifier

A task execution is always kicked off by a node execution, the event consumer will use the parent_id to relate the task to it’s parent node execution

retry_attempt

uint32

retry attempt number for this task, ie., 2 for the second attempt

phase

TaskExecution.Phase

Phase associated with the event

producer_id

string

id of the process that sent this event, mainly for trace debugging

logs

TaskLog

repeated

log information for the task execution

occurred_at

Timestamp

This timestamp represents when the original event occurred, it is generated by the executor of the task.

input_uri

string

URI of the input file, it encodes all the information including Cloud source provider. ie., s3://…

output_uri

string

URI to the output of the execution, it will be in a format that encodes all the information including Cloud source provider. ie., s3://…

error

ExecutionError

Error information for the execution

output_data

LiteralMap

Raw output data produced by this task execution.

custom_info

Struct

Custom data that the task plugin sends back. This is extensible to allow various plugins in the system.

phase_version

uint32

Some phases, like RUNNING, can send multiple events with changed metadata (new logs, additional custom_info, etc) that should be recorded regardless of the lack of phase change. The version field should be incremented when metadata changes across the duration of an individual phase.

reason

string

An optional explanation for the phase transition.

task_type

string

A predefined yet extensible Task type identifier. If the task definition is already registered in flyte admin this type will be identical, but not all task executions necessarily use pre-registered definitions and this type is useful to render the task in the UI, filter task executions, etc.

metadata

TaskExecutionMetadata

Metadata around how a task was executed.

TaskExecutionMetadata

Holds metadata around how a task was executed. As a task transitions across event phases during execution some attributes, such its generated name, generated external resources, and more may grow in size but not change necessarily based on the phase transition that sparked the event update. Metadata is a container for these attributes across the task execution lifecycle.

TaskExecutionMetadata type fields

Field

Type

Label

Description

generated_name

string

Unique, generated name for this task execution used by the backend.

external_resources

ExternalResourceInfo

repeated

Additional data on external resources on other back-ends or platforms (e.g. Hive, Qubole, etc) launched by this task execution.

resource_pool_info

ResourcePoolInfo

repeated

Includes additional data on concurrent resource management used during execution.. This is a repeated field because a plugin can request multiple resource allocations during execution.

plugin_identifier

string

The identifier of the plugin used to execute this task.

instance_class

TaskExecutionMetadata.InstanceClass

TaskNodeMetadata

TaskNodeMetadata type fields

Field

Type

Label

Description

cache_status

CatalogCacheStatus

Captures the status of caching for this execution.

catalog_key

CatalogMetadata

This structure carries the catalog artifact information

reservation_status

CatalogReservation.Status

Captures the status of cache reservations for this execution.

dynamic_workflow

DynamicWorkflowNodeMetadata

In the case this task launched a dynamic workflow we capture its structure here.

WorkflowExecutionEvent

WorkflowExecutionEvent type fields

Field

Type

Label

Description

execution_id

WorkflowExecutionIdentifier

Workflow execution id

producer_id

string

the id of the originator (Propeller) of the event

phase

WorkflowExecution.Phase

occurred_at

Timestamp

This timestamp represents when the original event occurred, it is generated by the executor of the workflow.

output_uri

string

URL to the output of the execution, it encodes all the information including Cloud source provider. ie., s3://…

error

ExecutionError

Error information for the execution

output_data

LiteralMap

Raw output data produced by this workflow execution.

WorkflowNodeMetadata

For Workflow Nodes we need to send information about the workflow that’s launched

WorkflowNodeMetadata type fields :header: “Field”, “Type”, “Label”, “Description” :widths: auto

execution_id

WorkflowExecutionIdentifier

<!– end messages –>

TaskExecutionMetadata.InstanceClass

Includes the broad category of machine used for this specific task execution.

Enum TaskExecutionMetadata.InstanceClass values :header: “Name”, “Number”, “Description” :widths: auto

DEFAULT

0

The default instance class configured for the flyte application platform.

INTERRUPTIBLE

1

The instance class configured for interruptible tasks.

<!– end enums –>

<!– end HasExtensions –>

<!– end services –>