gemini-code-assist[bot] commented on code in PR #39294:
URL: https://github.com/apache/beam/pull/39294#discussion_r3624437959


##########
model/job-management/src/main/proto/org/apache/beam/model/job_management/v1/beam_job_api.proto:
##########
@@ -195,25 +200,41 @@ message JobMessagesRequest {
   string job_id = 1; // (required)
 }
 
+// A single log message or diagnostic event from a running job.
 message JobMessage {
+  // (Required) A unique identifier for this message.
   string message_id = 1;
+  // (Required) The time at which the message was emitted, as a string 
representation.

Review Comment:
   ![medium](https://www.gstatic.com/codereviewagent/medium-priority.svg)
   
   Since the `time` field is a string rather than a structured 
`google.protobuf.Timestamp`, it is highly recommended to specify the expected 
string format (e.g., RFC 3339 / ISO 8601). This ensures that different SDK and 
runner implementations serialize and parse the timestamp consistently.
   
   ```suggestion
     // (Required) The time at which the message was emitted, formatted as an 
RFC 3339 string.
   ```



##########
model/job-management/src/main/proto/org/apache/beam/model/job_management/v1/beam_job_api.proto:
##########
@@ -270,17 +291,22 @@ message JobState {
 }
 
 
+// A request to fetch metrics for a given job.
 message GetJobMetricsRequest {
   string job_id = 1; // (required)
 }
 
+// A response containing metrics for a given job.
 message GetJobMetricsResponse {
+  // (Required) The metrics results containing both attempted and committed 
values.
   MetricResults metrics = 1;
 }
 
 // All metrics for a given job.  Runners may support one or the other or both.
 message MetricResults {
+  // Metrics reflecting the result of attempted (non-committed) computations.

Review Comment:
   ![medium](https://www.gstatic.com/codereviewagent/medium-priority.svg)
   
   The comment describes `attempted` metrics as representing 'non-committed' 
computations. In Apache Beam, attempted metrics actually represent the 
cumulative values across all execution attempts (including both 
successful/committed attempts and any failed or retried attempts). They are not 
exclusively 'non-committed' computations. Describing them as such is misleading.
   
   ```suggestion
     // Metrics reflecting the cumulative values across all execution attempts, 
including retries.
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to