@itentialopensource/adapter-kafkav2 0.6.2 → 0.6.4

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.6.4 [05-19-2023]
+
+* added support for separate topics files per adapter
+
+See merge request itentialopensource/adapters/notification-messaging/adapter-kafkav2!5
+
+---
+
+## 0.6.3 [05-19-2023]
+
+* added support for separate topics files per adapter
+
+See merge request itentialopensource/adapters/notification-messaging/adapter-kafkav2!5
+
+---
+
 ## 0.6.2 [05-16-2023]
 
 * added support for separate topics files per adapter

package/README.md

@@ -212,6 +212,31 @@ Example of adapter's configuration with multiple paritions and subscribers per t
 ```
 Note that if no parition is supplied only messages on partition 0 will be consumed. Additionally, if no rabbit topic is supplied, events will be published to a topic with the same name as the Kafka topic. For example, topic `test-6` above will be published to the `test-6` rabbit topic. 
 
+Example of adapter configuration to pass partitions array for one subscriber:
+
+Note that you can pass multiple partitions to be consumed under the same subscriber. See example below -
+
+```json
+"topics": [
+            {
+              "name": "test_topic",
+              "always": true,
+              "partitions": [
+                1,
+                2
+              ],
+              "subscriberInfo": [
+                {
+                  "subname": "default",
+                  "filters": [],
+                  "rabbit": "test_topic",
+                  "throttle": {}
+                }
+              ]
+          }
+        ]
+```
+
 ### Connection Properties
 
 These base properties are used to connect to Kafka upon the adapter initially coming up. It is important to set these properties appropriately.
@@ -282,6 +307,18 @@ The `parseMessage` property allows the user to define how they want the Kafka me
 
 `iap_apps_check_interval` (default 30000ms - 30s) allows the user to set the frequency in which to run IAP app healtcheck.
 
+## Send message sample payload
+
+```json
+{
+    topic: 'topic-name',
+    messages: [
+        { key: 'key1', value: 'hello world' },
+        { key: 'key2', value: 'hey hey!' }
+    ],
+}
+```
+
 ## Testing an Itential Product Adapter
 
 Mocha is generally used to test all Itential Product Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-kafkav2",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "description": "Itential adapter to connect to kafka",
   "main": "adapter.js",
   "wizardVersion": "2.35.0",