Skip to content

[SPARK-50153][SQL] Add name to RuleExecutor to make printing QueryExecutionMetrics's logs clearer #48688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
panbingkun wants to merge 3 commits into from
Closed

[SPARK-50153][SQL] Add name to RuleExecutor to make printing QueryExecutionMetrics's logs clearer #48688

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bbacdd
[SPARK-50153][SQL] Add `name` to `RuleExecutor` to make printing `Que…
panbingkun Oct 29, 2024
38b075d
Merge branch 'master' into SPARK-50153
panbingkun Nov 14, 2024
6d6853d
convert to method
panbingkun Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions common/utils/src/main/scala/org/apache/spark/internal/LogKey.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,7 @@ private[spark] object LogKeys {
case object RPC_ENDPOINT_REF extends LogKey
case object RPC_MESSAGE_CAPACITY extends LogKey
case object RPC_SSL_ENABLED extends LogKey
case object RULE_EXECUTOR_NAME extends LogKey
case object RULE_NAME extends LogKey
case object RUN_ID extends LogKey
case object SCALA_VERSION extends LogKey
Expand Down
12 changes: 9 additions & 3 deletions sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/rules/RuleExecutor.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,13 @@ class PlanChangeLogger[TreeType <: TreeNode[_]] extends Logging {
}
}

def logMetrics(metrics: QueryExecutionMetrics): Unit = {
def logMetrics(name: String, metrics: QueryExecutionMetrics): Unit = {
val totalTime = metrics.time / NANOS_PER_MILLIS.toDouble
val totalTimeEffective = metrics.timeEffective / NANOS_PER_MILLIS.toDouble
// scalastyle:off line.size.limit
val message: MessageWithContext =
log"""
|=== Metrics of Executed Rules ===
|=== Metrics of Executed Rules ${MDC(RULE_EXECUTOR_NAME, name)} ===
|Total number of runs: ${MDC(NUM_RULE_OF_RUNS, metrics.numRuns)}
|Total time: ${MDC(TOTAL_TIME, totalTime)} ms
|Total number of effective runs: ${MDC(NUM_EFFECTIVE_RULE_OF_RUNS, metrics.numEffectiveRuns)}
Expand All @@ -118,6 +118,12 @@ class PlanChangeLogger[TreeType <: TreeNode[_]] extends Logging {

abstract class RuleExecutor[TreeType <: TreeNode[_]] extends Logging {

/** Name for this rule executor, automatically inferred based on class name. */
val name: String = {
Copy link
Member

@MaxGekk MaxGekk Nov 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about to convert it to a method with protected to allow override in sub-classes for better names.

Copy link
Contributor Author

@panbingkun panbingkun Nov 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sense, let me update it now, thanks!

val className = getClass.getName
if (className endsWith "$") className.dropRight(1) else className
}

/**
* An execution strategy for rules that indicates the maximum number of executions. If the
* execution reaches fix point (i.e. converge) before maxIterations, it will stop.
Expand Down Expand Up @@ -291,7 +297,7 @@ abstract class RuleExecutor[TreeType <: TreeNode[_]] extends Logging {

planChangeLogger.logBatch(batch.name, batchStartPlan, curPlan)
}
planChangeLogger.logMetrics(RuleExecutor.getCurrentMetrics() - beforeMetrics)
planChangeLogger.logMetrics(name, RuleExecutor.getCurrentMetrics() - beforeMetrics)

curPlan
}
Expand Down