You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by md...@apache.org on 2020/03/25 22:40:34 UTC
[lucene-solr] branch branch_8x updated: SOLR-14274 Do not register
multiple sets of JVM metrics (#1299)
This is an automated email from the ASF dual-hosted git repository.
mdrob pushed a commit to branch branch_8x
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git
The following commit(s) were added to refs/heads/branch_8x by this push:
new fe0e1d0 SOLR-14274 Do not register multiple sets of JVM metrics (#1299)
fe0e1d0 is described below
commit fe0e1d0b9d90d100cd919e20c0c78192b8ddf741
Author: Mike <ma...@users.noreply.github.com>
AuthorDate: Wed Mar 25 11:48:17 2020 -0700
SOLR-14274 Do not register multiple sets of JVM metrics (#1299)
---
.../cloud/autoscaling/sim/SimCloudManager.java | 12 ++++----
.../org/apache/solr/metrics/SolrMetricManager.java | 32 ++++++++++++++++++----
.../apache/solr/servlet/SolrDispatchFilter.java | 12 ++++----
.../apache/solr/metrics/SolrMetricManagerTest.java | 9 ++++--
4 files changed, 44 insertions(+), 21 deletions(-)
diff --git a/solr/core/src/java/org/apache/solr/cloud/autoscaling/sim/SimCloudManager.java b/solr/core/src/java/org/apache/solr/cloud/autoscaling/sim/SimCloudManager.java
index e270f1c..2b4c675 100644
--- a/solr/core/src/java/org/apache/solr/cloud/autoscaling/sim/SimCloudManager.java
+++ b/solr/core/src/java/org/apache/solr/cloud/autoscaling/sim/SimCloudManager.java
@@ -198,12 +198,12 @@ public class SimCloudManager implements SolrCloudManager {
// register common metrics
metricTag = Integer.toHexString(hashCode());
String registryName = SolrMetricManager.getRegistryName(SolrInfoBean.Group.jvm);
- metricManager.registerAll(registryName, new AltBufferPoolMetricSet(), true, "buffers");
- metricManager.registerAll(registryName, new ClassLoadingGaugeSet(), true, "classes");
- metricManager.registerAll(registryName, new OperatingSystemMetricSet(), true, "os");
- metricManager.registerAll(registryName, new GarbageCollectorMetricSet(), true, "gc");
- metricManager.registerAll(registryName, new MemoryUsageGaugeSet(), true, "memory");
- metricManager.registerAll(registryName, new ThreadStatesGaugeSet(), true, "threads"); // todo should we use CachedThreadStatesGaugeSet instead?
+ metricManager.registerAll(registryName, new AltBufferPoolMetricSet(), SolrMetricManager.ResolutionStrategy.REPLACE, "buffers");
+ metricManager.registerAll(registryName, new ClassLoadingGaugeSet(), SolrMetricManager.ResolutionStrategy.REPLACE, "classes");
+ metricManager.registerAll(registryName, new OperatingSystemMetricSet(), SolrMetricManager.ResolutionStrategy.REPLACE, "os");
+ metricManager.registerAll(registryName, new GarbageCollectorMetricSet(), SolrMetricManager.ResolutionStrategy.REPLACE, "gc");
+ metricManager.registerAll(registryName, new MemoryUsageGaugeSet(), SolrMetricManager.ResolutionStrategy.REPLACE, "memory");
+ metricManager.registerAll(registryName, new ThreadStatesGaugeSet(), SolrMetricManager.ResolutionStrategy.REPLACE, "threads"); // todo should we use CachedThreadStatesGaugeSet instead?
MetricsMap sysprops = new MetricsMap((detailed, map) -> {
System.getProperties().forEach((k, v) -> {
map.put(String.valueOf(k), v);
diff --git a/solr/core/src/java/org/apache/solr/metrics/SolrMetricManager.java b/solr/core/src/java/org/apache/solr/metrics/SolrMetricManager.java
index 977b0ca..e28bf32 100644
--- a/solr/core/src/java/org/apache/solr/metrics/SolrMetricManager.java
+++ b/solr/core/src/java/org/apache/solr/metrics/SolrMetricManager.java
@@ -523,25 +523,45 @@ public class SolrMetricManager {
}
/**
+ * Potential conflict resolution strategies when attempting to register a new metric that already exists
+ */
+ public enum ResolutionStrategy {
+ /**
+ * The existing metric will be kept and the new metric will be ignored
+ */
+ IGNORE,
+ /**
+ * The existing metric will be removed and replaced with the new metric
+ */
+ REPLACE,
+ /**
+ * An exception will be thrown. This is the default implementation behavior.
+ */
+ ERROR
+ }
+
+ /**
* Register all metrics in the provided {@link MetricSet}, optionally skipping those that
* already exist.
*
* @param registry registry name
* @param metrics metric set to register
- * @param force if true then already existing metrics with the same name will be replaced.
- * When false and a metric with the same name already exists an exception
- * will be thrown.
+ * @param strategy the conflict resolution strategy to use if the named metric already exists.
* @param metricPath (optional) additional top-most metric name path elements
* @throws Exception if a metric with this name already exists.
*/
- public void registerAll(String registry, MetricSet metrics, boolean force, String... metricPath) throws Exception {
+ public void registerAll(String registry, MetricSet metrics, ResolutionStrategy strategy, String... metricPath) throws Exception {
MetricRegistry metricRegistry = registry(registry);
synchronized (metricRegistry) {
Map<String, Metric> existingMetrics = metricRegistry.getMetrics();
for (Map.Entry<String, Metric> entry : metrics.getMetrics().entrySet()) {
String fullName = mkName(entry.getKey(), metricPath);
- if (force && existingMetrics.containsKey(fullName)) {
- metricRegistry.remove(fullName);
+ if (existingMetrics.containsKey(fullName)) {
+ if (strategy == ResolutionStrategy.REPLACE) {
+ metricRegistry.remove(fullName);
+ } else if (strategy == ResolutionStrategy.IGNORE) {
+ continue;
+ } // strategy == ERROR will fail when we try to register later
}
metricRegistry.register(fullName, entry.getValue());
}
diff --git a/solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java b/solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java
index 0f5f8d2..f812eb2 100644
--- a/solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java
+++ b/solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java
@@ -211,12 +211,12 @@ public class SolrDispatchFilter extends BaseSolrFilter {
registryName = SolrMetricManager.getRegistryName(SolrInfoBean.Group.jvm);
final Set<String> hiddenSysProps = coresInit.getConfig().getMetricsConfig().getHiddenSysProps();
try {
- metricManager.registerAll(registryName, new AltBufferPoolMetricSet(), true, "buffers");
- metricManager.registerAll(registryName, new ClassLoadingGaugeSet(), true, "classes");
- metricManager.registerAll(registryName, new OperatingSystemMetricSet(), true, "os");
- metricManager.registerAll(registryName, new GarbageCollectorMetricSet(), true, "gc");
- metricManager.registerAll(registryName, new MemoryUsageGaugeSet(), true, "memory");
- metricManager.registerAll(registryName, new ThreadStatesGaugeSet(), true, "threads"); // todo should we use CachedThreadStatesGaugeSet instead?
+ metricManager.registerAll(registryName, new AltBufferPoolMetricSet(), SolrMetricManager.ResolutionStrategy.IGNORE, "buffers");
+ metricManager.registerAll(registryName, new ClassLoadingGaugeSet(), SolrMetricManager.ResolutionStrategy.IGNORE, "classes");
+ metricManager.registerAll(registryName, new OperatingSystemMetricSet(), SolrMetricManager.ResolutionStrategy.IGNORE, "os");
+ metricManager.registerAll(registryName, new GarbageCollectorMetricSet(), SolrMetricManager.ResolutionStrategy.IGNORE, "gc");
+ metricManager.registerAll(registryName, new MemoryUsageGaugeSet(), SolrMetricManager.ResolutionStrategy.IGNORE, "memory");
+ metricManager.registerAll(registryName, new ThreadStatesGaugeSet(), SolrMetricManager.ResolutionStrategy.IGNORE, "threads"); // todo should we use CachedThreadStatesGaugeSet instead?
MetricsMap sysprops = new MetricsMap((detailed, map) -> {
System.getProperties().forEach((k, v) -> {
if (!hiddenSysProps.contains(k)) {
diff --git a/solr/core/src/test/org/apache/solr/metrics/SolrMetricManagerTest.java b/solr/core/src/test/org/apache/solr/metrics/SolrMetricManagerTest.java
index 95defcc..8cf977f 100644
--- a/solr/core/src/test/org/apache/solr/metrics/SolrMetricManagerTest.java
+++ b/solr/core/src/test/org/apache/solr/metrics/SolrMetricManagerTest.java
@@ -89,11 +89,14 @@ public class SolrMetricManagerTest extends SolrTestCaseJ4 {
String registryName = TestUtil.randomSimpleString(r, 1, 10);
assertEquals(0, metricManager.registry(registryName).getMetrics().size());
- metricManager.registerAll(registryName, mr, false);
+ // There is nothing registered so we should be error-free on the first pass
+ metricManager.registerAll(registryName, mr, SolrMetricManager.ResolutionStrategy.ERROR);
// this should simply skip existing names
- metricManager.registerAll(registryName, mr, true);
+ metricManager.registerAll(registryName, mr, SolrMetricManager.ResolutionStrategy.IGNORE);
+ // this should re-register everything, and no errors
+ metricManager.registerAll(registryName, mr, SolrMetricManager.ResolutionStrategy.REPLACE);
// this should produce error
- expectThrows(IllegalArgumentException.class, () -> metricManager.registerAll(registryName, mr, false));
+ expectThrows(IllegalArgumentException.class, () -> metricManager.registerAll(registryName, mr, SolrMetricManager.ResolutionStrategy.ERROR));
}
@Test