MCP-272 Introduce elevated logging

[eray-felek-sonarsource]

No description provided.

[hashicorp-vault-sonar-prod]

MCP-272

[Copilot]

Pull request overview

This PR introduces elevated debug logging controlled by the SONARQUBE_ELEVATED_DEBUG environment variable or system property. This feature helps diagnose HTTP communication and tool execution issues by outputting detailed logs to stderr when enabled.

Changes:

• Added McpLogger.debugElevated() and isElevatedDebugEnabled() methods that check for the SONARQUBE_ELEVATED_DEBUG flag
• Implemented LoggingHttpClient decorator to log HTTP request/response details (URL, timing, status, body)
• Enhanced error handling in ServerApiHelper and ToolExecutor to log additional diagnostic information
• Added configuration logging in HttpClientProvider and SonarQubeMcpServer to output connection settings at startup

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/main/java/org/sonarsource/sonarqube/mcp/log/McpLogger.java	Adds elevated debug logging support with environment/property check
src/main/java/org/sonarsource/sonarqube/mcp/http/LoggingHttpClient.java	New decorator that logs HTTP operations when elevated debug is enabled
src/main/java/org/sonarsource/sonarqube/mcp/http/HttpClientProvider.java	Wraps HTTP clients with logging decorator and exposes connection settings logging
src/main/java/org/sonarsource/sonarqube/mcp/serverapi/ServerApiHelper.java	Logs HTTP error details and refactors response body parsing
src/main/java/org/sonarsource/sonarqube/mcp/tools/ToolExecutor.java	Logs tool execution start, end, and error details
src/main/java/org/sonarsource/sonarqube/mcp/SonarQubeMcpServer.java	Logs sanitized configuration at startup
src/test/java/org/sonarsource/sonarqube/mcp/log/McpLoggerTest.java	Comprehensive test coverage for McpLogger functionality
src/test/java/org/sonarsource/sonarqube/mcp/http/LoggingHttpClientTest.java	Test coverage for LoggingHttpClient decorator
src/test/java/org/sonarsource/sonarqube/mcp/http/HttpClientProxyTests.java	Adds test for proxy settings logging
src/test/java/org/sonarsource/sonarqube/mcp/serverapi/ServerApiTests.java	Adds test for error response body logging
src/test/java/org/sonarsource/sonarqube/mcp/SonarQubeMcpServerGenericTest.java	Adds test for configuration logging

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[nquinquenel]

I think the logic is too complex. What I was expecting from this ticket is something way simpler:

• New SONARQUBE_DEBUG_ENABLED env variable (true/false) in McpServerLaunchConfiguration
• Documentation update in README
• New debug() method in McpLogger
• Simple LOG.debug on various locations we'd like to debug

I don't think we should add this new LoggingHttpClient class

[nquinquenel]

What is sanitized?

[eray-felek-sonarsource]

Token is not included

[eray-felek-sonarsource]

I guess we can come up with a better name

[nquinquenel]

I think we should change this method's name, maybe logDebugDetails ?

[Copilot]

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 6 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[nquinquenel]

Few comments. I think we could log more meaningful things, related to tools for example. Maybe in a second time...

[sonarqubecloud]

SonarQube reviewer guide

Summary: Add configurable debug logging with SONARQUBE_DEBUG_ENABLED environment variable to improve troubleshooting, including sanitized configuration details and HTTP error response bodies.

Review Focus:

• The debug flag implementation in McpLogger.java - ensure the environment variable resolution is thread-safe and handles all edge cases correctly
• HttpClientProvider refactoring to store SSL/TLS and proxy details for logging - verify no state management issues or memory leaks
• Response body logging in ServerApiHelper.handleError() - confirm truncation logic (1000 char limit) is appropriate and doesn't expose sensitive data
• Tool execution logging change from DEBUG to INFO level in McpClientManager - verify this is intentional and won't cause log spam

Start review at: src/main/java/org/sonarsource/sonarqube/mcp/log/McpLogger.java. This is the central control point for the new debug feature and affects behavior across the entire codebase. Ensure the debug flag resolution is robust and the conditional debug output to STDERR is correct.

💬 Please send your feedback

Quality Gate passed

Issues
0 New issues
0 Accepted issues
0 Dependency risks

Measures
0 Security Hotspots
92.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud