Add debug log for brokers discovered through zookeeper (#122)

Add debug logs for brokers discovered through zookeeper

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.15.1 (2021-05-26)
+### Changed
+- Add debug broker logs from Zookeeper
+
 ## 2.15.0 (2021-03-24)
 ### Changed
 - Upgraded github.com/newrelic/infra-integrations-sdk to v3.6.6

src/connection/connection.go

@@ -339,6 +339,7 @@ func GetBrokerFromZookeeper(zkConn zookeeper.Connection, id, preferredListener s
 	if err != nil {
 		return nil, fmt.Errorf("failed to unmarshal broker information from zookeeper: %s", err)
 	}
+	log.Debug("zookeeper instance %s is reporting broker %s with the following information %+v", zkConn.Server(), id, brokerDecoded)
 
 	// Go through the list of brokers until we find one that uses a protocol we know how to handle
 	for _, endpoint := range brokerDecoded.Endpoints {
@@ -357,7 +358,7 @@ func GetBrokerFromZookeeper(zkConn zookeeper.Connection, id, preferredListener s
 		// Check that the protocol map
 		protocol, ok := brokerDecoded.ProtocolMap[listener]
 		if !ok {
-			log.Error("Listener '%s' was not found in the protocol map")
+			log.Error("Listener '%s' not found in protocol map for %s:%d", listener, host, port)
 			continue
 		}
 

src/connection/connection_test.go

@@ -14,6 +14,7 @@ func Test_GetBrokerFromZookeeper(t *testing.T) {
 
 	zkConn := &zookeeper.MockConnection{}
 	zkConn.On("Get", "/brokers/ids/0").Return([]byte(`{"listener_security_protocol_map":{"SASL_SSL":"SASL_SSL","SSL":"SSL", "PLAINTEXT":"PLAINTEXT"},"endpoints":["SASL_SSL://my-broker.host:9193","SSL://my-broker.host:9093","PLAINTEXT://my-broker.host:9092"],"rack":"us-east-1d","jmx_port":9999,"host":null,"timestamp":"1542127633364","port":-1,"version":4}`), new(zk.Stat), nil)
+	zkConn.On("Server").Return("localhost:2181")
 
 	_, err := GetBrokerFromZookeeper(zkConn, "0", "PLAINTEXT")
 	assert.Error(t, err, "Expected error getting broker information from mock")

src/jmxwrapper/jmx_wrapper.go

@@ -1,4 +1,4 @@
-// Package jmxwrapper contains varaibles for using github.com/newrelic/infra-integrations-sdk/jmx package
+// Package jmxwrapper contains variables for using github.com/newrelic/infra-integrations-sdk/jmx package
 // while allowing everything to be mocked for testing.
 package jmxwrapper
 

src/zookeeper/connection.go

@@ -15,6 +15,7 @@ type Connection interface {
 	Get(string) ([]byte, *zk.Stat, error)
 	Children(string) ([]string, *zk.Stat, error)
 	Close()
+	Server() string
 }
 
 type zookeeperConnection struct {
@@ -29,6 +30,10 @@ func (z zookeeperConnection) Get(s string) ([]byte, *zk.Stat, error) {
 	return z.inner.Get(s)
 }
 
+func (z zookeeperConnection) Server() string {
+	return z.inner.Server()
+}
+
 type zookeeperLogger struct{}
 
 func (z zookeeperLogger) Printf(format string, args ...interface{}) {

src/zookeeper/mock_zookeeper.go

@@ -26,3 +26,9 @@ func (m *MockConnection) Children(s string) ([]string, *zk.Stat, error) {
 func (m *MockConnection) Close() {
 	// do nothing
 }
+
+// Server returns the hostname
+func (m *MockConnection) Server() string {
+	args := m.Called()
+	return args.String(0)
+}