Skip to content

[SPARK-39958][SQL] Add warning log when unable to load custom metric object #37386

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
viirya wants to merge 2 commits into from
Closed

[SPARK-39958][SQL] Add warning log when unable to load custom metric object #37386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6683a11
Add warning log
viirya Aug 3, 2022
316b248
For review
viirya Aug 3, 2022
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
4 changes: 4 additions & 0 deletions sql/catalyst/src/main/java/org/apache/spark/sql/connector/metric/CustomMetric.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
* and combine the metrics at the driver side. How to combine task metrics is defined by the
* metric class with the same metric name.
*
* When Spark needs to aggregate task metrics, it will internally construct the instance of
* custom metric class defined in data source by using reflection. Spark requires the class
* implementing this interface to have a 0-arg constructor.
*
* @since 3.2.0
*/
@Evolving
Expand Down
5 changes: 4 additions & 1 deletion sql/core/src/main/scala/org/apache/spark/sql/execution/ui/SQLAppStatusListener.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,10 @@ class SQLAppStatusListener(
metricAggregationMap.put(className, method)
method
} catch {
case NonFatal(_) =>
case NonFatal(e) =>
logWarning(s"Unable to load custom metric object for class `$className`. " +
"Please make sure that the custom metric class is in the classpath and " +
"it has 0-arg constructor.", e)
Copy link
Member

@pan3793 pan3793 Aug 3, 2022

Choose a reason for hiding this comment

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

Utils#loadExtensions also allows "single-argument constructor that accepts SparkConf", do we need to mention that?

Copy link
Member Author

@viirya viirya Aug 3, 2022

Choose a reason for hiding this comment

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

I don't think we should. Actually we don't need the implementing class to implement it.

// Cannot initialize custom metric object, we might be in history server that does
// not have the custom metric class.
val defaultMethod = (_: Array[Long], _: Array[Long]) => "N/A"
Expand Down