viirya commented on a change in pull request #31451: URL: https://github.com/apache/spark/pull/31451#discussion_r616034064
########## File path: sql/core/src/main/scala/org/apache/spark/sql/execution/metric/CustomMetrics.scala ########## @@ -0,0 +1,77 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.spark.sql.execution.metric + +import org.apache.spark.sql.connector.CustomMetric + +object CustomMetrics { + private[spark] val V2_CUSTOM = "v2Custom" + + /** + * Given a class name, builds and returns a metric type for a V2 custom metric class + * `CustomMetric`. + */ + def buildV2CustomMetricTypeName(customMetric: CustomMetric): String = { + s"${V2_CUSTOM}_${customMetric.getClass.getCanonicalName}" + } + + /** + * Given a V2 custom metric type name, this method parses it and returns the corresponding + * `CustomMetric` class name. + */ + def parseV2CustomMetricType(metricType: String): Option[String] = { + val className = metricType.stripPrefix(s"${V2_CUSTOM}_") + + if (className == metricType) { + None + } else { + Some(className) + } + } +} + +/** + * Built-in `CustomMetric` that sums up metric values. + */ +class CustomSumMetric extends CustomMetric { + override def name(): String = "CustomSumMetric" + + override def description(): String = "Sum up CustomMetric" + + override def aggregateTaskMetrics(taskMetrics: Array[Long]): String = { + taskMetrics.sum.toString + } +} + +/** + * Built-in `CustomMetric` that computes average of metric values. + */ +class CustomAvgMetric extends CustomMetric { + override def name(): String = "CustomAvgMetric" + + override def description(): String = "Average CustomMetric" + + override def aggregateTaskMetrics(taskMetrics: Array[Long]): String = { + val average = if (taskMetrics.isEmpty) { + 0L + } else { + taskMetrics.sum / taskMetrics.length Review comment: No special reason. We can use Double to show numbers after decimal point. -- 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. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
