Skip to content
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.

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

[pull] master from apache:master #56

Merged
merged 2 commits into from
Dec 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import org.apache.spark.sql.catalyst.planning.ScanOperation
import org.apache.spark.sql.catalyst.plans.logical.LogicalPlan
import org.apache.spark.sql.execution.SparkPlan
import org.apache.spark.sql.execution.datasources.{CatalogFileIndex, HadoopFsRelation, InMemoryFileIndex, LogicalRelation}
import org.apache.spark.sql.execution.datasources.v2.DataSourceV2ScanRelation
import org.apache.spark.sql.types.StructType

import org.apache.kyuubi.sql.KyuubiSQLConf
Expand Down Expand Up @@ -232,6 +233,40 @@ case class MaxScanStrategy(session: SparkSession)
logicalRelation.catalogTable)
}
}
case ScanOperation(
_,
_,
_,
relation @ DataSourceV2ScanRelation(_, _, _, _, _)) =>
val table = relation.relation.table
if (table.partitioning().nonEmpty) {
val partitionColumnNames = table.partitioning().map(_.describe())
val stats = relation.computeStats()
lazy val scanFileSize = stats.sizeInBytes
if (maxFileSizeOpt.exists(_ < scanFileSize)) {
throw new MaxFileSizeExceedException(
s"""
|SQL job scan file size in bytes: $scanFileSize
|exceed restrict of table scan maxFileSize ${maxFileSizeOpt.get}
|You should optimize your SQL logical according partition structure
|or shorten query scope such as p_date, detail as below:
|Table: ${table.name()}
|Partition Structure: ${partitionColumnNames.mkString(",")}
|""".stripMargin)
}
} else {
val stats = relation.computeStats()
lazy val scanFileSize = stats.sizeInBytes
if (maxFileSizeOpt.exists(_ < scanFileSize)) {
throw new MaxFileSizeExceedException(
s"""
|SQL job scan file size in bytes: $scanFileSize
|exceed restrict of table scan maxFileSize ${maxFileSizeOpt.get}
|detail as below:
|Table: ${table.name()}
|""".stripMargin)
}
}
case _ =>
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
/*
* 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

import java.util.OptionalLong

import org.apache.spark.sql.connector.{RangeInputPartition, SimpleBatchTable, SimpleScanBuilder, SimpleWritableDataSource}
import org.apache.spark.sql.connector.catalog.Table
import org.apache.spark.sql.connector.expressions.{Expressions, FieldReference, Transform}
import org.apache.spark.sql.connector.read._
import org.apache.spark.sql.connector.read.partitioning.{KeyGroupedPartitioning, Partitioning}
import org.apache.spark.sql.util.CaseInsensitiveStringMap

class ReportStatisticsAndPartitionAwareDataSource extends SimpleWritableDataSource {

class MyScanBuilder(
val partitionKeys: Seq[String]) extends SimpleScanBuilder
with SupportsReportStatistics with SupportsReportPartitioning {

override def estimateStatistics(): Statistics = {
new Statistics {
override def sizeInBytes(): OptionalLong = OptionalLong.of(80)

override def numRows(): OptionalLong = OptionalLong.of(10)

}
}

override def planInputPartitions(): Array[InputPartition] = {
Array(RangeInputPartition(0, 5), RangeInputPartition(5, 10))
}

override def outputPartitioning(): Partitioning = {
new KeyGroupedPartitioning(partitionKeys.map(FieldReference(_)).toArray, 10)
}
}

override def getTable(options: CaseInsensitiveStringMap): Table = {
new SimpleBatchTable {
override def newScanBuilder(options: CaseInsensitiveStringMap): ScanBuilder = {
new MyScanBuilder(Seq("i"))
}

override def partitioning(): Array[Transform] = {
Array(Expressions.identity("i"))
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* 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

import java.util.OptionalLong

import org.apache.spark.sql.connector._
import org.apache.spark.sql.connector.catalog.Table
import org.apache.spark.sql.connector.read._
import org.apache.spark.sql.util.CaseInsensitiveStringMap

class ReportStatisticsDataSource extends SimpleWritableDataSource {

class MyScanBuilder extends SimpleScanBuilder
with SupportsReportStatistics {

override def estimateStatistics(): Statistics = {
new Statistics {
override def sizeInBytes(): OptionalLong = OptionalLong.of(80)

override def numRows(): OptionalLong = OptionalLong.of(10)
}
}

override def planInputPartitions(): Array[InputPartition] = {
Array(RangeInputPartition(0, 5), RangeInputPartition(5, 10))
}

}

override def getTable(options: CaseInsensitiveStringMap): Table = {
new SimpleBatchTable {
override def newScanBuilder(options: CaseInsensitiveStringMap): ScanBuilder = {
new MyScanBuilder
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import scala.collection.JavaConverters._

import org.apache.commons.io.FileUtils
import org.apache.spark.sql.catalyst.plans.logical.{GlobalLimit, LogicalPlan}
import org.apache.spark.sql.execution.datasources.v2.DataSourceV2ScanRelation

import org.apache.kyuubi.sql.{KyuubiSQLConf, KyuubiSQLExtensionException}
import org.apache.kyuubi.sql.watchdog.{MaxFileSizeExceedException, MaxPartitionExceedException}
Expand Down Expand Up @@ -607,4 +608,33 @@ trait WatchDogSuiteBase extends KyuubiSparkSQLExtensionTest {
assert(e.getMessage == "Script transformation is not allowed")
}
}

test("watchdog with scan maxFileSize -- data source v2") {
val df = spark.read.format(classOf[ReportStatisticsAndPartitionAwareDataSource].getName).load()
df.createOrReplaceTempView("test")
val logical = df.queryExecution.optimizedPlan.collect {
case d: DataSourceV2ScanRelation => d
}.head
val tableSize = logical.computeStats().sizeInBytes.toLong
withSQLConf(KyuubiSQLConf.WATCHDOG_MAX_FILE_SIZE.key -> tableSize.toString) {
sql("SELECT * FROM test").queryExecution.sparkPlan
}
withSQLConf(KyuubiSQLConf.WATCHDOG_MAX_FILE_SIZE.key -> (tableSize / 2).toString) {
intercept[MaxFileSizeExceedException](
sql("SELECT * FROM test").queryExecution.sparkPlan)
}
val nonPartDf = spark.read.format(classOf[ReportStatisticsDataSource].getName).load()
nonPartDf.createOrReplaceTempView("test_non_part")
val nonPartLogical = nonPartDf.queryExecution.optimizedPlan.collect {
case d: DataSourceV2ScanRelation => d
}.head
val nonPartTableSize = nonPartLogical.computeStats().sizeInBytes.toLong
withSQLConf(KyuubiSQLConf.WATCHDOG_MAX_FILE_SIZE.key -> nonPartTableSize.toString) {
sql("SELECT * FROM test_non_part").queryExecution.sparkPlan
}
withSQLConf(KyuubiSQLConf.WATCHDOG_MAX_FILE_SIZE.key -> (nonPartTableSize / 2).toString) {
intercept[MaxFileSizeExceedException](
sql("SELECT * FROM test_non_part").queryExecution.sparkPlan)
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,12 @@ import com.codahale.metrics.MetricRegistry
import io.prometheus.client.CollectorRegistry
import io.prometheus.client.dropwizard.DropwizardExports
import io.prometheus.client.exporter.MetricsServlet
import org.eclipse.jetty.server.Server
import org.eclipse.jetty.server.{HttpConfiguration, HttpConnectionFactory, Server, ServerConnector}
import org.eclipse.jetty.servlet.{ServletContextHandler, ServletHolder}

import org.apache.kyuubi.KyuubiException
import org.apache.kyuubi.config.KyuubiConf
import org.apache.kyuubi.config.KyuubiConf.FRONTEND_JETTY_SEND_VERSION_ENABLED
import org.apache.kyuubi.service.AbstractService

class PrometheusReporterService(registry: MetricRegistry)
Expand All @@ -35,12 +36,21 @@ class PrometheusReporterService(registry: MetricRegistry)

// VisibleForTesting
private[metrics] var httpServer: Server = _
private[metrics] var httpServerConnector: ServerConnector = _
@volatile protected var isStarted = false

override def initialize(conf: KyuubiConf): Unit = {
val port = conf.get(MetricsConf.METRICS_PROMETHEUS_PORT)
val contextPath = conf.get(MetricsConf.METRICS_PROMETHEUS_PATH)
httpServer = new Server(port)
val jettyVersionEnabled = conf.get(FRONTEND_JETTY_SEND_VERSION_ENABLED)

val httpConf = new HttpConfiguration()
httpConf.setSendServerVersion(jettyVersionEnabled)
httpServer = new Server()
httpServerConnector = new ServerConnector(httpServer, new HttpConnectionFactory(httpConf))
httpServerConnector.setPort(port)
httpServer.addConnector(httpServerConnector)

val context = new ServletContextHandler
context.setContextPath("/")
httpServer.setHandler(context)
Expand All @@ -56,6 +66,7 @@ class PrometheusReporterService(registry: MetricRegistry)
if (!isStarted) {
try {
httpServer.start()
httpServerConnector.start()
info(s"Prometheus metrics HTTP server has started at ${httpServer.getURI}.")
} catch {
case rethrow: Exception =>
Expand All @@ -78,12 +89,14 @@ class PrometheusReporterService(registry: MetricRegistry)
private def stopHttpServer(): Unit = {
if (httpServer != null) {
try {
httpServerConnector.stop()
httpServer.stop()
info("Prometheus metrics HTTP server has stopped.")
} catch {
case err: Exception => error("Cannot safely stop prometheus metrics HTTP server", err)
} finally {
httpServer = null
httpServerConnector = null
}
}
}
Expand Down
Loading