Merge pull request #53 from citrix/prometheus-fix

updated the prometheus specific changes

Author: sreejithgs

coe-on-standalone-linux.md

@@ -26,43 +26,96 @@ Perform the following steps to deploy Citrix ADC Observability Exporter on a sta
             volumes:
               - ./lstreamd_default.conf:/var/logproxy/lstreamd/conf/lstreamd_default.conf:rw
               - ./cores/:/cores/:rw
-        ```
-
-2.  Create `lstreamd_default.conf` file with the required settings. The following is a sample configuration for the Elasticsearch endpoint speific deployment.
-
-        {
-                "Endpoints": {
-                    "ES": {
-                        "ServerUrl": "elasticsearch.default.svc.cluster.local:9200",
-                        "IndexPrefix":"adc_coe",
-                        "IndexInterval": "daily",
-                        "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"
-                        },
-                        "ProcessAlways": "no",
-                        "ProcessYieldTimeOut": "500",
-                        "MaxConnections": "512",
-                        "ElkMaxSendBuffersPerSec": "64",
-                        "JsonFileDump": "no"
+      ```
+
+    **Note:** Currently the image tag `quay.io/citrix/citrix-observability-exporter:latest` corresponds to Citrix ADC Observability Exporter version 1.2.001 and not 1.4.001.
+
+2.  Create the `lstreamd_default.conf` file with the required settings.
+
+    -  Following is a sample configuration for Elasticsearch endpoint specific deployment:
+
+            {
+                    "Endpoints": {
+                        "ES": {
+                            "ServerUrl": "elasticsearch.default.svc.cluster.local:9200",
+                            "IndexPrefix":"adc_coe",
+                            "IndexInterval": "daily",
+                            "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"
+                            },
+                            "ProcessAlways": "no",
+                            "ProcessYieldTimeOut": "500",
+                            "MaxConnections": "512",
+                            "ElkMaxSendBuffersPerSec": "64",
+                            "JsonFileDump": "no"
+                        }
+                    }
+            }
+
+    -  Following is a sample configuration for Elasticsearch endpoint specific deployment with Prometheus. For Citrix ADC Observability Exporter version 1.4.001, you should add `"PrometheusMode": "yes"` to the Elasticsearch `lstreamd_default.conf` file to enable Prometheus monitoring.
+
+            {
+                    "Endpoints": {
+                        "ES": {
+                            "ServerUrl": "elasticsearch.default.svc.cluster.local:9200",
+                            "IndexPrefix":"adc_coe",
+                            "IndexInterval": "daily",
+                            "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"
+                            },
+                            "ProcessAlways": "no",
+                            "ProcessYieldTimeOut": "500",
+                            "MaxConnections": "512",
+                            "ElkMaxSendBuffersPerSec": "64",
+                            "JsonFileDump": "no",
+                            "PrometheusMode": "yes"
+                        }
                     }
-                }
-        }
+            }
 
 3.  Run the `docker-compose up` command.
 
 Citrix ADC Observability Exporter is deployed and exposed on port 5557 and port 5563 for Citrix ADC transaction data and metrics data respectively.
 
+### Prometheus standalone deployment
+
+For Citrix ADC observability exporter version 1.4.001, with Prometheus as the endpoint you need to use the following `lstreamd_default.conf` file configuration.
+
+            lstreamd_default.conf: |
+            {
+                "Endpoints": {
+                    "ZIPKIN": {
+                                "ServerUrl":"http://0.0.0.0:0",
+                                "RecordType":{},
+                                "PrometheusMode":"yes"
+                              }
+                     }
+            }
+
+For Citrix ADC observability exporter versions prior to 1.4.001, you can use the `lstream_default.conf` configuration provided in the [coe-prometheus.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/deployment/coe-prometheus.yaml) file.
+
 ## Integrate Citrix ADC with multiple Citrix ADC Observability Exporter instances manually
 
 You can configure Citrix ADC Observability Exporter manually in Citrix ADC. Manual configuration is suitable for Citrix ADC in MPX and VPX form factors. We recommend deploying the Citrix ADC Observability Exporter in the automated way with the YAML file as described in the preceding sections.