Better log messages (elastic#27)

Miscellaneous fixes/clarifications to log messages that arose in tracking down elastic#26.
ywelsch · Jan 11, 2018 · 0965384 · 0965384
1 parent 5a823ad
commit 0965384
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 11 deletions.
diff --git a/core/src/main/java/org/elasticsearch/discovery/zen2/ConsensusState.java b/core/src/main/java/org/elasticsearch/discovery/zen2/ConsensusState.java
@@ -193,7 +193,7 @@ public PublishResponse handlePublishRequest(PublishRequest<T> publishRequest) {
                 firstUncommittedSlot());
         }
 
-        logger.trace("handlePublishRequest: storing publish request for slot [{}] and term [{}]",
+        logger.trace("handlePublishRequest: accepting publish request for slot [{}] and term [{}]",
             publishRequest.getSlot(), publishRequest.getTerm());
         persistedState.setAcceptedState(publishRequest.getAcceptedState());
         assert persistedState.getAcceptedState().isPresent() &&

diff --git a/core/src/main/java/org/elasticsearch/discovery/zen2/Legislator.java b/core/src/main/java/org/elasticsearch/discovery/zen2/Legislator.java
@@ -196,7 +196,8 @@ public void handleWakeUp() {
         try {
             if (remainingWakeUpDelay == 0L) {
                 final Level logLevel = mode == Mode.LEADER && leaderMode == LeaderMode.HEARTBEAT_DELAY ? Level.TRACE : Level.DEBUG;
-                logger.log(logLevel, "handleWakeUp: waking up as [{}] at [{}] with slot={}, term={}, lastAcceptedTerm={}", mode, now,
+                logger.log(logLevel, "handleWakeUp: waking up as [{}/{}] at [{}] with slot={}, term={}, lastAcceptedTerm={}",
+                    mode, leaderMode, now,
                     consensusState.firstUncommittedSlot(), consensusState.getCurrentTerm(), consensusState.lastAcceptedTerm());
                 switch (mode) {
                     case CANDIDATE:
@@ -232,7 +233,7 @@ public void handleWakeUp() {
     }
 
     private void becomeCandidate(String method) {
-        logger.debug("{}: becoming candidate (was {}, lastKnownLeader was [{}])", method, mode, lastKnownLeader);
+        logger.debug("{}: becoming candidate (was [{}/{}], lastKnownLeader was [{}])", method, mode, leaderMode, lastKnownLeader);
         mode = Mode.CANDIDATE;
         currentDelayMillis = minDelay.getMillis();
         ignoreWakeUpsForRandomDelay();
@@ -241,12 +242,14 @@ private void becomeCandidate(String method) {
 
     private void becomeOrRenewLeader(String method, LeaderMode newLeaderMode) {
         if (mode != Mode.LEADER) {
-            logger.debug("{}: becoming leader [{}] (was {}, lastKnownLeader was [{}])", method, newLeaderMode, mode, lastKnownLeader);
+            logger.debug("{}: becoming [LEADER/{}] (was [{}/{}], lastKnownLeader was [{}])",
+                method, newLeaderMode, mode, leaderMode, lastKnownLeader);
         } else {
             assert newLeaderMode != leaderMode;
             // publishing always followed by delaying the heartbeat
             assert leaderMode != LeaderMode.PUBLISH_IN_PROGRESS || newLeaderMode == LeaderMode.HEARTBEAT_DELAY;
-            logger.trace("{}: switching leader mode (prev: [{}], now: [{}])", method, leaderMode, newLeaderMode);
+            logger.trace("{}: renewing as [LEADER/{}] (was [{}/{}], lastKnownLeader was [{}])",
+                method, newLeaderMode, mode, leaderMode, lastKnownLeader);
         }
         mode = Mode.LEADER;
         leaderMode = newLeaderMode;
@@ -265,8 +268,8 @@ private void becomeOrRenewLeader(String method, LeaderMode newLeaderMode) {
 
     private void becomeOrRenewFollower(String method, DiscoveryNode leaderNode) {
         if (mode != Mode.FOLLOWER) {
-            logger.debug("{}: becoming follower of [{}] (was {}, lastKnownLeader was [{}])",
-                method, leaderNode, mode, lastKnownLeader);
+            logger.debug("{}: becoming follower of [{}] (was [{}/{}], lastKnownLeader was [{}])",
+                method, leaderNode, mode, leaderMode, lastKnownLeader);
         }
         mode = Mode.FOLLOWER;
         lastKnownLeader = Optional.of(leaderNode);
@@ -743,6 +746,7 @@ public void add(DiscoveryNode sender) {
         public void start(HeartbeatRequest heartbeatRequest) {
             nodeSupplier.get().forEach(n -> {
                 if (n.equals(localNode) == false) {
+                    logger.trace("HeartbeatCollector.start: sending heartbeat to {}", n);
                     transport.sendHeartbeatRequest(n, heartbeatRequest,
                         new TransportResponseHandler<HeartbeatResponse>() {
                             @Override
@@ -752,14 +756,15 @@ public HeartbeatResponse read(StreamInput in) throws IOException {
 
                             @Override
                             public void handleResponse(HeartbeatResponse response) {
+                                logger.trace("HeartbeatCollector.handleResponse: received [{}]", response);
                                 handleHeartbeatResponse(n, HeartbeatCollector.this, response);
                             }
 
                             @Override
                             public void handleException(TransportException exp) {
                                 logger.trace(
                                     (Supplier<?>) () -> new ParameterizedMessage(
-                                        "handleHeartbeatResponse: failed to get heartbeat from [{}]", n), exp);
+                                        "HeartbeatCollector.handleException: failed to get heartbeat from [{}]", n), exp);
                             }
 
                             @Override
@@ -832,7 +837,7 @@ public PublishResponse handleCatchUp(DiscoveryNode sender, CatchupRequest<T> cat
 
     public void abdicateTo(DiscoveryNode newLeader) {
         if (mode != Mode.LEADER) {
-            logger.debug("abdicateTo: mode={} so cannot abdicate to [{}]", mode, newLeader);
+            logger.debug("abdicateTo: mode={} != LEADER, so cannot abdicate to [{}]", mode, newLeader);
             throw new IllegalArgumentException("abdicateTo: not currently leading, so cannot abdicate.");
         }
         logger.debug("abdicateTo: abdicating to [{}]", newLeader);

diff --git a/core/src/test/java/org/elasticsearch/discovery/zen2/LegislatorTests.java b/core/src/test/java/org/elasticsearch/discovery/zen2/LegislatorTests.java
@@ -208,8 +208,9 @@ private void stabilise() {
                 deliverNextMessageUntilQuiescent();
             }
 
-            assertUniqueLeaderAndExpectedModes();
             logger.info("--> end of stabilisation phase");
+
+            assertUniqueLeaderAndExpectedModes();
         }
 
         /**
@@ -320,7 +321,7 @@ private void runRandomly(boolean reconfigure) {
 
         void setCurrentTimeForwards(long delayMillis) {
             if (delayMillis > 0) {
-                logger.debug("----> moving time from [{}] to [{}]", currentTimeMillis, currentTimeMillis + delayMillis);
+                logger.debug("----> advancing time from [{}ms] to [{}ms]", currentTimeMillis, currentTimeMillis + delayMillis);
                 currentTimeMillis += delayMillis;
             }
         }