Skip to content

Commit 9f793be

Browse files
committed
doc updates for COE release 1.6.001
1 parent d442261 commit 9f793be

1 file changed

Lines changed: 45 additions & 2 deletions

File tree

docs/deploy-coe-with-Kafka.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,10 @@ To edit the YAML file for the required changes, perform the following steps:
112112
}
113113
}
114114
```
115+
116+
**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).
115117
116-
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:
118+
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:
117119
118120
```yml
119121
apiVersion: apps/v1
@@ -274,4 +276,45 @@ set analyticsprofile ns_analytics_time_series_profile -collectors metrichost_SVC
274276
```
275277
276278
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).
277-
279+
280+
## Support for exporting transactions in the JSON format from Citrix ADC Observability Exporter to Kafka
281+
282+
You can now export transactions from Citrix ADC Observability Exporter to Kafka in the JSON format apart from the AVRO format.
283+
A new parameter `DataFormat` is introduced in the Kafka deployment ConfigMap to support transactions in the JSON format.
284+
This parameter can accept AVRO and JSON values. For allowing JSON based transactions, set the value of
285+
`DataFormat` as JSON in the
286+
[coe-kafka.yaml](https://raw.githubusercontent.com/citrix/citrix-observability-exporter/master/examples/kafka/coe-kafka.yaml) file. The default value is AVRO.
287+
288+
The following example shows the YAML file with the data format configured as JSON.
289+
290+
```yml
291+
apiVersion: v1
292+
kind: ConfigMap
293+
metadata:
294+
name: coe-config-kafka
295+
data:
296+
lstreamd_default.conf: |
297+
{
298+
"Endpoints": {
299+
"KAFKA": {
300+
DataFormat: "JSON",
301+
"ServerUrl": "X.X.X.X:9092", #Specify the Kafka broker IP
302+
"KafkaTopic": "HTTP", #Specify the desired kafka topic
303+
"RecordType": {
304+
"HTTP": "all",
305+
"TCP": "all",
306+
"SWG": "all",
307+
"VPN": "all",
308+
"NGS": "all",
309+
"ICA": "all",
310+
"APPFW": "none",
311+
"BOT": "none",
312+
"VIDEOOPT": "none",
313+
"BURST_CQA": "none",
314+
"SLA": "none",
315+
"MONGO": "none"
316+
},
317+
}
318+
}
319+
}
320+
```

0 commit comments

Comments
 (0)