@flyteorg/flyteidl 1.3.12 → 1.3.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyteorg/flyteidl",
-  "version": "1.3.12",
+  "version": "1.3.14",
   "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
   "repository": {
     "type": "git",

package/protos/flyteidl/admin/common.proto

@@ -5,6 +5,7 @@ option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin";
 
 import "flyteidl/core/execution.proto";
 import "flyteidl/core/identifier.proto";
+import "google/protobuf/timestamp.proto";
 
 // Encapsulation of fields that identifies a Flyte resource.
 // A Flyte resource can be a task, workflow or launch plan.

package/protos/flyteidl/admin/execution.proto

@@ -8,6 +8,7 @@ import "flyteidl/admin/common.proto";
 import "flyteidl/core/literals.proto";
 import "flyteidl/core/execution.proto";
 import "flyteidl/core/identifier.proto";
+import "flyteidl/core/metrics.proto";
 import "flyteidl/core/security.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
@@ -381,3 +382,19 @@ message ExecutionStateChangeDetails {
 }
 
 message ExecutionUpdateResponse {}
+
+// WorkflowExecutionGetMetricsRequest represents a request to retrieve metrics for the specified workflow execution.
+message WorkflowExecutionGetMetricsRequest {
+    // id defines the workflow execution to query for.
+    core.WorkflowExecutionIdentifier id = 1;
+
+    // depth defines the number of Flyte entity levels to traverse when breaking down execution details.
+    int32 depth = 2;
+}
+
+// WorkflowExecutionGetMetricsResponse represents the response containing metrics for the specified workflow execution.
+message WorkflowExecutionGetMetricsResponse {
+    // Span defines the top-level breakdown of the workflows execution. More precise information is nested in a
+    // hierarchical structure using Flyte entity references.
+    core.Span span = 1;
+}

package/protos/flyteidl/admin/node_execution.proto

@@ -228,4 +228,3 @@ message NodeExecutionGetDataResponse {
     // Optional Workflow closure for a dynamically generated workflow, in the case this node yields a dynamic workflow we return its structure here.
     DynamicWorkflowNodeMetadata dynamic_workflow = 16;
 }
-

package/protos/flyteidl/admin/task_execution.proto

@@ -123,6 +123,19 @@ message TaskExecutionClosure {
     // TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog
     // in this message.
     int32 event_version = 17;
+
+    // A time-series of the phase transition or update explanations. This, when compared to storing a singular reason
+    // as previously done, is much more valuable in visualizing and understanding historical evaluations.
+    repeated Reason reasons = 18;
+}
+
+// Reason is a single message annotated with a timestamp to indicate the instant the reason occurred.
+message Reason {
+    // occurred_at is the timestamp indicating the instant that this reason happened.
+    google.protobuf.Timestamp occurred_at = 1;
+
+    // message is the explanation for the most recent phase transition or status update.
+    string message = 2;
 }
 
 // Request structure to fetch inputs and output for a task execution.

package/protos/flyteidl/core/metrics.proto

@@ -0,0 +1,36 @@
+syntax = "proto3";
+
+package flyteidl.core;
+
+option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/core";
+
+import "flyteidl/core/identifier.proto";
+import "google/protobuf/timestamp.proto";
+
+// Span represents a duration trace of Flyte execution. The id field denotes a Flyte execution entity or an operation
+// which uniquely identifies the Span. The spans attribute allows this Span to be further broken down into more
+// precise definitions.
+message Span {
+    // start_time defines the instance this span began.
+    google.protobuf.Timestamp start_time = 1;
+
+    // end_time defines the instance this span completed.
+    google.protobuf.Timestamp end_time = 2;
+
+    oneof id {
+        // workflow_id is the id of the workflow execution this Span represents.
+        flyteidl.core.WorkflowExecutionIdentifier workflow_id = 3;
+
+        // node_id is the id of the node execution this Span represents.
+        flyteidl.core.NodeExecutionIdentifier node_id = 4;
+
+        // task_id is the id of the task execution this Span represents.
+        flyteidl.core.TaskExecutionIdentifier task_id = 5;
+
+        // operation_id is the id of a unique operation that this Span represents.
+        string operation_id = 6;
+    }
+
+    // spans defines a collection of Spans that breakdown this execution.
+    repeated Span spans = 7;
+}

package/protos/flyteidl/event/event.proto

@@ -104,6 +104,12 @@ message NodeExecutionEvent {
     // String location uniquely identifying where the deck HTML file is
     // NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)
     string deck_uri = 19;
+
+    // This timestamp represents the instant when the event was reported by the executing framework. For example,
+    // when first processing a node the `occurred_at` timestamp should be the instant propeller makes progress, so when
+    // literal inputs are initially copied. The event however will not be sent until after the copy completes.
+    // Extracting both of these timestamps facilitates a more accurate portrayal of the evaluation time-series.
+    google.protobuf.Timestamp reported_at = 21;
 }
 
 // For Workflow Nodes we need to send information about the workflow that's launched
@@ -221,6 +227,12 @@ message TaskExecutionEvent {
     // TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog
     // in this message.
     int32 event_version = 18;
+
+    // This timestamp represents the instant when the event was reported by the executing framework. For example, a k8s
+    // pod task may be marked completed at (ie. `occurred_at`) the instant the container running user code completes,
+    // but this event will not be reported until the pod is marked as completed. Extracting both of these timestamps
+    // facilitates a more accurate portrayal of the evaluation time-series. 
+    google.protobuf.Timestamp reported_at = 20;
 }
 
 // This message contains metadata about external resources produced or used by a specific task execution.

package/protos/flyteidl/service/admin.proto

@@ -20,6 +20,7 @@ import "flyteidl/admin/version.proto";
 import "flyteidl/admin/common.proto";
 import "flyteidl/admin/description_entity.proto";
 import "flyteidl/core/identifier.proto";
+import "flyteidl/core/metrics.proto";
 // import "protoc-gen-swagger/options/annotations.proto";
 
 // The following defines an RPC service that is also served over HTTP via grpc-gateway.
@@ -627,4 +628,14 @@ service AdminService {
     //   description: "Fetch existing description entity definitions matching input filters."
     // };
   }
+
+  // Fetches runtime metrics for a :ref:`ref_flyteidl.admin.Execution`.
+  rpc GetExecutionMetrics (flyteidl.admin.WorkflowExecutionGetMetricsRequest) returns (flyteidl.admin.WorkflowExecutionGetMetricsResponse) {
+    option (google.api.http) = {
+      get: "/api/v1/metrics/executions/{id.project}/{id.domain}/{id.name}"
+    };
+    // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
+    //   description: "Retrieve metrics from an existing workflow execution."
+    // };
+  };
 }