From 60eaae67920b0215a21efdf754e61442667b48bc Mon Sep 17 00:00:00 2001 From: Robert Kruszewski Date: Thu, 22 Jun 2017 16:53:30 +0100 Subject: [PATCH 1/3] Merge existing registry with default one or configure default metric registry --- .../apache/spark/metrics/MetricsSystem.scala | 65 ++++++++++++++++--- .../spark/metrics/MetricsSystemSuite.scala | 33 ++++++++-- .../streaming/StreamingContextSuite.scala | 9 ++- 3 files changed, 88 insertions(+), 19 deletions(-) diff --git a/core/src/main/scala/org/apache/spark/metrics/MetricsSystem.scala b/core/src/main/scala/org/apache/spark/metrics/MetricsSystem.scala index 48f816f649d3..285a8bbe0276 100644 --- a/core/src/main/scala/org/apache/spark/metrics/MetricsSystem.scala +++ b/core/src/main/scala/org/apache/spark/metrics/MetricsSystem.scala @@ -22,7 +22,7 @@ import java.util.concurrent.TimeUnit import scala.collection.mutable -import com.codahale.metrics.{Metric, MetricRegistry} +import com.codahale.metrics._ import org.eclipse.jetty.servlet.ServletContextHandler import org.apache.spark.{SecurityManager, SparkConf} @@ -70,14 +70,14 @@ import org.apache.spark.util.Utils private[spark] class MetricsSystem private ( val instance: String, conf: SparkConf, - securityMgr: SecurityManager) + securityMgr: SecurityManager, + registry: MetricRegistry) extends Logging { private[this] val metricsConfig = new MetricsConfig(conf) private val sinks = new mutable.ArrayBuffer[Sink] - private val sources = new mutable.ArrayBuffer[Source] - private val registry = new MetricRegistry() + private val sourceToListeners = new mutable.HashMap[Source, MetricRegistryListener] private var running: Boolean = false @@ -111,6 +111,7 @@ private[spark] class MetricsSystem private ( if (running) { sinks.foreach(_.stop) registry.removeMatching((_: String, _: Metric) => true) + sourceToListeners.keySet.foreach(removeSource) } else { logWarning("Stopping a MetricsSystem that is not running") } @@ -156,22 +157,23 @@ private[spark] class MetricsSystem private ( } def getSourcesByName(sourceName: String): Seq[Source] = - sources.filter(_.sourceName == sourceName).toSeq + sourceToListeners.keySet.filter(_.sourceName == sourceName).toSeq def registerSource(source: Source): Unit = { - sources += source try { - val regName = buildRegistryName(source) - registry.register(regName, source.metricRegistry) + val listener = new MetricsSystemListener(buildRegistryName(source)) + source.metricRegistry.addListener(listener) + sourceToListeners += source -> listener } catch { case e: IllegalArgumentException => logInfo("Metrics already registered", e) } } def removeSource(source: Source): Unit = { - sources -= source val regName = buildRegistryName(source) registry.removeMatching((name: String, _: Metric) => name.startsWith(regName)) + sourceToListeners.get(source).foreach(source.metricRegistry.removeListener) + sourceToListeners.remove(source) } private def registerSources(): Unit = { @@ -225,6 +227,41 @@ private[spark] class MetricsSystem private ( } } } + + private[spark] class MetricsSystemListener(prefix: String) + extends MetricRegistryListener { + def metricName(name: String): String = MetricRegistry.name(prefix, name) + + override def onHistogramAdded(name: String, histogram: Histogram): Unit = + registry.register(metricName(name), histogram) + + override def onCounterAdded(name: String, counter: Counter): Unit = + registry.register(metricName(name), counter) + + override def onHistogramRemoved(name: String): Unit = + registry.remove(metricName(name)) + + override def onGaugeRemoved(name: String): Unit = + registry.remove(metricName(name)) + + override def onMeterRemoved(name: String): Unit = + registry.remove(metricName(name)) + + override def onTimerAdded(name: String, timer: Timer): Unit = + registry.register(metricName(name), timer) + + override def onCounterRemoved(name: String): Unit = + registry.remove(metricName(name)) + + override def onGaugeAdded(name: String, gauge: Gauge[_]): Unit = + registry.register(metricName(name), gauge) + + override def onTimerRemoved(name: String): Unit = + registry.remove(metricName(name)) + + override def onMeterAdded(name: String, meter: Meter): Unit = + registry.register(metricName(name), meter) + } } private[spark] object MetricsSystem { @@ -244,7 +281,15 @@ private[spark] object MetricsSystem { def createMetricsSystem( instance: String, conf: SparkConf, securityMgr: SecurityManager): MetricsSystem = { - new MetricsSystem(instance, conf, securityMgr) + new MetricsSystem(instance, conf, securityMgr, new MetricRegistry()) + } + + def createMetricsSystem( + instance: String, + conf: SparkConf, + securityMgr: SecurityManager, + registry: MetricRegistry): MetricsSystem = { + new MetricsSystem(instance, conf, securityMgr, registry) } } diff --git a/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala b/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala index 70b6c9a11214..ee0552627867 100644 --- a/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala +++ b/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala @@ -17,9 +17,10 @@ package org.apache.spark.metrics +import scala.collection.mutable import scala.collection.mutable.ArrayBuffer -import com.codahale.metrics.MetricRegistry +import com.codahale.metrics.{Gauge, MetricRegistry, MetricRegistryListener} import org.scalatest.{BeforeAndAfter, PrivateMethodTester} import org.apache.spark.{SecurityManager, SparkConf, SparkFunSuite} @@ -42,10 +43,10 @@ class MetricsSystemSuite extends SparkFunSuite with BeforeAndAfter with PrivateM test("MetricsSystem with default config") { val metricsSystem = MetricsSystem.createMetricsSystem("default", conf, securityMgr) metricsSystem.start() - val sources = PrivateMethod[ArrayBuffer[Source]](Symbol("sources")) + val sources = PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sources")) val sinks = PrivateMethod[ArrayBuffer[Sink]](Symbol("sinks")) - assert(metricsSystem.invokePrivate(sources()).length === StaticSources.allSources.length) + assert(metricsSystem.invokePrivate(sources()).size === StaticSources.allSources.length) assert(metricsSystem.invokePrivate(sinks()).length === 0) assert(metricsSystem.getServletHandlers.nonEmpty) } @@ -53,16 +54,16 @@ class MetricsSystemSuite extends SparkFunSuite with BeforeAndAfter with PrivateM test("MetricsSystem with sources add") { val metricsSystem = MetricsSystem.createMetricsSystem("test", conf, securityMgr) metricsSystem.start() - val sources = PrivateMethod[ArrayBuffer[Source]](Symbol("sources")) + val sources = PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sources")) val sinks = PrivateMethod[ArrayBuffer[Sink]](Symbol("sinks")) - assert(metricsSystem.invokePrivate(sources()).length === StaticSources.allSources.length) + assert(metricsSystem.invokePrivate(sources()).size === StaticSources.allSources.length) assert(metricsSystem.invokePrivate(sinks()).length === 1) assert(metricsSystem.getServletHandlers.nonEmpty) val source = new MasterSource(null) metricsSystem.registerSource(source) - assert(metricsSystem.invokePrivate(sources()).length === StaticSources.allSources.length + 1) + assert(metricsSystem.invokePrivate(sources()).size === StaticSources.allSources.length + 1) } test("MetricsSystem with Driver instance") { @@ -269,4 +270,24 @@ class MetricsSystemSuite extends SparkFunSuite with BeforeAndAfter with PrivateM assert(metricName === source.sourceName) } + test("MetricsSystem registers dynamically added metrics") { + val registry = new MetricRegistry() + val source = new Source { + override val sourceName = "dummySource" + override val metricRegistry = new MetricRegistry() + } + + val instanceName = "testInstance" + val metricsSystem = MetricsSystem.createMetricsSystem( + instanceName, conf, securityMgr, registry) + metricsSystem.registerSource(source) + assert(!registry.getNames.contains("dummySource.newMetric"), "Metric shouldn't be registered") + + source.metricRegistry.register("newMetric", new Gauge[Integer] { + override def getValue: Integer = 1 + }) + assert(registry.getNames.contains("dummySource.newMetric"), + "Metric should have been registered") + } + } diff --git a/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala b/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala index 4eff464dcdaf..449c56fc37c4 100644 --- a/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala +++ b/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala @@ -22,9 +22,10 @@ import java.util.Locale import java.util.concurrent.{CountDownLatch, TimeUnit} import java.util.concurrent.atomic.AtomicInteger -import scala.collection.mutable.ArrayBuffer +import scala.collection.mutable import scala.collection.mutable.Queue +import com.codahale.metrics.MetricRegistryListener import org.apache.commons.io.FileUtils import org.scalatest.{Assertions, PrivateMethodTester} import org.scalatest.concurrent.{Signaler, ThreadSignaler, TimeLimits} @@ -1027,8 +1028,10 @@ object testPackage extends Assertions { * This includes methods to access private methods and fields in StreamingContext and MetricsSystem */ private object StreamingContextSuite extends PrivateMethodTester { - private val _sources = PrivateMethod[ArrayBuffer[Source]](Symbol("sources")) - private def getSources(metricsSystem: MetricsSystem): ArrayBuffer[Source] = { + private val _sources = + PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sources")) + private def getSources(metricsSystem: MetricsSystem): + mutable.HashMap[Source, MetricRegistryListener] = { metricsSystem.invokePrivate(_sources()) } private val _streamingSource = PrivateMethod[StreamingSource](Symbol("streamingSource")) From 09347dfb79e6242a19f09e0e6d9ce853a2c2924d Mon Sep 17 00:00:00 2001 From: Robert Kruszewski Date: Thu, 8 Oct 2020 23:59:17 +0100 Subject: [PATCH 2/3] variable name --- .../scala/org/apache/spark/metrics/MetricsSystemSuite.scala | 4 ++-- .../org/apache/spark/streaming/StreamingContextSuite.scala | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala b/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala index ee0552627867..32fcef8befde 100644 --- a/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala +++ b/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala @@ -43,7 +43,7 @@ class MetricsSystemSuite extends SparkFunSuite with BeforeAndAfter with PrivateM test("MetricsSystem with default config") { val metricsSystem = MetricsSystem.createMetricsSystem("default", conf, securityMgr) metricsSystem.start() - val sources = PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sources")) + val sources = PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sourceToListeners")) val sinks = PrivateMethod[ArrayBuffer[Sink]](Symbol("sinks")) assert(metricsSystem.invokePrivate(sources()).size === StaticSources.allSources.length) @@ -54,7 +54,7 @@ class MetricsSystemSuite extends SparkFunSuite with BeforeAndAfter with PrivateM test("MetricsSystem with sources add") { val metricsSystem = MetricsSystem.createMetricsSystem("test", conf, securityMgr) metricsSystem.start() - val sources = PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sources")) + val sources = PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sourceToListeners")) val sinks = PrivateMethod[ArrayBuffer[Sink]](Symbol("sinks")) assert(metricsSystem.invokePrivate(sources()).size === StaticSources.allSources.length) diff --git a/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala b/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala index 449c56fc37c4..8d6bb10f5ed3 100644 --- a/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala +++ b/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala @@ -1029,7 +1029,7 @@ object testPackage extends Assertions { */ private object StreamingContextSuite extends PrivateMethodTester { private val _sources = - PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sources")) + PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sourceToListeners")) private def getSources(metricsSystem: MetricsSystem): mutable.HashMap[Source, MetricRegistryListener] = { metricsSystem.invokePrivate(_sources()) From 56706ff0a6643d3fc22380b83b3a6dec8bf72f8c Mon Sep 17 00:00:00 2001 From: Robert Kruszewski Date: Fri, 9 Oct 2020 00:00:41 +0100 Subject: [PATCH 3/3] better variable name --- .../org/apache/spark/metrics/MetricsSystem.scala | 12 ++++++------ .../apache/spark/metrics/MetricsSystemSuite.scala | 6 ++++-- .../spark/streaming/StreamingContextSuite.scala | 2 +- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/core/src/main/scala/org/apache/spark/metrics/MetricsSystem.scala b/core/src/main/scala/org/apache/spark/metrics/MetricsSystem.scala index 285a8bbe0276..b4917d9b0191 100644 --- a/core/src/main/scala/org/apache/spark/metrics/MetricsSystem.scala +++ b/core/src/main/scala/org/apache/spark/metrics/MetricsSystem.scala @@ -77,7 +77,7 @@ private[spark] class MetricsSystem private ( private[this] val metricsConfig = new MetricsConfig(conf) private val sinks = new mutable.ArrayBuffer[Sink] - private val sourceToListeners = new mutable.HashMap[Source, MetricRegistryListener] + private val sourcesWithListeners = new mutable.HashMap[Source, MetricRegistryListener] private var running: Boolean = false @@ -111,7 +111,7 @@ private[spark] class MetricsSystem private ( if (running) { sinks.foreach(_.stop) registry.removeMatching((_: String, _: Metric) => true) - sourceToListeners.keySet.foreach(removeSource) + sourcesWithListeners.keySet.foreach(removeSource) } else { logWarning("Stopping a MetricsSystem that is not running") } @@ -157,13 +157,13 @@ private[spark] class MetricsSystem private ( } def getSourcesByName(sourceName: String): Seq[Source] = - sourceToListeners.keySet.filter(_.sourceName == sourceName).toSeq + sourcesWithListeners.keySet.filter(_.sourceName == sourceName).toSeq def registerSource(source: Source): Unit = { try { val listener = new MetricsSystemListener(buildRegistryName(source)) source.metricRegistry.addListener(listener) - sourceToListeners += source -> listener + sourcesWithListeners += source -> listener } catch { case e: IllegalArgumentException => logInfo("Metrics already registered", e) } @@ -172,8 +172,8 @@ private[spark] class MetricsSystem private ( def removeSource(source: Source): Unit = { val regName = buildRegistryName(source) registry.removeMatching((name: String, _: Metric) => name.startsWith(regName)) - sourceToListeners.get(source).foreach(source.metricRegistry.removeListener) - sourceToListeners.remove(source) + sourcesWithListeners.get(source).foreach(source.metricRegistry.removeListener) + sourcesWithListeners.remove(source) } private def registerSources(): Unit = { diff --git a/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala b/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala index 32fcef8befde..3ff59aa2c244 100644 --- a/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala +++ b/core/src/test/scala/org/apache/spark/metrics/MetricsSystemSuite.scala @@ -43,7 +43,8 @@ class MetricsSystemSuite extends SparkFunSuite with BeforeAndAfter with PrivateM test("MetricsSystem with default config") { val metricsSystem = MetricsSystem.createMetricsSystem("default", conf, securityMgr) metricsSystem.start() - val sources = PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sourceToListeners")) + val sources = PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]]( + Symbol("sourcesWithListeners")) val sinks = PrivateMethod[ArrayBuffer[Sink]](Symbol("sinks")) assert(metricsSystem.invokePrivate(sources()).size === StaticSources.allSources.length) @@ -54,7 +55,8 @@ class MetricsSystemSuite extends SparkFunSuite with BeforeAndAfter with PrivateM test("MetricsSystem with sources add") { val metricsSystem = MetricsSystem.createMetricsSystem("test", conf, securityMgr) metricsSystem.start() - val sources = PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sourceToListeners")) + val sources = PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]]( + Symbol("sourcesWithListeners")) val sinks = PrivateMethod[ArrayBuffer[Sink]](Symbol("sinks")) assert(metricsSystem.invokePrivate(sources()).size === StaticSources.allSources.length) diff --git a/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala b/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala index 8d6bb10f5ed3..5e89d4b1abcc 100644 --- a/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala +++ b/streaming/src/test/scala/org/apache/spark/streaming/StreamingContextSuite.scala @@ -1029,7 +1029,7 @@ object testPackage extends Assertions { */ private object StreamingContextSuite extends PrivateMethodTester { private val _sources = - PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sourceToListeners")) + PrivateMethod[mutable.HashMap[Source, MetricRegistryListener]](Symbol("sourcesWithListeners")) private def getSources(metricsSystem: MetricsSystem): mutable.HashMap[Source, MetricRegistryListener] = { metricsSystem.invokePrivate(_sources())