Introducing Performance Loggers

src/main/java/com/microsoft/sqlserver/jdbc/PerformanceActivity.java

@@ -0,0 +1,31 @@
+/*
+ * Microsoft JDBC Driver for SQL Server Copyright(c) Microsoft Corporation All rights reserved. This program is made
+ * available under the terms of the MIT License. See the LICENSE file in the project root for more information.
+ */
+
+package com.microsoft.sqlserver.jdbc;
+
+/**
+ * Enum representing different performance activities.
+ */
+public enum PerformanceActivity {
+    CONNECTION("Connection"),
+    TOKEN_ACQUISITION("Token acquisition"),
+    LOGIN("Login"),
+    PRELOGIN("Prelogin");
+
+    private final String activity;
+
+    PerformanceActivity(String activity) {
+        this.activity = activity;
+    }
+
+    public String activity() {
+        return activity;
+    }
+
+    @Override
+    public String toString() {
+        return activity;
+    }
+}

src/main/java/com/microsoft/sqlserver/jdbc/PerformanceLog.java

@@ -0,0 +1,101 @@
+/*
+ * Microsoft JDBC Driver for SQL Server Copyright(c) Microsoft Corporation All rights reserved. This program is made
+ * available under the terms of the MIT License. See the LICENSE file in the project root for more information.
+ */
+
+package com.microsoft.sqlserver.jdbc;
+
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+class PerformanceLog {
+
+    static final java.util.logging.Logger perfLoggerConnection = java.util.logging.Logger
+            .getLogger("com.microsoft.sqlserver.jdbc.PerformanceMetrics.Connection");
+
+    private static PerformanceLogCallback callback;
+    private static boolean callbackInitialized = false;
+
+    /**
+     * Register a callback for performance log events.
+     *
+     * @param cb The callback to register.
+     */
+    public static synchronized void registerCallback(PerformanceLogCallback cb) {
+        if (callbackInitialized) {
+            throw new IllegalStateException("Callback has already been set");
+        }
+        callback = cb;
+        callbackInitialized = true;
+    }
+
+    /**
+     * Unregister the callback for performance log events.
+     */
+    public static synchronized void unregisterCallback() {
+        callback = null;
+        callbackInitialized = false;
+    }
+
+    //TODO
+    //More loggers to be added here e.g. com.microsoft.sqlserver.jdbc.PerformanceMetrics.Statement
+
+    public static class Scope implements AutoCloseable {
+        private Logger logger;
+        private String logPrefix;
+        private PerformanceActivity activity;
+        private long startTime;
+        private final boolean enabled;
+
+        private Exception exception;
+
+        public Scope(Logger logger, String logPrefix, PerformanceActivity activity) {
+
+            // Check if logging is enabled
+            this.enabled = logger.isLoggable(Level.INFO) || (callback != null);
+
+            if (enabled) {
+                this.logger = logger;
+                this.logPrefix = logPrefix;
+                this.activity = activity;
+                this.startTime = System.currentTimeMillis();
+            }
+        }
+
+        public void setException(Exception e) {
+            this.exception = e;
+        }
+
+        @Override
+        public void close() {
+
+            if (!enabled) {
+                return;
+            }
+
+            long endTime = System.currentTimeMillis();
+            long duration = endTime - startTime;
+
+            if (callback != null) {
+                try {
+                    callback.publish(duration, activity, exception);
+                } catch (Exception e) {
+                    logger.info(String.format("Failed to publish performance log: %s", e.getMessage()));
+                }
+            }
+
+            if (logger != null && logger.isLoggable(Level.INFO)) {
+                if (exception != null) {
+                    logger.info(String.format("%s %s, duration: %dms, exception: %s", logPrefix, activity, duration, exception.getMessage()));
+                } else {
+                    logger.info(String.format("%s %s, duration: %dms", logPrefix, activity, duration));
+                }
+            }
+
+        }
+    }
+
+    public static Scope createScope(Logger logger, String logPrefix, PerformanceActivity activity) {
+        return new Scope(logger, logPrefix, activity);
+    }
+}

src/main/java/com/microsoft/sqlserver/jdbc/PerformanceLogCallback.java

@@ -0,0 +1,22 @@
+/*
+ * Microsoft JDBC Driver for SQL Server Copyright(c) Microsoft Corporation All rights reserved. This program is made
+ * available under the terms of the MIT License. See the LICENSE file in the project root for more information.
+ */
+
+package com.microsoft.sqlserver.jdbc;
+
+/**
+ * Callback interface for publishing performance logs.
+ */
+public interface PerformanceLogCallback {
+
+    /**
+     * Publish a performance log entry.
+     *
+     * @param durationMs      The duration of the operation in milliseconds.
+     * @param activity        The type of activity being logged.
+     * @param exception       An exception, if an error occurred.
+     */
+    void publish(long durationMs, PerformanceActivity activity, Exception exception) throws Exception;
+
+}