Update changelog for v3.0.0 and remove clientID from config.sample (#185

)

* Update changelog for v3.0.0 and remove clientID from config.sample

CHANGELOG.md

@@ -5,6 +5,20 @@ 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/).
 
+## 3.0.0 (2022-07-12)
+
+This new version adds two new features to monitor inactive consumers. We encourage you to take a look at this new features in [here](https://docs.newrelic.com/docs/infrastructure/host-integrations/host-integrations-list/kafka/kafka-integration/#offset-monitoring).
+
+### Breaking changes
+- CONSUMER_GROUPS flag removed, CONSUMER_GROUP_REGEX should be used instead.
+- COLLECT_BROKER_TOPIC_DATA has been removed (It was not having any effect).
+- BOOTSTRAP_BROKER_JMX_USER and BOOTSTRAP_BROKER_JMX_PASSWORD are honored taking precedence to DEFAULT_JMX_USER and DEFAULT_JMX_BROKER on Bootsrap discovery.
+
+### Added
+- Autodetect Consumer/Producer names (clientID) (https://github.com/newrelic/nri-kafka/pull/178) 
+- Offset collection for consumer groups with inactive consumers using flag INACTIVE_CONSUMER_GROUP_OFFSET (https://github.com/newrelic/nri-kafka/pull/172)
+- Report consumer-group offset metrics by topic using flag CONSUMER_GROUP_OFFSET_BY_TOPIC (https://github.com/newrelic/nri-kafka/pull/172)
+
 ## 2.19.1 (2022-05-16)
 ### Added
 - Extra logging for broker collection on verbose mode

kafka-config.yml.k8s_sample

@@ -39,7 +39,7 @@ integrations_config:
         - name: nri-kafka
           env:
             CLUSTER_NAME: kafka-canary
-            PRODUCERS: '[{"name": "${discovery.podName}", "host": "${discovery.ip}", "port": 5555}]'
+            PRODUCERS: '[{"host": "${discovery.ip}", "port": 5555}]'
             TOPIC_MODE: list
             TOPIC_LIST: '["test"]'
             METRICS: 1
@@ -55,7 +55,7 @@ integrations_config:
         - name: nri-kafka
           env:
             CLUSTER_NAME: kafka-canary
-            CONSUMERS: '[{"name": "${discovery.podName}", "host": "${discovery.ip}", "port": 5555}]'
+            CONSUMERS: '[{"host": "${discovery.ip}", "port": 5555}]'
             TOPIC_MODE: list
             TOPIC_LIST: '["test"]'
             METRICS: 1

kafka-config.yml.sample

@@ -171,8 +171,8 @@ integrations:
     # - username: The username used to connect to JMX. If omitted, will use the value of the "default_jmx_user" field
     # - password: The password used to connect to JMX. If omitted, will use the value of the "default_jmx_password" field
     # Example: {"name": "myProducer", "host": "localhost", "port": 24, "username": "me', "password": "secret"}
-    PRODUCERS: '[{"name": "myProducer", "host": "localhost", "port": 24, "username": "me", "password": "secret"}]'
-    CONSUMERS: '[{"name": "myConsumer", "host": "localhost", "port": 24, "username": "me", "password": "secret"}]'
+    PRODUCERS: '[{"host": "localhost", "port": 24, "username": "me", "password": "secret"}]'
+    CONSUMERS: '[{"host": "localhost", "port": 24, "username": "me", "password": "secret"}]'
     # If several producers/consumers are on the same host an agent can be installed on that host and the
     # "default_jmx_host" and "default_jmx_port" field can be set once and used for all producers/consumers that
     # do not have the "host" or "port" field respectively.

src/args/args.go

@@ -69,7 +69,7 @@ type ArgumentList struct {
 
 	// Collection configuration
 	LocalOnlyCollection bool   `default:"false" help:"Collect only the metrics related to the configured bootstrap broker. Useful for distributed metric collection"`
-	TopicMode           string `default:"None" help:"Possiblex options are All, None, or List. If List, must also specify the list of topics to collect with the topic_list option."`
+	TopicMode           string `default:"None" help:"Possible options are All, None, or List. If List, must also specify the list of topics to collect with the topic_list option."`
 	TopicList           string `default:"[]" help:"JSON array of strings with the names of topics to monitor. Only used if collect_topics is set to 'List'"`
 	TopicRegex          string `default:"" help:"A regex pattern that matches the list of topics to collect. Only used if collect_topics is set to 'Regex'"`
 	TopicBucket         string `default:"1/1" help:"Allows the partitioning of topic collection across multiple instances. The second number is the number of instances topics are partitioned across. The first number is the bucket number of the current instance, which should be between 1 and the second number."`