uncleGen commented on a change in pull request #28781: URL: https://github.com/apache/spark/pull/28781#discussion_r462696730
########## File path: sql/core/src/main/scala/org/apache/spark/sql/execution/ui/StreamingQueryStatusStore.scala ########## @@ -0,0 +1,60 @@ +/* + * 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.ui + +import org.apache.spark.sql.streaming.ui.{StreamingQueryProgressWrapper, StreamingQuerySummary, StreamingQueryUIData} +import org.apache.spark.status.KVUtils +import org.apache.spark.util.kvstore.KVStore + +/** + * Provides a view of a KVStore with methods that make it easy to query Streaming Query state. + * There's no state kept in this class, so it's ok to have multiple instances of it in an + * application. + */ +class StreamingQueryStatusStore(store: KVStore) { + + def allQueryUIData: Seq[StreamingQueryUIData] = synchronized { + val view = store.view(classOf[StreamingQuerySummary]).index("startTimestamp").first(0L) + KVUtils.viewToSeq(view, Int.MaxValue)(_ => true).map(makeUIData) + } + + // Visible for testing. + private[sql] def activeQueryUIData(): Seq[StreamingQueryUIData] = { + allQueryUIData.filter(_.summary.isActive) Review comment: fixed ########## File path: sql/core/src/main/scala/org/apache/spark/sql/execution/ui/StreamingQueryStatusStore.scala ########## @@ -0,0 +1,60 @@ +/* + * 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.ui + +import org.apache.spark.sql.streaming.ui.{StreamingQueryProgressWrapper, StreamingQuerySummary, StreamingQueryUIData} +import org.apache.spark.status.KVUtils +import org.apache.spark.util.kvstore.KVStore + +/** + * Provides a view of a KVStore with methods that make it easy to query Streaming Query state. + * There's no state kept in this class, so it's ok to have multiple instances of it in an + * application. + */ +class StreamingQueryStatusStore(store: KVStore) { + + def allQueryUIData: Seq[StreamingQueryUIData] = synchronized { + val view = store.view(classOf[StreamingQuerySummary]).index("startTimestamp").first(0L) + KVUtils.viewToSeq(view, Int.MaxValue)(_ => true).map(makeUIData) + } + + // Visible for testing. + private[sql] def activeQueryUIData(): Seq[StreamingQueryUIData] = { + allQueryUIData.filter(_.summary.isActive) + } + + // Visible for testing. + private[sql] def inactiveQueryUIData(): Seq[StreamingQueryUIData] = { + allQueryUIData.filter(!_.summary.isActive) Review comment: fixed ########## File path: sql/core/src/main/scala/org/apache/spark/sql/streaming/ui/StreamingQueryStatusListener.scala ########## @@ -18,104 +18,141 @@ package org.apache.spark.sql.streaming.ui import java.util.UUID -import java.util.concurrent.ConcurrentHashMap -import scala.collection.JavaConverters._ -import scala.collection.mutable +import scala.collection.immutable.Queue + +import com.fasterxml.jackson.annotation.JsonIgnore import org.apache.spark.SparkConf import org.apache.spark.sql.internal.StaticSQLConf import org.apache.spark.sql.streaming.{StreamingQueryListener, StreamingQueryProgress} +import org.apache.spark.sql.streaming.ui.StreamingQueryProgressWrapper._ import org.apache.spark.sql.streaming.ui.UIUtils.parseProgressTimestamp +import org.apache.spark.status.{ElementTrackingStore, KVUtils} +import org.apache.spark.status.KVUtils.KVIndexParam +import org.apache.spark.util.kvstore.KVIndex /** * A customized StreamingQueryListener used in structured streaming UI, which contains all * UI data for both active and inactive query. - * TODO: Add support for history server. */ -private[sql] class StreamingQueryStatusListener(conf: SparkConf) extends StreamingQueryListener { - - /** - * We use runId as the key here instead of id in active query status map, - * because the runId is unique for every started query, even it its a restart. - */ - private[ui] val activeQueryStatus = new ConcurrentHashMap[UUID, StreamingQueryUIData]() - private[ui] val inactiveQueryStatus = new mutable.Queue[StreamingQueryUIData]() +private[sql] class StreamingQueryStatusListener( + conf: SparkConf, + store: ElementTrackingStore) extends StreamingQueryListener { private val streamingProgressRetention = conf.get(StaticSQLConf.STREAMING_UI_RETAINED_PROGRESS_UPDATES) private val inactiveQueryStatusRetention = conf.get(StaticSQLConf.STREAMING_UI_RETAINED_QUERIES) + store.addTrigger(classOf[StreamingQuerySummary], inactiveQueryStatusRetention) { count => + cleanupInactiveQueries(count) + } + + private def cleanupInactiveQueries(count: Long): Unit = { + val countToDelete = count - inactiveQueryStatusRetention + if (countToDelete <= 0) { + return + } + + val view = store.view(classOf[StreamingQuerySummary]).index("startTimestamp").first(0L) + val toDelete = KVUtils.viewToSeq(view, countToDelete.toInt)(_.isActive == false) Review comment: fixed ########## File path: sql/core/src/main/scala/org/apache/spark/sql/streaming/ui/StreamingQueryStatusListener.scala ########## @@ -18,104 +18,141 @@ package org.apache.spark.sql.streaming.ui import java.util.UUID -import java.util.concurrent.ConcurrentHashMap -import scala.collection.JavaConverters._ -import scala.collection.mutable +import scala.collection.immutable.Queue + +import com.fasterxml.jackson.annotation.JsonIgnore import org.apache.spark.SparkConf import org.apache.spark.sql.internal.StaticSQLConf import org.apache.spark.sql.streaming.{StreamingQueryListener, StreamingQueryProgress} +import org.apache.spark.sql.streaming.ui.StreamingQueryProgressWrapper._ import org.apache.spark.sql.streaming.ui.UIUtils.parseProgressTimestamp +import org.apache.spark.status.{ElementTrackingStore, KVUtils} +import org.apache.spark.status.KVUtils.KVIndexParam +import org.apache.spark.util.kvstore.KVIndex /** * A customized StreamingQueryListener used in structured streaming UI, which contains all * UI data for both active and inactive query. - * TODO: Add support for history server. */ -private[sql] class StreamingQueryStatusListener(conf: SparkConf) extends StreamingQueryListener { - - /** - * We use runId as the key here instead of id in active query status map, - * because the runId is unique for every started query, even it its a restart. - */ - private[ui] val activeQueryStatus = new ConcurrentHashMap[UUID, StreamingQueryUIData]() - private[ui] val inactiveQueryStatus = new mutable.Queue[StreamingQueryUIData]() +private[sql] class StreamingQueryStatusListener( + conf: SparkConf, + store: ElementTrackingStore) extends StreamingQueryListener { private val streamingProgressRetention = conf.get(StaticSQLConf.STREAMING_UI_RETAINED_PROGRESS_UPDATES) private val inactiveQueryStatusRetention = conf.get(StaticSQLConf.STREAMING_UI_RETAINED_QUERIES) + store.addTrigger(classOf[StreamingQuerySummary], inactiveQueryStatusRetention) { count => + cleanupInactiveQueries(count) + } + + private def cleanupInactiveQueries(count: Long): Unit = { + val countToDelete = count - inactiveQueryStatusRetention + if (countToDelete <= 0) { + return + } + + val view = store.view(classOf[StreamingQuerySummary]).index("startTimestamp").first(0L) + val toDelete = KVUtils.viewToSeq(view, countToDelete.toInt)(_.isActive == false) + toDelete.foreach { e => + store.delete(e.getClass, e.runId) + store.removeAllByIndexValues( + classOf[StreamingQueryProgressWrapper], "runId", e.runId.toString) + } + } + override def onQueryStarted(event: StreamingQueryListener.QueryStartedEvent): Unit = { val startTimestamp = parseProgressTimestamp(event.timestamp) - activeQueryStatus.putIfAbsent(event.runId, - new StreamingQueryUIData(event.name, event.id, event.runId, startTimestamp)) + val querySummary = new StreamingQuerySummary( + event.name, + event.id, + event.runId, + Queue.empty[String], + startTimestamp, + true, + None) + store.write(querySummary) } override def onQueryProgress(event: StreamingQueryListener.QueryProgressEvent): Unit = { - val batchTimestamp = parseProgressTimestamp(event.progress.timestamp) - val queryStatus = activeQueryStatus.getOrDefault( - event.progress.runId, - new StreamingQueryUIData(event.progress.name, event.progress.id, event.progress.runId, - batchTimestamp)) - queryStatus.updateProcess(event.progress, streamingProgressRetention) + val runId = event.progress.runId + val batchId = event.progress.batchId + val timestamp = event.progress.timestamp + val querySummary = store.read(classOf[StreamingQuerySummary], runId) + val progressIds = + querySummary.progressIds ++ Seq(getUniqueId(runId, batchId, timestamp)) + store.write(new StreamingQueryProgressWrapper(event.progress)) + while(progressIds.length >= streamingProgressRetention) { + val uniqueId = progressIds.dequeue + store.delete(classOf[StreamingQueryProgressWrapper], uniqueId) + } + store.delete(classOf[StreamingQuerySummary], runId) Review comment: fixed ########## File path: sql/core/src/main/scala/org/apache/spark/sql/streaming/ui/StreamingQueryStatusListener.scala ########## @@ -18,104 +18,141 @@ package org.apache.spark.sql.streaming.ui import java.util.UUID -import java.util.concurrent.ConcurrentHashMap -import scala.collection.JavaConverters._ -import scala.collection.mutable +import scala.collection.immutable.Queue + +import com.fasterxml.jackson.annotation.JsonIgnore import org.apache.spark.SparkConf import org.apache.spark.sql.internal.StaticSQLConf import org.apache.spark.sql.streaming.{StreamingQueryListener, StreamingQueryProgress} +import org.apache.spark.sql.streaming.ui.StreamingQueryProgressWrapper._ import org.apache.spark.sql.streaming.ui.UIUtils.parseProgressTimestamp +import org.apache.spark.status.{ElementTrackingStore, KVUtils} +import org.apache.spark.status.KVUtils.KVIndexParam +import org.apache.spark.util.kvstore.KVIndex /** * A customized StreamingQueryListener used in structured streaming UI, which contains all * UI data for both active and inactive query. - * TODO: Add support for history server. */ -private[sql] class StreamingQueryStatusListener(conf: SparkConf) extends StreamingQueryListener { - - /** - * We use runId as the key here instead of id in active query status map, - * because the runId is unique for every started query, even it its a restart. - */ - private[ui] val activeQueryStatus = new ConcurrentHashMap[UUID, StreamingQueryUIData]() - private[ui] val inactiveQueryStatus = new mutable.Queue[StreamingQueryUIData]() +private[sql] class StreamingQueryStatusListener( + conf: SparkConf, + store: ElementTrackingStore) extends StreamingQueryListener { private val streamingProgressRetention = conf.get(StaticSQLConf.STREAMING_UI_RETAINED_PROGRESS_UPDATES) private val inactiveQueryStatusRetention = conf.get(StaticSQLConf.STREAMING_UI_RETAINED_QUERIES) + store.addTrigger(classOf[StreamingQuerySummary], inactiveQueryStatusRetention) { count => + cleanupInactiveQueries(count) + } + + private def cleanupInactiveQueries(count: Long): Unit = { + val countToDelete = count - inactiveQueryStatusRetention + if (countToDelete <= 0) { + return + } + + val view = store.view(classOf[StreamingQuerySummary]).index("startTimestamp").first(0L) + val toDelete = KVUtils.viewToSeq(view, countToDelete.toInt)(_.isActive == false) + toDelete.foreach { e => + store.delete(e.getClass, e.runId) + store.removeAllByIndexValues( + classOf[StreamingQueryProgressWrapper], "runId", e.runId.toString) + } + } + override def onQueryStarted(event: StreamingQueryListener.QueryStartedEvent): Unit = { val startTimestamp = parseProgressTimestamp(event.timestamp) - activeQueryStatus.putIfAbsent(event.runId, - new StreamingQueryUIData(event.name, event.id, event.runId, startTimestamp)) + val querySummary = new StreamingQuerySummary( + event.name, + event.id, + event.runId, + Queue.empty[String], + startTimestamp, + true, + None) + store.write(querySummary) } override def onQueryProgress(event: StreamingQueryListener.QueryProgressEvent): Unit = { - val batchTimestamp = parseProgressTimestamp(event.progress.timestamp) - val queryStatus = activeQueryStatus.getOrDefault( - event.progress.runId, - new StreamingQueryUIData(event.progress.name, event.progress.id, event.progress.runId, - batchTimestamp)) - queryStatus.updateProcess(event.progress, streamingProgressRetention) + val runId = event.progress.runId + val batchId = event.progress.batchId + val timestamp = event.progress.timestamp + val querySummary = store.read(classOf[StreamingQuerySummary], runId) + val progressIds = + querySummary.progressIds ++ Seq(getUniqueId(runId, batchId, timestamp)) + store.write(new StreamingQueryProgressWrapper(event.progress)) + while(progressIds.length >= streamingProgressRetention) { + val uniqueId = progressIds.dequeue + store.delete(classOf[StreamingQueryProgressWrapper], uniqueId) + } + store.delete(classOf[StreamingQuerySummary], runId) + store.write(new StreamingQuerySummary( + querySummary.name, + querySummary.id, + querySummary.runId, + progressIds, + querySummary.startTimestamp, + querySummary.isActive, + querySummary.exception + )) } override def onQueryTerminated( event: StreamingQueryListener.QueryTerminatedEvent): Unit = synchronized { - val queryStatus = activeQueryStatus.remove(event.runId) - if (queryStatus != null) { - queryStatus.queryTerminated(event) - inactiveQueryStatus += queryStatus - while (inactiveQueryStatus.length >= inactiveQueryStatusRetention) { - inactiveQueryStatus.dequeue() - } - } + val querySummary = store.read(classOf[StreamingQuerySummary], event.runId) + store.delete(classOf[StreamingQuerySummary], event.runId) Review comment: fixed ---------------------------------------------------------------- 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]
