Micrometer metrics

bundle/pom.xml

@@ -37,6 +37,11 @@
       <artifactId>slf4j-api</artifactId>
       <optional>true</optional>
     </dependency>
+    <dependency>
+      <groupId>io.micrometer</groupId>
+      <artifactId>micrometer-core</artifactId>
+      <optional>true</optional>
+    </dependency>
     <dependency>
       <groupId>org.graalvm.nativeimage</groupId>
       <artifactId>svm</artifactId>

driver/pom.xml

@@ -37,6 +37,11 @@
     </dependency>
 
     <!-- Optional and / or provided dependencies -->
+    <dependency>
+      <groupId>io.micrometer</groupId>
+      <artifactId>micrometer-core</artifactId>
+      <optional>true</optional>
+    </dependency>
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>

driver/src/main/java/org/neo4j/driver/Config.java

@@ -18,10 +18,13 @@
  */
 package org.neo4j.driver;
 
+import io.micrometer.core.instrument.MeterRegistry;
+
 import java.io.File;
 import java.io.Serializable;
 import java.net.InetAddress;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Level;
 
@@ -32,6 +35,7 @@
 import org.neo4j.driver.internal.handlers.pulln.FetchSizeUtil;
 import org.neo4j.driver.internal.retry.RetrySettings;
 import org.neo4j.driver.net.ServerAddressResolver;
+import org.neo4j.driver.util.Experimental;
 import org.neo4j.driver.util.Immutable;
 
 import static java.lang.String.format;
@@ -95,6 +99,7 @@ public class Config implements Serializable
     private final boolean isMetricsEnabled;
     private final int eventLoopThreads;
     private final String userAgent;
+    private final MeterRegistry meterRegistry;
 
     private Config( ConfigBuilder builder )
     {
@@ -119,6 +124,7 @@ private Config( ConfigBuilder builder )
 
         this.eventLoopThreads = builder.eventLoopThreads;
         this.isMetricsEnabled = builder.isMetricsEnabled;
+        this.meterRegistry = builder.meterRegistry;
     }
 
     /**
@@ -259,6 +265,11 @@ public boolean isMetricsEnabled()
         return isMetricsEnabled;
     }
 
+    public Optional<MeterRegistry> meterRegistry()
+    {
+        return Optional.ofNullable( meterRegistry );
+    }
+
     /**
      * @return the user_agent configured for this driver
      */
@@ -289,6 +300,7 @@ public static class ConfigBuilder
         private boolean isMetricsEnabled = false;
         private long fetchSize = FetchSizeUtil.DEFAULT_FETCH_SIZE;
         private int eventLoopThreads = 0;
+        private MeterRegistry meterRegistry;
 
         private ConfigBuilder() {}
 
@@ -699,7 +711,8 @@ public ConfigBuilder withResolver( ServerAddressResolver resolver )
         }
 
         /**
-         * Enable driver metrics. The metrics can be obtained afterwards via {@link Driver#metrics()}.
+         * Enable driver metrics backed by internal basic implementation. The metrics can be obtained afterwards via {@link Driver#metrics()}.
+         *
          * @return this builder.
          */
         public ConfigBuilder withDriverMetrics()
@@ -708,6 +721,23 @@ public ConfigBuilder withDriverMetrics()
             return this;
         }
 
+        /**
+         * Enable driver metrics backed by Micrometer instrumentation. The metrics can be obtained afterwards via Micrometer means and {@link
+         * Driver#metrics()}.
+         * <p>
+         * You must have Micrometer on classpath to use this option.
+         *
+         * @param meterRegistry meter registry to register metrics with.
+         * @return this builder.
+         */
+        @Experimental
+        public ConfigBuilder withMicrometerDriverMetrics( MeterRegistry meterRegistry )
+        {
+            this.meterRegistry = Objects.requireNonNull( meterRegistry, "meterRegistry" );
+            this.isMetricsEnabled = true;
+            return this;
+        }
+
         /**
          * Disable driver metrics. When disabled, driver metrics cannot be accessed via {@link Driver#metrics()}.
          * @return this builder.

driver/src/main/java/org/neo4j/driver/ConnectionPoolMetrics.java

@@ -30,8 +30,9 @@
 public interface ConnectionPoolMetrics
 {
     /**
-     * An unique id that identifies this pool metrics.
-     * @return An unique name
+     * A unique id that identifies this pool metrics.
+     *
+     * @return A unique name
      */
     String id();
 
@@ -59,7 +60,7 @@ public interface ConnectionPoolMetrics
     /**
      * A counter to record how many connections have been successfully created with this pool since the pool is created.
      * This number increases every time when a connection is successfully created.
-     * @return The amount of connections have ever been created by this pool.
+     * @return The amount of connections has ever been created by this pool.
      */
     long created();
 

