Merge pull request #223 from uber/checksum-logging

Log membership and ring checksum computed events
esatterwhite · Dec 15, 2015 · 118fe07 · 118fe07
2 parents 5e6cf53 + b1f5224
commit 118fe07
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 7 deletions.
diff --git a/config.js b/config.js
@@ -73,6 +73,7 @@ Config.prototype._seed = function _seed(seed) {
     seedOrDefault('gossipLogLevel', LoggingLevels.error);
     seedOrDefault('joinLogLevel', LoggingLevels.warn);
     seedOrDefault('membershipLogLevel', LoggingLevels.error);
+    seedOrDefault('ringLogLevel', LoggingLevels.error);
     seedOrDefault('suspicionLogLevel', LoggingLevels.error);
 
     // Gossip configs

diff --git a/lib/logging/logger_factory.js b/lib/logging/logger_factory.js
@@ -30,6 +30,7 @@ var loggerNamesToLevels = {
     gossip: 'gossipLogLevel',
     join: 'joinLogLevel',
     membership: 'membershipLogLevel',
+    ring: 'ringLogLevel',
     suspicion: 'suspicionLogLevel',
 };
 

diff --git a/lib/membership/events.js b/lib/membership/events.js
@@ -19,10 +19,11 @@
 // THE SOFTWARE.
 'use strict';
 
-function LocalMemberLeaveEvent(member, oldStatus) {
+function ChecksumComputedEvent(checksum, oldChecksum) {
     this.name = this.constructor.name;
-    this.member = member;
-    this.oldStatus = oldStatus;
+    this.checksum = checksum;
+    this.oldChecksum = oldChecksum;
+    this.timestamp = Date.now();
 }
 
 // A member becomes reusable when the damp score of a previously damped member
@@ -39,7 +40,14 @@ function DampingSuppressLimitExceededEvent(member) {
     this.member = member;
 }
 
+function LocalMemberLeaveEvent(member, oldStatus) {
+    this.name = this.constructor.name;
+    this.member = member;
+    this.oldStatus = oldStatus;
+}
+
 module.exports = {
+    ChecksumComputedEvent: ChecksumComputedEvent,
     DampingReusableEvent: DampingReusableEvent,
     DampingSuppressLimitExceededEvent: DampingSuppressLimitExceededEvent,
     LocalMemberLeaveEvent: LocalMemberLeaveEvent

diff --git a/lib/membership/index.js b/lib/membership/index.js
@@ -23,6 +23,7 @@ var _ = require('underscore');
 var EventEmitter = require('events').EventEmitter;
 var Member = require('./member.js');
 var MemberDampScore = require('./member_damp_score.js');
+var MembershipEvents = require('./events.js');
 var mergeMembershipChangesets = require('./merge.js');
 var timers = require('timers');
 var update = require('./update.js');
@@ -77,7 +78,8 @@ Membership.prototype.computeChecksum = function computeChecksum() {
     var prevChecksum = this.checksum;
     this.checksum = this.ringpop.hashFunc(this.generateChecksumString());
 
-    this.emit('checksumComputed');
+    this.emit('checksumComputed', new MembershipEvents.ChecksumComputedEvent(
+        this.checksum, prevChecksum));
     this.ringpop.stat('timing', 'compute-checksum', start);
     this.ringpop.stat('gauge', 'checksum', this.checksum);
     if (prevChecksum !== this.checksum) {

diff --git a/lib/on_membership_event.js b/lib/on_membership_event.js
@@ -23,9 +23,20 @@ var Member = require('./membership/member.js');
 var MembershipEvents = require('./membership/events.js');
 
 function createChecksumComputedHandler(ringpop) {
-    return function onMembershipChecksumComputed() {
+    var membershipLogger = ringpop.loggerFactory.getLogger('membership');
+
+    return function onMembershipChecksumComputed(event) {
         ringpop.stat('increment', 'membership.checksum-computed');
         ringpop.emit('membershipChecksumComputed');
+
+        if (event.oldChecksum !== event.checksum) {
+            membershipLogger.debug('ringpop membership computed new checksum', {
+                local: ringpop.whoami(),
+                checksum: event.checksum,
+                oldChecksum: event.oldChecksum,
+                timestamp: event.timestamp
+            });
+        }
     };
 }
 

diff --git a/lib/on_ring_event.js b/lib/on_ring_event.js
@@ -20,9 +20,20 @@
 'use strict';
 
 function createChecksumComputedHandler(ringpop) {
-    return function onRingChecksumComputed() {
+    var ringLogger = ringpop.loggerFactory.getLogger('ring');
+
+    return function onRingChecksumComputed(event) {
         ringpop.stat('increment', 'ring.checksum-computed');
         ringpop.emit('ringChecksumComputed');
+
+        if (event.oldChecksum !== event.checksum) {
+            ringLogger.debug('ringpop ring computed new checksum', {
+                local: ringpop.whoami(),
+                checksum: event.checksum,
+                oldChecksum: event.oldChecksum,
+                timestamp: event.timestamp
+            });
+        }
     };
 }
 

diff --git a/lib/ring/events.js b/lib/ring/events.js
@@ -19,12 +19,20 @@
 // THE SOFTWARE.
 'use strict';
 
+function ChecksumComputedEvent(checksum, oldChecksum) {
+    this.name = this.constructor.name;
+    this.checksum = checksum;
+    this.oldChecksum = oldChecksum;
+    this.timestamp = Date.now();
+}
+
 function RingChangedEvent(added, removed) {
     this.name = this.constructor.name;
     this.added = added;
     this.removed = removed;
 }
 
 module.exports = {
+    ChecksumComputedEvent: ChecksumComputedEvent,
     RingChangedEvent: RingChangedEvent
 };
diff --git a/lib/ring/index.js b/lib/ring/index.js
@@ -102,9 +102,11 @@ HashRing.prototype.computeChecksum = function computeChecksum() {
     var serverNames = Object.keys(this.servers);
     var serverNameStr = serverNames.sort().join(';');
 
+    var oldChecksum = this.checksum;
     this.checksum = this.hashFunc(serverNameStr);
 
-    this.emit('checksumComputed');
+    this.emit('checksumComputed', new RingEvents.ChecksumComputedEvent(
+        this.checksum, oldChecksum));
 };
 
 HashRing.prototype.getServerCount = function getServerCount() {