(kyuubi) branch master updated: [KYUUBI #6107][FOLLOWUP] Add comments for the newly added parameters of the Spark event

[cs...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

csy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi.git


The following commit(s) were added to refs/heads/master by this push:
     new a9b90c710 [KYUUBI #6107][FOLLOWUP] Add comments for the newly added parameters of the Spark event
a9b90c710 is described below

commit a9b90c710024e9f8c6bcee28523b5e2a46f85a2f
Author: bkhan <bk...@trip.com>
AuthorDate: Mon Mar 4 16:59:24 2024 +0800

    [KYUUBI #6107][FOLLOWUP] Add comments for the newly added parameters of the Spark event
    
    # :mag: Description
    ## Issue References 🔗
    
    This pull request fixes https://github.com/apache/kyuubi/pull/6112#discussion_r1510610593
    
    ## Describe Your Solution 🔧
    
    add comments for the newly added parameters
    
    ## Types of changes :bookmark:
    
    - [ ] Bugfix (non-breaking change which fixes an issue)
    - [ ] New feature (non-breaking change which adds functionality)
    - [ ] Breaking change (fix or feature that would cause existing functionality to change)
    
    ## Test Plan 🧪
    
    #### Behavior Without This Pull Request :coffin:
    
    #### Behavior With This Pull Request :tada:
    
    #### Related Unit Tests
    
    ---
    
    # Checklist 📝
    
    - [x] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)
    
    **Be nice. Be informative.**
    
    Closes #6124 from XorSum/features/features/spark-engine-cpu-time-collect-comments.
    
    Closes #6107
    
    d93028b00 [bkhan] add comments
    
    Authored-by: bkhan <bk...@trip.com>
    Signed-off-by: Shaoyun Chen <cs...@apache.org>
---
 .../scala/org/apache/kyuubi/engine/spark/events/SessionEvent.scala    | 4 ++++
 .../org/apache/kyuubi/engine/spark/events/SparkOperationEvent.scala   | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/externals/kyuubi-spark-sql-engine/src/main/scala/org/apache/kyuubi/engine/spark/events/SessionEvent.scala b/externals/kyuubi-spark-sql-engine/src/main/scala/org/apache/kyuubi/engine/spark/events/SessionEvent.scala
index 610b1645c..5f04945ef 100644
--- a/externals/kyuubi-spark-sql-engine/src/main/scala/org/apache/kyuubi/engine/spark/events/SessionEvent.scala
+++ b/externals/kyuubi-spark-sql-engine/src/main/scala/org/apache/kyuubi/engine/spark/events/SessionEvent.scala
@@ -36,6 +36,10 @@ import org.apache.kyuubi.events.KyuubiEvent
  * @param ip Client IP address
  * @param serverIp Kyuubi Server IP address
  * @param totalOperations how many queries and meta calls
+ * @param sessionRunTime total time of running the session (including fetching shuffle data)
+ *                       in milliseconds
+ * @param sessionCpuTime total CPU time of running the session (including fetching shuffle data)
+ *                       in nanoseconds
  */
 case class SessionEvent(
     @KVIndexParam sessionId: String,
diff --git a/externals/kyuubi-spark-sql-engine/src/main/scala/org/apache/kyuubi/engine/spark/events/SparkOperationEvent.scala b/externals/kyuubi-spark-sql-engine/src/main/scala/org/apache/kyuubi/engine/spark/events/SparkOperationEvent.scala
index 4b529cdaf..143ba61f8 100644
--- a/externals/kyuubi-spark-sql-engine/src/main/scala/org/apache/kyuubi/engine/spark/events/SparkOperationEvent.scala
+++ b/externals/kyuubi-spark-sql-engine/src/main/scala/org/apache/kyuubi/engine/spark/events/SparkOperationEvent.scala
@@ -46,6 +46,10 @@ import org.apache.kyuubi.events.KyuubiEvent
  * @param sessionId the identifier of the parent session
  * @param sessionUser the authenticated client user
  * @param executionId the query execution id of this operation
+ * @param operationRunTime total time of running the operation (including fetching shuffle data)
+ *                         in milliseconds
+ * @param operationCpuTime total CPU time of running the operation (including fetching shuffle data)
+ *                         in nanoseconds
  */
 case class SparkOperationEvent(
     @KVIndexParam statementId: String,