/azp run

Codecov Report

❌ Patch coverage is 79.50820% with 50 lines in your changes missing coverage. Please review.
✅ Project coverage is 60.68%. Comparing base (26c55e1) to head (efc53e4).
⚠️ Report is 2 commits behind head on main.

@@             Coverage Diff              @@
##               main    #2885      +/-   ##
============================================
+ Coverage     60.55%   60.68%   +0.13%     
- Complexity     4887     4904      +17     
============================================
  Files           151      151              
  Lines         34827    34936     +109     
  Branches       5834     5837       +3     
============================================
+ Hits          21088    21201     +113     
- Misses        10907    10908       +1     
+ Partials       2832     2827       -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

OK, the log output works for log level FINE. But is there another way/API to get thse values? Because we don't want to set our log level to FINE and browse endloss log files. Instead we want to "listen" to these metrics, inspect them and check if specific value thresholds are hit to create our own log events (to specific metric systems).
Is there such an API, Interface, Listerm Handler?

Hi @JDBC-0
FINE-level logging is not required. The driver already provides a programmatic callback API for exactly this use case.

Register a PerformanceLogCallback to receive metrics in-process — no log files involved:
(This is just a sample example)

SQLServerDriver.registerPerformanceLogCallback(new PerformanceLogCallback() {
    @Override
    public void publish(PerformanceActivity activity, int connectionId,
                        long durationMs, Exception exception) {
        // Connection-level metrics (CONNECTION, PRELOGIN, LOGIN, TOKEN_ACQUISITION)
        if (durationMs > 500) {
            myMetrics.record("jdbc.connection." + activity, durationMs);
        }
    }

    @Override
    public void publish(PerformanceActivity activity, int connectionId,
                        int statementId, long durationMs, Exception exception) {
        // Statement-level metrics (REQUEST_BUILD, FIRST_SERVER_RESPONSE, EXECUTE, etc.)
        if (durationMs > 200) {
            myAlertSystem.warn("Slow op: conn=" + connectionId
                + " stmt=" + statementId + " " + activity + " " + durationMs + "ms");
        }
    }
});

The callback fires independently of the log level — it's triggered whenever a performance scope closes, as long as a callback is registered. You get the activity type, connection/statement IDs, duration in ms, and any exception — everything you need to apply threshold checks and forward to your own metrics/alerting system.

To unregister later: SQLServerDriver.unregisterPerformanceLogCallback().

For more info, you can refer to: Performance logger and callback

That's great to have an API, but this PerformanceActivity just has numeric statementId so the result

JDBC performance (ConId: 9, StmtId: 128) 'First server response': 8507 ms

is unreadable/unusable because the statement name is missing. How can I know what "statement 128" is?

It would be great to have the statement as a "readable" name (with parameter values, if possible).

@JDBC-0 ,
The callback is invoked synchronously on the same application thread that executed the statement — not on a background thread. So the application already has full context about which SQL triggered the callback at the point it's received, and can make out what it executed to receive these callback metrics.

Hm, what IDs are thes: ConnectionId, statementId? On the application context I don't have any access when I call a JDBC statement .... only statements with a resultsset might have such metainformation somewhere hidden in the JDBC driver API. So how can you get/inspect a "statementId" that is set in the PerformanceAcrtivity? The whole idea of this is to have a single point of configuration to get this info, e.g.:

    static {

    	//#31980: register MS SQL JDBC driver "PerformanceLogCallback" to listen to performance metrics:
        try {
            SQLServerDriver.registerPerformanceLogCallback(new PerformanceLogCallback() {
                @Override
                public void publish(PerformanceActivity activity, int connectionId, long durationMs, Exception exception) {
                    if (durationMs > 60_000L) { //longer than 1 minute?
                        logPerf(activity, connectionId, -1, durationMs, exception);
                    }
                }

                @Override
                public void publish(PerformanceActivity activity, int connectionId, int statementId, long durationMs, Exception exception) {
                    if (durationMs > 60_000L) { //longer than 1 minute?
                        logPerf(activity, connectionId, statementId, durationMs, exception);
                    }
                }

                private void logPerf(PerformanceActivity activity, int connId, int stmtId, long ms, Exception ex) {
                    final String msg = String.format("JDBC performance (ConId: %d, StmtId: %d) '%s': %d ms", connId, stmtId, activity, ms);
                    LOGGER.log(Level.WARNING, msg, ex);
                }
            });
        } catch (Throwable t) {
            LOGGER.config("Could not register MS-SQL Performance Callback: " + t.getMessage());
        }

    }//end of static

And this has no context to the generig threads of the applications that concurrently call misc JDBC methods. The only workaround I can think of is to samehow "get" this driver internal statementId when the statement is created, build an internal HashMap to store these and when the PerformanceLogCallback triggers, I could read this global HashMap to get information from it ... which would be possible within the driver itself, too.

I tried write such a global hashmap but I can't get the internal ID (statementId) from com.microsoft.sqlserver.jdbc.SQLServerStatement - there is no public method to read it! (getStatementID() is not public)