driver/src/main/java/org/neo4j/driver/internal/DriverFactory.java

@@ -44,6 +44,7 @@
 import org.neo4j.driver.internal.logging.NettyLogging;
 import org.neo4j.driver.internal.metrics.InternalMetricsProvider;
 import org.neo4j.driver.internal.metrics.MetricsProvider;
+import org.neo4j.driver.internal.metrics.MicrometerMetricsProvider;
 import org.neo4j.driver.internal.retry.ExponentialBackoffRetryLogic;
 import org.neo4j.driver.internal.retry.RetryLogic;
 import org.neo4j.driver.internal.retry.RetrySettings;
@@ -118,7 +119,9 @@ protected static MetricsProvider createDriverMetrics( Config config, Clock clock
     {
         if( config.isMetricsEnabled() )
         {
-            return new InternalMetricsProvider( clock, config.logging() );
+            return config.meterRegistry()
+                         .<MetricsProvider>map( MicrometerMetricsProvider::new )
+                         .orElseGet( () -> new InternalMetricsProvider( Clock.SYSTEM, config.logging() ) );
         }
         else
         {

driver/src/main/java/org/neo4j/driver/internal/metrics/ConnectionPoolMetricsListener.java

@@ -23,12 +23,12 @@ public interface ConnectionPoolMetricsListener
     /**
      * Invoked before a connection is creating.
      */
-    void beforeCreating( ListenerEvent listenerEvent );
+    void beforeCreating( ListenerEvent<?> listenerEvent );
 
     /**
      * Invoked after a connection is created successfully.
      */
-    void afterCreated( ListenerEvent listenerEvent );
+    void afterCreated( ListenerEvent<?> listenerEvent );
 
     /**
      * Invoked after a connection is failed to create due to timeout, any kind of error.
@@ -42,9 +42,10 @@ public interface ConnectionPoolMetricsListener
 
     /**
      * Invoked before acquiring or creating a connection.
+     *
      * @param acquireEvent
      */
-    void beforeAcquiringOrCreating( ListenerEvent acquireEvent );
+    void beforeAcquiringOrCreating( ListenerEvent<?> acquireEvent );
 
     /**
      * Invoked after a connection is being acquired or created regardless weather it is successful or not.
@@ -53,9 +54,10 @@ public interface ConnectionPoolMetricsListener
 
     /**
      * Invoked after a connection is acquired or created successfully.
+     *
      * @param acquireEvent
      */
-    void afterAcquiredOrCreated( ListenerEvent acquireEvent );
+    void afterAcquiredOrCreated( ListenerEvent<?> acquireEvent );
 
     /**
      * Invoked after it is timed out to acquire or create a connection.
@@ -64,26 +66,28 @@ public interface ConnectionPoolMetricsListener
 
     /**
      * After a connection is acquired from the pool.
+     *
      * @param inUseEvent
      */
-    void acquired( ListenerEvent inUseEvent );
+    void acquired( ListenerEvent<?> inUseEvent );
 
     /**
      * After a connection is released back to pool.
+     *
      * @param inUseEvent
      */
-    void released( ListenerEvent inUseEvent );
+    void released( ListenerEvent<?> inUseEvent );
 
     ConnectionPoolMetricsListener DEV_NULL_POOL_METRICS_LISTENER = new ConnectionPoolMetricsListener()
     {
         @Override
-        public void beforeCreating( ListenerEvent listenerEvent )
+        public void beforeCreating( ListenerEvent<?> listenerEvent )
         {
 
         }
 
         @Override
-        public void afterCreated( ListenerEvent listenerEvent )
+        public void afterCreated( ListenerEvent<?> listenerEvent )
         {
 
         }
@@ -101,7 +105,7 @@ public void afterClosed()
         }
 
         @Override
-        public void beforeAcquiringOrCreating( ListenerEvent acquireEvent )
+        public void beforeAcquiringOrCreating( ListenerEvent<?> acquireEvent )
         {
 
         }
@@ -113,7 +117,7 @@ public void afterAcquiringOrCreating()
         }
 
         @Override
-        public void afterAcquiredOrCreated( ListenerEvent acquireEvent )
+        public void afterAcquiredOrCreated( ListenerEvent<?> acquireEvent )
         {
 
         }
@@ -125,13 +129,13 @@ public void afterTimedOutToAcquireOrCreate()
         }
 
         @Override
-        public void acquired( ListenerEvent inUseEvent )
+        public void acquired( ListenerEvent<?> inUseEvent )
         {
 
         }
 
         @Override
-        public void released( ListenerEvent inUseEvent )
+        public void released( ListenerEvent<?> inUseEvent )
         {
 
         }

driver/src/main/java/org/neo4j/driver/internal/metrics/InternalAbstractMetrics.java

@@ -32,13 +32,13 @@ public abstract class InternalAbstractMetrics implements Metrics, MetricsListene
     {
 
         @Override
-        public void beforeCreating( String poolId, ListenerEvent creatingEvent )
+        public void beforeCreating( String poolId, ListenerEvent<?> creatingEvent )
         {
 
         }
 
         @Override
-        public void afterCreated( String poolId, ListenerEvent creatingEvent )
+        public void afterCreated( String poolId, ListenerEvent<?> creatingEvent )
         {
 
         }
@@ -56,7 +56,7 @@ public void afterClosed( String poolId )
         }
 
         @Override
-        public void beforeAcquiringOrCreating( String poolId, ListenerEvent acquireEvent )
+        public void beforeAcquiringOrCreating( String poolId, ListenerEvent<?> acquireEvent )
         {
 
         }
@@ -68,7 +68,7 @@ public void afterAcquiringOrCreating( String poolId )
         }
 
         @Override
