feat: initial PoC for micrometer integration

Author: metacosm

operator-framework-core/pom.xml

@@ -19,6 +19,7 @@
     <java.version>11</java.version>
     <maven.compiler.source>11</maven.compiler.source>
     <maven.compiler.target>11</maven.compiler.target>
+    <micrometer-core.version>1.7.3</micrometer-core.version>
   </properties>
 
   <build>
@@ -94,5 +95,10 @@
       <version>3.20.2</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>io.micrometer</groupId>
+      <artifactId>micrometer-core</artifactId>
+      <version>${micrometer-core.version}</version>
+    </dependency>
   </dependencies>
 </project>

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Metrics.java

@@ -0,0 +1,111 @@
+package io.javaoperatorsdk.operator;
+
+import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.api.Context;
+import io.javaoperatorsdk.operator.api.ResourceController;
+import io.javaoperatorsdk.operator.api.UpdateControl;
+import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
+import io.micrometer.core.instrument.*;
+import io.micrometer.core.instrument.distribution.DistributionStatisticConfig;
+import io.micrometer.core.instrument.distribution.pause.PauseDetector;
+import io.micrometer.core.instrument.noop.*;
+import java.util.concurrent.TimeUnit;
+import java.util.function.ToDoubleFunction;
+import java.util.function.ToLongFunction;
+
+public class Metrics {
+  public static final Metrics NOOP = new Metrics(new NoopMeterRegistry(Clock.SYSTEM));
+  private final MeterRegistry registry;
+
+  public Metrics(MeterRegistry registry) {
+    this.registry = registry;
+  }
+
+  public <R extends CustomResource> UpdateControl<R> timeControllerCreateOrUpdate(
+      ResourceController<R> controller,
+      ControllerConfiguration<R> configuration,
+      R resource,
+      Context<R> context) {
+    //  todo: https://github.com/java-operator-sdk/java-operator-sdk/issues/496 would simplify
+    // things
+    final var name = configuration.getName();
+    final var timer = registry.timer("operator.sdk.controllers.execution.createOrUpdate", name);
+    try {
+      final var result = timer.record(() -> controller.createOrUpdateResource(resource, context));
+      String successType = "cr";
+      if (result.isUpdateStatusSubResource()) {
+        successType = "status";
+      }
+      if (result.isUpdateCustomResourceAndStatusSubResource()) {
+        successType = "both";
+      }
+      registry.counter("operator.sdk.controllers.execution.success", name, successType);
+      return result;
+    } catch (Exception e) {
+      registry.counter(
+          "operator.sdk.controllers.execution.failure", name, e.getClass().getSimpleName());
+      throw e;
+    }
+  }
+
+  private static class NoopMeterRegistry extends MeterRegistry {
+    protected NoopMeterRegistry(Clock clock) {
+      super(clock);
+    }
+
+    @Override
+    protected <T> Gauge newGauge(Meter.Id id, T t, ToDoubleFunction<T> toDoubleFunction) {
+      return new NoopGauge(id);
+    }
+
+    @Override
+    protected Counter newCounter(Meter.Id id) {
+      return new NoopCounter(id);
+    }
+
+    @Override
+    protected Timer newTimer(
+        Meter.Id id,
+        DistributionStatisticConfig distributionStatisticConfig,
+        PauseDetector pauseDetector) {
+      return new NoopTimer(id);
+    }
+
+    @Override
+    protected DistributionSummary newDistributionSummary(
+        Meter.Id id, DistributionStatisticConfig distributionStatisticConfig, double v) {
+      return new NoopDistributionSummary(id);
+    }
+
+    @Override
+    protected Meter newMeter(Meter.Id id, Meter.Type type, Iterable<Measurement> iterable) {
+      return new NoopMeter(id);
+    }
+
+    @Override
+    protected <T> FunctionTimer newFunctionTimer(
+        Meter.Id id,
+        T t,
+        ToLongFunction<T> toLongFunction,
+        ToDoubleFunction<T> toDoubleFunction,
+        TimeUnit timeUnit) {
+      return new NoopFunctionTimer(id);
+    }
+
+    @Override
+    protected <T> FunctionCounter newFunctionCounter(
+        Meter.Id id, T t, ToDoubleFunction<T> toDoubleFunction) {
+      return new NoopFunctionCounter(id);
+    }
+
+    @Override
+    protected TimeUnit getBaseTimeUnit() {
+      return TimeUnit.SECONDS;
+    }
+
+    @Override
+    protected DistributionStatisticConfig defaultHistogramConfig() {
+      return DistributionStatisticConfig.NONE;
+    }
+  }
+}

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -25,18 +25,25 @@ public class Operator implements AutoCloseable {
   private final Object lock;
   private final List<ControllerRef> controllers;
   private volatile boolean started;
+  private final Metrics metrics;
 
-  public Operator(KubernetesClient k8sClient, ConfigurationService configurationService) {
+  public Operator(
+      KubernetesClient k8sClient, ConfigurationService configurationService, Metrics metrics) {
     this.k8sClient = k8sClient;
     this.configurationService = configurationService;
     this.closeables = new ArrayList<>();
     this.lock = new Object();
     this.controllers = new ArrayList<>();
     this.started = false;
+    this.metrics = metrics;
 
     Runtime.getRuntime().addShutdownHook(new Thread(this::close));
   }
 
+  public Operator(KubernetesClient k8sClient, ConfigurationService configurationService) {
+    this(k8sClient, configurationService, Metrics.NOOP);
+  }
+
   public KubernetesClient getKubernetesClient() {
     return k8sClient;
   }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.fabric8.kubernetes.client.Config;
 import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.Metrics;
 import io.javaoperatorsdk.operator.api.ResourceController;
 import java.util.Set;
 
@@ -91,4 +92,8 @@ default ObjectMapper getObjectMapper() {
   default int getTerminationTimeoutSeconds() {
     return DEFAULT_TERMINATION_TIMEOUT_SECONDS;
   }
+
+  default Metrics getMetrics() {
+    return Metrics.NOOP;
+  }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/EventDispatcher.java

@@ -122,7 +122,11 @@ private PostExecutionControl handleCreateOrUpdate(
           getName(resource),
           getVersion(resource),
           executionScope);
-      UpdateControl<R> updateControl = controller.createOrUpdateResource(resource, context);
+      UpdateControl<R> updateControl =
+          configuration
+              .getConfigurationService()
+              .getMetrics()
+              .timeControllerCreateOrUpdate(controller, configuration, resource, context);
       R updatedCustomResource = null;
       if (updateControl.isUpdateCustomResourceAndStatusSubResource()) {
         updatedCustomResource = updateCustomResource(updateControl.getCustomResource());

operator-framework/src/test/java/io/javaoperatorsdk/operator/IntegrationTestSupport.java

@@ -22,6 +22,9 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.concurrent.TimeUnit;
+
+import io.micrometer.core.instrument.composite.CompositeMeterRegistry;
+import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -61,7 +64,7 @@ public void initialize(KubernetesClient k8sClient, ResourceController controller
       namespaces.create(
           new NamespaceBuilder().withNewMetadata().withName(TEST_NAMESPACE).endMetadata().build());
     }
-    operator = new Operator(k8sClient, configurationService);
+    operator = new Operator(k8sClient, configurationService, Metrics.NOOP);
     final var overriddenConfig =
         ControllerConfigurationOverrider.override(config).settingNamespace(TEST_NAMESPACE);
     if (retry != null) {