Skip to content

Remove stacktrace from recoverable discovery log warnings #954

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 9, 2021
Merged

Remove stacktrace from recoverable discovery log warnings #954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions driver/src/main/java/org/neo4j/driver/internal/cluster/Rediscovery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,21 @@
import org.neo4j.driver.internal.BoltServerAddress;
import org.neo4j.driver.internal.spi.ConnectionPool;

/**
* Provides cluster composition lookup capabilities and initial router address resolution.
*/
public interface Rediscovery
{
/**
* Fetches cluster composition using the provided routing table.
* <p>
* Implementation must be thread safe to be called with distinct routing tables concurrently. The routing table instance may be modified.
*
* @param routingTable the routing table for cluster composition lookup
* @param connectionPool the connection pool for connection acquisition
* @param bookmark the bookmark that is presented to the server
* @return cluster composition lookup result
*/
CompletionStage<ClusterComposition> lookupClusterComposition( RoutingTable routingTable, ConnectionPool connectionPool, Bookmark bookmark );

List<BoltServerAddress> resolve();
Expand Down
12 changes: 6 additions & 6 deletions driver/src/main/java/org/neo4j/driver/internal/cluster/RediscoveryImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,13 @@
import static org.neo4j.driver.internal.util.Futures.completedWithNull;
import static org.neo4j.driver.internal.util.Futures.failedFuture;

/**
* This class is used by all router tables to perform discovery.
* In other words, the methods in this class could be called by multiple threads concurrently.
*/
public class RediscoveryImpl implements Rediscovery
{
private static final String NO_ROUTERS_AVAILABLE = "Could not perform discovery for database '%s'. No routing server available.";
private static final String RECOVERABLE_ROUTING_ERROR = "Failed to update routing table with server '%s'.";
private static final String RECOVERABLE_DISCOVERY_ERROR_WITH_SERVER = "Received a recoverable discovery error with server '%s', " +
"will continue discovery with other routing servers if available. " +
"Complete routing failures will be reported separately from this warning.";

private final BoltServerAddress initialRouter;
private final RoutingSettings settings;
Expand Down Expand Up @@ -258,8 +257,9 @@ private ClusterComposition handleRoutingProcedureError( Throwable error, Routing
// Retriable error happened during discovery.
DiscoveryException discoveryError = new DiscoveryException( format( RECOVERABLE_ROUTING_ERROR, routerAddress ), error );
Futures.combineErrors( baseError, discoveryError ); // we record each failure here
logger.warn( format( "Received a recoverable discovery error with server '%s', will continue discovery with other routing servers if available.",
routerAddress ), discoveryError );
String warningMessage = format( RECOVERABLE_DISCOVERY_ERROR_WITH_SERVER, routerAddress );
logger.warn( warningMessage );
logger.debug( warningMessage, discoveryError );
routingTable.forget( routerAddress );
return null;
}
Expand Down
12 changes: 8 additions & 4 deletions driver/src/test/java/org/neo4j/driver/internal/cluster/RediscoveryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.startsWith;
Expand Down Expand Up @@ -182,9 +181,14 @@ void shouldFailImmediatelyWhenClusterCompositionProviderReturnsFailure()
ClusterComposition composition = await( rediscovery.lookupClusterComposition( table, pool, empty() ) );
assertEquals( validComposition, composition );

ArgumentCaptor<DiscoveryException> argument = ArgumentCaptor.forClass( DiscoveryException.class );
verify( logger ).warn( anyString(), argument.capture() );
assertThat( argument.getValue().getCause(), equalTo( protocolError ) );
ArgumentCaptor<String> warningMessageCaptor = ArgumentCaptor.forClass( String.class );
ArgumentCaptor<String> debugMessageCaptor = ArgumentCaptor.forClass( String.class );
ArgumentCaptor<DiscoveryException> debugThrowableCaptor = ArgumentCaptor.forClass( DiscoveryException.class );
verify( logger ).warn( warningMessageCaptor.capture() );
verify( logger ).debug( debugMessageCaptor.capture(), debugThrowableCaptor.capture() );
assertNotNull( warningMessageCaptor.getValue() );
assertEquals( warningMessageCaptor.getValue(), debugMessageCaptor.getValue() );
assertThat( debugThrowableCaptor.getValue().getCause(), equalTo( protocolError ) );
}

@Test
Expand Down