-        public void afterAcquiredOrCreated( String poolId, ListenerEvent acquireEvent )
+        public void afterAcquiredOrCreated( String poolId, ListenerEvent<?> acquireEvent )
         {
 
         }
@@ -80,19 +80,19 @@ public void afterTimedOutToAcquireOrCreate( String poolId )
         }
 
         @Override
-        public void afterConnectionCreated( String poolId, ListenerEvent inUseEvent )
+        public void afterConnectionCreated( String poolId, ListenerEvent<?> inUseEvent )
         {
 
         }
 
         @Override
-        public void afterConnectionReleased( String poolId, ListenerEvent inUseEvent )
+        public void afterConnectionReleased( String poolId, ListenerEvent<?> inUseEvent )
         {
 
         }
 
         @Override
-        public ListenerEvent createListenerEvent()
+        public ListenerEvent<?> createListenerEvent()
         {
             return ListenerEvent.DEV_NULL_LISTENER_EVENT;
         }

driver/src/main/java/org/neo4j/driver/internal/metrics/InternalConnectionPoolMetrics.java

@@ -63,7 +63,7 @@ public class InternalConnectionPoolMetrics implements ConnectionPoolMetrics, Con
     }
 
     @Override
-    public void beforeCreating( ListenerEvent connEvent )
+    public void beforeCreating( ListenerEvent<?> connEvent )
     {
         creating.incrementAndGet();
         connEvent.start();
@@ -77,13 +77,13 @@ public void afterFailedToCreate()
     }
 
     @Override
-    public void afterCreated( ListenerEvent connEvent )
+    public void afterCreated( ListenerEvent<?> connEvent )
     {
         created.incrementAndGet();
         creating.decrementAndGet();
-        long elapsed = connEvent.elapsed();
+        long sample = ((TimeRecorderListenerEvent) connEvent).getSample();
 
-        totalConnectionTime.addAndGet( elapsed );
+        totalConnectionTime.addAndGet( sample );
     }
 
     @Override
@@ -93,7 +93,7 @@ public void afterClosed()
     }
 
     @Override
-    public void beforeAcquiringOrCreating( ListenerEvent acquireEvent )
+    public void beforeAcquiringOrCreating( ListenerEvent<?> acquireEvent )
     {
         acquireEvent.start();
         acquiring.incrementAndGet();
@@ -106,12 +106,12 @@ public void afterAcquiringOrCreating()
     }
 
     @Override
-    public void afterAcquiredOrCreated( ListenerEvent acquireEvent )
+    public void afterAcquiredOrCreated( ListenerEvent<?> acquireEvent )
     {
         acquired.incrementAndGet();
-        long elapsed = acquireEvent.elapsed();
+        long sample = ((TimeRecorderListenerEvent) acquireEvent).getSample();
 
-        totalAcquisitionTime.addAndGet( elapsed );
+        totalAcquisitionTime.addAndGet( sample );
     }
 
     @Override
@@ -121,18 +121,18 @@ public void afterTimedOutToAcquireOrCreate()
     }
 
     @Override
-    public void acquired( ListenerEvent inUseEvent )
+    public void acquired( ListenerEvent<?> inUseEvent )
     {
         inUseEvent.start();
     }
 
     @Override
-    public void released( ListenerEvent inUseEvent )
+    public void released( ListenerEvent<?> inUseEvent )
     {
         totalInUseCount.incrementAndGet();
-        long elapsed = inUseEvent.elapsed();
+        long sample = ((TimeRecorderListenerEvent) inUseEvent).getSample();
 
-        totalInUseTime.addAndGet( elapsed );
+        totalInUseTime.addAndGet( sample );
     }
 
     @Override