Merge pull request #61 from citrix/coe-release-1.6.001-release-update

doc updates for COE release 1.6.001

Author: sreejithgs

docs/deploy-coe-with-Kafka.md

@@ -20,7 +20,7 @@ The following diagram illustrates a Citrix ADC as an Ingress Gateway with Citrix
 
   **Note**: In this example scenario, the YAML file is used to deploy Citrix ADC Observability Exporter in the Kubernetes *defauIt* namespace. If you want to deploy in a private Kubernetes namespace other than *default*, edit the YAML file to specify the namespace. 
 
-The following is a sample application deployment procdure.
+The following is a sample application deployment procedure.
 
   **Note**: If you have a pre-deployed web application, skip the step 1 and 2.
 
@@ -88,6 +88,7 @@ To edit the YAML file for the required changes, perform the following steps:
               "KAFKA": {
                 "ServerUrl": "X.X.X.X:9092", #Specify the Kafka broker IP
                 "KafkaTopic": "HTTP", #Specify the desired kafka topic
+                "DataFormat": "AVRO",
                 "RecordType": {
                     "HTTP": "all",
                     "TCP": "all",
@@ -112,8 +113,10 @@ To edit the YAML file for the required changes, perform the following steps:
           }
         }
 ```
+  
+  **Note:** To export transactions in the JSON format, see [exporting transaction in JSON format to Kafka](#support-for-exporting-transactions-in-the-json-format-from-citrix-adc-observability-exporter-to-kafka).
 
-2.  Specify the host name and IP or FQDN address of the Kafka nodes. Use the following YAML definition for a three node Kafka cluster:
+2. Specify the host name and IP or FQDN address of the Kafka nodes. Use the following YAML definition for a three node Kafka cluster:
 
 ```yml
     apiVersion: apps/v1
@@ -218,7 +221,7 @@ To verify the Citrix ADC Observability Exporter deployment, perform the followin
 
       ![HTTP methods](media/coe-kafka-http-methods.png)
 
-  3.  Use Kafka Consumer to view the transaction data. Access kafka Consumer from [PythonKafkaConsumer](https://kafka-python.readthedocs.io/en/master/apidoc/KafkaConsumer.html).
+  3.  Use Kafka Consumer to view the transaction data. Access Kafka Consumer from [PythonKafkaConsumer](https://kafka-python.readthedocs.io/en/master/apidoc/KafkaConsumer.html).
 
       The following image shows sample data from Kafka Consumer.
 
@@ -274,4 +277,45 @@ set analyticsprofile ns_analytics_time_series_profile -collectors metrichost_SVC
 ```
 
 For information on troubleshooting related to Citrix ADC Observability Exporter, see [Citrix ADC CPX troubleshooting](https://docs.citrix.com/en-us/citrix-adc-cpx/current-release/cpx-troubleshooting.html).
-  
+
+## Support for exporting transactions in the JSON format from Citrix ADC Observability Exporter to Kafka
+
+You can now export transactions from Citrix ADC Observability Exporter to Kafka in the JSON format apart from the AVRO format.
+A new parameter `DataFormat` is introduced in the Kafka deployment ConfigMap to support transactions in the JSON format.
+This parameter can accept AVRO and JSON values. For allowing JSON based transactions, set the value of
+`DataFormat` as JSON in the
+[coe-kafka.yaml](https://raw.githubusercontent.com/citrix/citrix-observability-exporter/master/examples/kafka/coe-kafka.yaml) file. The default value is AVRO.
+
+The following example shows the YAML file with the data format configured as JSON.
+
+```yml
+    apiVersion: v1
+    kind: ConfigMap
+    metadata:
+      name: coe-config-kafka
+    data:
+      lstreamd_default.conf: |
+        {
+            "Endpoints": {
+              "KAFKA": {
+                "DataFormat": "JSON",
+                "ServerUrl": "X.X.X.X:9092", #Specify the Kafka broker IP
+                "KafkaTopic": "HTTP", #Specify the desired kafka topic
+                "RecordType": {
+                    "HTTP": "all",
+                    "TCP": "all",
+                    "SWG": "all",
+                    "VPN": "all",
+                    "NGS": "all",
+                    "ICA": "all",
+                    "APPFW": "none",
+                    "BOT": "none",
+                    "VIDEOOPT": "none",
+                    "BURST_CQA": "none",
+                    "SLA": "none",
+                    "MONGO": "none"
+                }
+              }
+          }
+        }
+```