update idl

Signed-off-by: Kevin Su <[email protected]>
flyteorg · Jan 8, 2024 · fbb619b · fbb619b
1 parent 77d7530
commit fbb619b
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 14 deletions.
diff --git a/flyteidl/gen/pb-go/flyteidl/admin/agent.pb.go b/flyteidl/gen/pb-go/flyteidl/admin/agent.pb.go
diff --git a/flyteidl/gen/pb-go/flyteidl/core/metrics.pb.go b/flyteidl/gen/pb-go/flyteidl/core/metrics.pb.go
diff --git a/flyteidl/gen/pb-go/flyteidl/service/agent.swagger.json b/flyteidl/gen/pb-go/flyteidl/service/agent.swagger.json
diff --git a/flyteidl/gen/pb-java/flyteidl/admin/AgentOuterClass.java b/flyteidl/gen/pb-java/flyteidl/admin/AgentOuterClass.java
diff --git a/flyteidl/gen/pb-java/flyteidl/core/Metrics.java b/flyteidl/gen/pb-java/flyteidl/core/Metrics.java
diff --git a/flyteidl/gen/pb_rust/flyteidl.admin.rs b/flyteidl/gen/pb_rust/flyteidl.admin.rs
diff --git a/flyteidl/gen/pb_rust/flyteidl.core.rs b/flyteidl/gen/pb_rust/flyteidl.core.rs
diff --git a/flyteidl/protos/flyteidl/admin/agent.proto b/flyteidl/protos/flyteidl/admin/agent.proto
@@ -136,6 +136,7 @@ message GetTaskMetricsRequest {
   // Metadata is created by the agent. It could be a string (jobId) or a dict (more complex metadata).
   bytes resource_meta = 2;
   // The metrics to query. If empty, will return a default set of metrics.
+  // e.g. EXECUTION_METRIC_USED_CPU_AVG or EXECUTION_METRIC_USED_MEMORY_BYTES_AVG
   repeated string queries = 3;
   // Start timestamp, inclusive.
   google.protobuf.Timestamp start_time = 4;

diff --git a/flyteidl/protos/flyteidl/core/metrics.proto b/flyteidl/protos/flyteidl/core/metrics.proto
@@ -36,8 +36,9 @@ message Span {
     repeated Span spans = 7;
 }
 
+// ExecutionMetrics is a collection of metrics that are collected during the execution of a Flyte task.
 message ExecutionMetricResult {
-    // The metric this data represents
+    // The metric this data represents. e.g. EXECUTION_METRIC_USED_CPU_AVG or EXECUTION_METRIC_USED_MEMORY_BYTES_AVG.
     string metric = 1;
 
     // The result data in prometheus range query result format