@itentialopensource/adapter-kafkav2 0.3.14 → 0.3.15

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.3.15 [02-17-2023]
+
+* Updated readme
+
+See merge request itentialopensource/adapters/notification-messaging/adapter-kafkav2!2
+
+---
+
 ## 0.3.14 [02-16-2023]
 
 * updated to allow multiple subscribers per topic entry and fixed partition logic

package/README.md

@@ -148,9 +148,66 @@ Example of adapter's configuration with filtering applied:
   }
 ],
 ```
-
 When operator skips to provide `filters` property or the property contains no actual filters set, then all messages are passed.
 
+Example of adapter's configuration with multiple paritions and subscribers per topic:
+```json
+      "topics": [
+        {
+          "name": "topic1",
+          "always": true,
+          "partition": 0,
+          "subscriberInfo": [
+            {
+              "subname": "default",
+              "filters": [
+                "PIXI",
+                "DRED",
+                "F: (\\w+), L: (\\w+)",
+                "\\d{3,4}"
+              ],
+              "rabbit": "topic1",
+              "throttle": {}
+            },
+            {
+              "subname": "sub2",
+              "filters": [
+                "[abc]",
+                "F: (\\w+), L: (\\w+)",
+                "\\d{3,4}"
+              ],
+              "rabbit": "topic1-s2",
+              "throttle": {}
+            }
+          ]
+        },
+        {
+          "name": "topic1",
+          "always": true,
+          "partition": 1,
+          "subscriberInfo": [
+            {
+              "subname": "default",
+              "filters": [
+                "PIXI",
+                "DRED",
+                "[abc]",
+                "F: (\\w+), L: (\\w+)",
+                "\\d{3,4}"
+              ],
+              "rabbit": "topic1-p1",
+              "throttle": {}
+            }
+          ]
+        },
+        {
+          "name": "test-6",
+          "always": true
+        }
+      ],
+```
+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. 
+
 ### 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.
@@ -211,6 +268,10 @@ The following properties are used to define the Kafka Consumer. These properties
 | encoding | If set to 'buffer', values will be returned as raw buffer objects..|
 | keyEncoding | |
 
+## Parsing Properties
+
+The `parseMessage` property allows the user to define how they want the Kafka message to be published to IAP's event system. If `parseMessage` is set to true or omitted, the value of the Kafka message will be parsed as either an object or string and wrapped in an outer object. The wrapper object's key can be defined with the property `wrapMessage`, or the default value `payload` can be used if omitted. If `parseMessage` is set to false, the entire kafka payload, including metadata, would be returned and the message itself would need to be transformed at a later point.
+
 ## 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.3.14",
+  "version": "0.3.15",
   "description": "Itential adapter to connect to kafka",
   "main": "adapter.js",
   "wizardVersion": "2.35.0",