-
Notifications
You must be signed in to change notification settings - Fork 28.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[SPARK-38564][SS] Support collecting metrics from streaming sinks
### What changes were proposed in this pull request? Add the capability for streaming sinks to report custom metrics just like streaming sources ### Why are the changes needed? Allowing streaming sinks to report custom metrics is useful and achieve feature parity with streaming sources ### Does this PR introduce _any_ user-facing change? no ### How was this patch tested? New UT Closes #35872 from jerrypeng/SPARK-38564. Authored-by: Jerry Peng <jerry.peng@databricks.com> Signed-off-by: Jungtaek Lim <kabhwan.opensource@gmail.com>
- Loading branch information
1 parent
ee5121a
commit fc5e922
Showing
4 changed files
with
207 additions
and
6 deletions.
There are no files selected for viewing
36 changes: 36 additions & 0 deletions
36
...alyst/src/main/java/org/apache/spark/sql/connector/read/streaming/ReportsSinkMetrics.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| /* | ||
| * 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.connector.read.streaming; | ||
|
|
||
| import org.apache.spark.annotation.Evolving; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * A mix-in interface for streaming sinks to signal that they can report | ||
| * metrics. | ||
| * | ||
| * @since 3.4.0 | ||
| */ | ||
| @Evolving | ||
| public interface ReportsSinkMetrics { | ||
| /** | ||
| * Returns the metrics reported by the sink for this micro-batch | ||
| */ | ||
| Map<String, String> metrics(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
153 changes: 153 additions & 0 deletions
153
sql/core/src/test/scala/org/apache/spark/sql/streaming/ReportSinkMetricsSuite.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| /* | ||
| * 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.streaming | ||
|
|
||
| import scala.collection.JavaConverters._ | ||
|
|
||
| import org.apache.spark.internal.Logging | ||
| import org.apache.spark.sql._ | ||
| import org.apache.spark.sql.connector.catalog.{SupportsWrite, Table, TableCapability} | ||
| import org.apache.spark.sql.connector.read.streaming.ReportsSinkMetrics | ||
| import org.apache.spark.sql.connector.write._ | ||
| import org.apache.spark.sql.connector.write.streaming.{StreamingDataWriterFactory, StreamingWrite} | ||
| import org.apache.spark.sql.execution.streaming.MemoryStream | ||
| import org.apache.spark.sql.execution.streaming.sources.PackedRowWriterFactory | ||
| import org.apache.spark.sql.internal.connector.{SimpleTableProvider, SupportsStreamingUpdateAsAppend} | ||
| import org.apache.spark.sql.sources.{BaseRelation, CreatableRelationProvider, DataSourceRegister} | ||
| import org.apache.spark.sql.types.StructType | ||
| import org.apache.spark.sql.util.CaseInsensitiveStringMap | ||
|
|
||
| class ReportSinkMetricsSuite extends StreamTest { | ||
|
|
||
| import testImplicits._ | ||
|
|
||
| test("test ReportSinkMetrics") { | ||
| val inputData = MemoryStream[Int] | ||
| val df = inputData.toDF() | ||
| var query: StreamingQuery = null | ||
|
|
||
| var metricsMap: java.util.Map[String, String] = null | ||
|
|
||
| val listener = new StreamingQueryListener { | ||
|
|
||
| override def onQueryStarted(event: StreamingQueryListener.QueryStartedEvent): Unit = {} | ||
|
|
||
| override def onQueryProgress(event: StreamingQueryListener.QueryProgressEvent): Unit = { | ||
| metricsMap = event.progress.sink.metrics | ||
| } | ||
|
|
||
| override def onQueryTerminated( | ||
| event: StreamingQueryListener.QueryTerminatedEvent): Unit = {} | ||
| } | ||
|
|
||
| spark.streams.addListener(listener) | ||
|
|
||
| withTempDir { dir => | ||
| try { | ||
| query = | ||
| df.writeStream | ||
| .outputMode("append") | ||
| .format("org.apache.spark.sql.streaming.TestSinkProvider") | ||
| .option("checkPointLocation", dir.toString) | ||
| .start() | ||
|
|
||
| inputData.addData(1, 2, 3) | ||
|
|
||
| failAfter(streamingTimeout) { | ||
| query.processAllAvailable() | ||
| } | ||
|
|
||
| assertResult(metricsMap) { | ||
| Map("metrics-1" -> "value-1", "metrics-2" -> "value-2").asJava | ||
| } | ||
| } finally { | ||
| if (query != null) { | ||
| query.stop() | ||
| } | ||
|
|
||
| spark.streams.removeListener(listener) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| case class TestSinkRelation(override val sqlContext: SQLContext, data: DataFrame) | ||
| extends BaseRelation { | ||
| override def schema: StructType = data.schema | ||
| } | ||
|
|
||
| class TestSinkProvider extends SimpleTableProvider | ||
| with DataSourceRegister | ||
| with CreatableRelationProvider with Logging { | ||
|
|
||
| override def getTable(options: CaseInsensitiveStringMap): Table = { | ||
| TestSinkTable | ||
| } | ||
|
|
||
| def createRelation( | ||
| sqlContext: SQLContext, | ||
| mode: SaveMode, | ||
| parameters: Map[String, String], | ||
| data: DataFrame): BaseRelation = { | ||
|
|
||
| TestSinkRelation(sqlContext, data) | ||
| } | ||
|
|
||
| def shortName(): String = "test" | ||
| } | ||
|
|
||
| object TestSinkTable extends Table with SupportsWrite with ReportsSinkMetrics with Logging { | ||
|
|
||
| override def name(): String = "test" | ||
|
|
||
| override def schema(): StructType = StructType(Nil) | ||
|
|
||
| override def capabilities(): java.util.Set[TableCapability] = { | ||
| java.util.EnumSet.of(TableCapability.STREAMING_WRITE) | ||
| } | ||
|
|
||
| override def newWriteBuilder(info: LogicalWriteInfo): WriteBuilder = { | ||
| new WriteBuilder with SupportsTruncate with SupportsStreamingUpdateAsAppend { | ||
|
|
||
| override def truncate(): WriteBuilder = this | ||
|
|
||
| override def build(): Write = { | ||
| new Write { | ||
| override def toStreaming: StreamingWrite = { | ||
| new TestSinkWrite() | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override def metrics(): java.util.Map[String, String] = { | ||
| Map("metrics-1" -> "value-1", "metrics-2" -> "value-2").asJava | ||
| } | ||
| } | ||
|
|
||
| class TestSinkWrite() | ||
| extends StreamingWrite with Logging with Serializable { | ||
|
|
||
| def createStreamingWriterFactory(info: PhysicalWriteInfo): StreamingDataWriterFactory = | ||
| PackedRowWriterFactory | ||
|
|
||
| override def commit(epochId: Long, messages: Array[WriterCommitMessage]): Unit = {} | ||
|
|
||
| def abort(epochId: Long, messages: Array[WriterCommitMessage]): Unit = {} | ||
| } |