Remove Vert.x dependency from MicrometerMetricsProvider (strimzi#9879)

Signed-off-by: Jakub Scholz <[email protected]>
fvaleri · Mar 27, 2024 · 179ad17 · 179ad17
1 parent 02f61d4
commit 179ad17
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 26 deletions.
diff --git a/cluster-operator/src/main/java/io/strimzi/operator/cluster/Main.java b/cluster-operator/src/main/java/io/strimzi/operator/cluster/Main.java
@@ -34,6 +34,7 @@
 import io.vertx.core.http.HttpServer;
 import io.vertx.micrometer.MicrometerMetricsOptions;
 import io.vertx.micrometer.VertxPrometheusOptions;
+import io.vertx.micrometer.backends.BackendRegistries;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
@@ -90,7 +91,7 @@ public static void main(String[] args) {
         shutdownHook.register(() -> ShutdownHook.shutdownVertx(vertx, SHUTDOWN_TIMEOUT));
 
         // Setup Micrometer Metrics provider
-        MetricsProvider metricsProvider = new MicrometerMetricsProvider();
+        MetricsProvider metricsProvider = new MicrometerMetricsProvider(BackendRegistries.getDefaultNow());
         KubernetesClient client = new OperatorKubernetesClientBuilder("strimzi-cluster-operator", strimziVersion).build();
 
         maybeCreateClusterRoles(vertx, config, client)

diff --git a/...tor/src/test/java/io/strimzi/operator/cluster/operator/assembly/AbstractOperatorTest.java b/...tor/src/test/java/io/strimzi/operator/cluster/operator/assembly/AbstractOperatorTest.java
@@ -25,6 +25,7 @@
 import io.vertx.junit5.Checkpoint;
 import io.vertx.junit5.VertxExtension;
 import io.vertx.junit5.VertxTestContext;
+import io.vertx.micrometer.backends.BackendRegistries;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -63,7 +64,7 @@ public static void after() {
     void testWithLockCallableSuccessfulReleasesLock(VertxTestContext context) {
         var resourceOperator = new DefaultWatchableStatusedResourceOperator<>(vertx, null, "TestResource");
         @SuppressWarnings({ "unchecked", "rawtypes" })
-        var target = new DefaultOperator(vertx, "Test", resourceOperator, new MicrometerMetricsProvider(), null);
+        var target = new DefaultOperator(vertx, "Test", resourceOperator, new MicrometerMetricsProvider(BackendRegistries.getDefaultNow()), null);
         Reconciliation reconciliation = new Reconciliation("test", "TestResource", "my-namespace", "my-resource");
         String lockName = target.getLockName(reconciliation);
 
@@ -96,7 +97,7 @@ void testWithLockCallableSuccessfulReleasesLock(VertxTestContext context) {
     void testWithLockCallableHandledExceptionReleasesLock(VertxTestContext context) {
         var resourceOperator = new DefaultWatchableStatusedResourceOperator<>(vertx, null, "TestResource");
         @SuppressWarnings({ "unchecked", "rawtypes" })
-        var target = new DefaultOperator(vertx, "Test", resourceOperator, new MicrometerMetricsProvider(), null);
+        var target = new DefaultOperator(vertx, "Test", resourceOperator, new MicrometerMetricsProvider(BackendRegistries.getDefaultNow()), null);
         Reconciliation reconciliation = new Reconciliation("test", "TestResource", "my-namespace", "my-resource");
         String lockName = target.getLockName(reconciliation);
 
@@ -131,7 +132,7 @@ void testWithLockCallableHandledExceptionReleasesLock(VertxTestContext context)
     void testWithLockCallableUnhandledExceptionReleasesLock(VertxTestContext context) {
         var resourceOperator = new DefaultWatchableStatusedResourceOperator<>(vertx, null, "TestResource");
         @SuppressWarnings({ "unchecked", "rawtypes" })
-        var target = new DefaultOperator(vertx, "Test", resourceOperator, new MicrometerMetricsProvider(), null);
+        var target = new DefaultOperator(vertx, "Test", resourceOperator, new MicrometerMetricsProvider(BackendRegistries.getDefaultNow()), null);
         Reconciliation reconciliation = new Reconciliation("test", "TestResource", "my-namespace", "my-resource");
         String lockName = target.getLockName(reconciliation);
 
@@ -169,7 +170,7 @@ void testWithLockCallableUnhandledExceptionReleasesLock(VertxTestContext context
     void testWithLockFailHandlerUnhandledExceptionReleasesLock(VertxTestContext context) {
         var resourceOperator = new DefaultWatchableStatusedResourceOperator<>(vertx, null, "TestResource");
         @SuppressWarnings({ "unchecked", "rawtypes" })
-        var target = new DefaultOperator(vertx, "Test", resourceOperator, new MicrometerMetricsProvider(), null);
+        var target = new DefaultOperator(vertx, "Test", resourceOperator, new MicrometerMetricsProvider(BackendRegistries.getDefaultNow()), null);
         Reconciliation reconciliation = new Reconciliation("test", "TestResource", "my-namespace", "my-resource");
         String lockName = target.getLockName(reconciliation);
 

diff --git a/...perator/src/test/java/io/strimzi/operator/cluster/operator/assembly/KafkaConnectorIT.java b/...perator/src/test/java/io/strimzi/operator/cluster/operator/assembly/KafkaConnectorIT.java
@@ -36,6 +36,7 @@
 import io.vertx.junit5.VertxTestContext;
 import io.vertx.micrometer.MicrometerMetricsOptions;
 import io.vertx.micrometer.VertxPrometheusOptions;
+import io.vertx.micrometer.backends.BackendRegistries;
 import org.hamcrest.CoreMatchers;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.AfterEach;
@@ -143,7 +144,7 @@ public void testConnectorNotUpdatedWhenConfigUnchanged(VertxTestContext context)
         KafkaConnector connector = createKafkaConnector(namespace, connectorName, false, config);
         Crds.kafkaConnectorOperation(client).inNamespace(namespace).resource(connector).create();
 
-        MetricsProvider metrics = new MicrometerMetricsProvider();
+        MetricsProvider metrics = new MicrometerMetricsProvider(BackendRegistries.getDefaultNow());
         ResourceOperatorSupplier ros = new ResourceOperatorSupplier(vertx, client,
                 new ZookeeperLeaderFinder(vertx,
                         // Retry up to 3 times (4 attempts), with overall max delay of 35000ms
@@ -213,7 +214,7 @@ public void testConnectorResourceNotReadyWhenConnectorFailed(VertxTestContext co
         KafkaConnector connector = createKafkaConnector(namespace, connectorName, false, config);
         Crds.kafkaConnectorOperation(client).inNamespace(namespace).resource(connector).create();
 
-        MetricsProvider metrics = new MicrometerMetricsProvider();
+        MetricsProvider metrics = new MicrometerMetricsProvider(BackendRegistries.getDefaultNow());
         ResourceOperatorSupplier ros = new ResourceOperatorSupplier(vertx, client,
                 new ZookeeperLeaderFinder(vertx,
                         // Retry up to 3 times (4 attempts), with overall max delay of 35000ms
@@ -262,7 +263,7 @@ public void testConnectorResourceNotReadyWhenTaskFailed(VertxTestContext context
         KafkaConnector connector = createKafkaConnector(namespace, connectorName, false, config);
         Crds.kafkaConnectorOperation(client).inNamespace(namespace).resource(connector).create();
 
-        MetricsProvider metrics = new MicrometerMetricsProvider();
+        MetricsProvider metrics = new MicrometerMetricsProvider(BackendRegistries.getDefaultNow());
         ResourceOperatorSupplier ros = new ResourceOperatorSupplier(vertx, client,
                 new ZookeeperLeaderFinder(vertx,
                         // Retry up to 3 times (4 attempts), with overall max delay of 35000ms
@@ -322,7 +323,7 @@ public void testConnectorIsAutoRestarted(VertxTestContext context) {
         KafkaConnector connector = createKafkaConnector(namespace, connectorName, true, config);
         Crds.kafkaConnectorOperation(client).inNamespace(namespace).resource(connector).create();
 
-        MetricsProvider metrics = new MicrometerMetricsProvider();
+        MetricsProvider metrics = new MicrometerMetricsProvider(BackendRegistries.getDefaultNow());
         ResourceOperatorSupplier ros = new ResourceOperatorSupplier(vertx, client,
             new ZookeeperLeaderFinder(vertx,
                 // Retry up to 3 times (4 attempts), with overall max delay of 35000ms
@@ -371,7 +372,7 @@ public void testTaskIsAutoRestarted(VertxTestContext context) {
         KafkaConnector connector = createKafkaConnector(namespace, connectorName, true, config);
         Crds.kafkaConnectorOperation(client).inNamespace(namespace).resource(connector).create();
 
-        MetricsProvider metrics = new MicrometerMetricsProvider();
+        MetricsProvider metrics = new MicrometerMetricsProvider(BackendRegistries.getDefaultNow());
         ResourceOperatorSupplier ros = new ResourceOperatorSupplier(vertx, client,
             new ZookeeperLeaderFinder(vertx,
                 // Retry up to 3 times (4 attempts), with overall max delay of 35000ms
@@ -501,7 +502,7 @@ private void assertConnectorIsAutoRestarted(VertxTestContext context, Kubernetes
             JsonObject connectorStatus = new JsonObject(kafkaConnector.getStatus().getConnectorStatus());
             assertThat(connectorStatus.getJsonObject("connector"), notNullValue());
             assertThat(connectorStatus.getJsonObject("connector").getString("state"), is("RESTARTING"));
-            MetricsProvider metrics = new MicrometerMetricsProvider();
+            MetricsProvider metrics = new MicrometerMetricsProvider(BackendRegistries.getDefaultNow());
             MeterRegistry registry = metrics.meterRegistry();
             assertThat(registry.get(AbstractOperator.METRICS_PREFIX + "auto.restarts").tag("kind", KafkaConnector.RESOURCE_KIND).counter().count(), CoreMatchers.is(1.0));
         });
@@ -522,7 +523,7 @@ private void assertTaskIsAutoRestarted(VertxTestContext context, KubernetesClien
             assertThat(connectorStatus.getJsonArray("tasks"), notNullValue());
             assertThat(connectorStatus.getJsonArray("tasks").size(), is(1));
             assertThat(connectorStatus.getJsonArray("tasks").getJsonObject(0).getString("state"), is("RESTARTING"));
-            MetricsProvider metrics = new MicrometerMetricsProvider();
+            MetricsProvider metrics = new MicrometerMetricsProvider(BackendRegistries.getDefaultNow());
             MeterRegistry registry = metrics.meterRegistry();
             assertThat(registry.get(AbstractOperator.METRICS_PREFIX + "auto.restarts").tag("kind", KafkaConnector.RESOURCE_KIND).counter().count(), CoreMatchers.is(1.0));
         });

diff --git a/...ator/src/test/java/io/strimzi/operator/cluster/operator/assembly/OperatorMetricsTest.java b/...ator/src/test/java/io/strimzi/operator/cluster/operator/assembly/OperatorMetricsTest.java
@@ -30,6 +30,7 @@
 import io.vertx.junit5.VertxTestContext;
 import io.vertx.micrometer.MicrometerMetricsOptions;
 import io.vertx.micrometer.VertxPrometheusOptions;
+import io.vertx.micrometer.backends.BackendRegistries;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -486,7 +487,7 @@ public void testReconcileAllOverMultipleNamespaces(VertxTestContext context)  {
      * @return  Clean MetricsProvider
      */
     public MetricsProvider createCleanMetricsProvider() {
-        MetricsProvider metrics = new MicrometerMetricsProvider();
+        MetricsProvider metrics = new MicrometerMetricsProvider(BackendRegistries.getDefaultNow());
         MeterRegistry registry = metrics.meterRegistry();
 
         registry.forEachMeter(registry::remove);

diff --git a/operator-common/pom.xml b/operator-common/pom.xml
@@ -187,11 +187,6 @@
             <groupId>io.micrometer</groupId>
             <artifactId>micrometer-registry-prometheus</artifactId>
         </dependency>
-        <dependency>
-            <groupId>io.vertx</groupId>
-            <artifactId>vertx-micrometer-metrics</artifactId>
-            <optional>true</optional>
-        </dependency>
         <dependency>
             <groupId>io.strimzi</groupId>
             <artifactId>mockkube</artifactId>

diff --git a/operator-common/src/main/java/io/strimzi/operator/common/MicrometerMetricsProvider.java b/operator-common/src/main/java/io/strimzi/operator/common/MicrometerMetricsProvider.java
@@ -9,7 +9,6 @@
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Tags;
 import io.micrometer.core.instrument.Timer;
-import io.vertx.micrometer.backends.BackendRegistries;
 
 import java.time.Duration;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -20,13 +19,6 @@
 public class MicrometerMetricsProvider implements MetricsProvider {
     protected final MeterRegistry metrics;
 
-    /**
-     * Constructor of the Micrometer metrics provider which uses the Vert.x provided metrics registry
-     */
-    public MicrometerMetricsProvider() {
-        this.metrics = BackendRegistries.getDefaultNow();
-    }
-
     /**
      * Constructor of the Micrometer metrics provider.
      *