[KYUUBI #6107][FOLLOWUP] Add comments for the newly added parameters …

…of the Spark event # 🔍 Description ## Issue References 🔗 This pull request fixes #6112 (comment) ## Describe Your Solution 🔧 add comments for the newly added parameters ## Types of changes 🔖 - [ ] 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 ⚰️ #### Behavior With This Pull Request 🎉 #### 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 d93028b [bkhan] add comments Authored-by: bkhan <[email protected]> Signed-off-by: Shaoyun Chen <[email protected]>
apache · Mar 4, 2024 · a9b90c7 · a9b90c7
1 parent 97d02a4
commit a9b90c7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/...-spark-sql-engine/src/main/scala/org/apache/kyuubi/engine/spark/events/SessionEvent.scala b/...-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/...sql-engine/src/main/scala/org/apache/kyuubi/engine/spark/events/SparkOperationEvent.scala b/...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,