From fd29f60bc07026668465f963ae365492bf5bbbf6 Mon Sep 17 00:00:00 2001 From: "BANLANEESHPU\\Aneesh" Date: Thu, 10 Dec 2020 10:48:20 +0530 Subject: [PATCH] Description: Corrected spelling and terminology issues JIRA ID: NSDOC-2139 Type: story acrolix score : deploy-coe 89 toc: NA --- docs/deploy-coe.md | 92 +++++++++++++++++++++++----------------------- docs/index.md | 43 +++++++++++----------- 2 files changed, 67 insertions(+), 68 deletions(-) diff --git a/docs/deploy-coe.md b/docs/deploy-coe.md index 1201146..59b3dc2 100644 --- a/docs/deploy-coe.md +++ b/docs/deploy-coe.md @@ -1,15 +1,15 @@ -# Deploy Citrix Observability Exporter +# Deploy Citrix ADC Observability Exporter -This topic provides information on how to deploy Citrix Observability Exporter using Kubernetes YAML files. +This topic provides information on how to deploy Citrix ADC Observability Exporter using Kubernetes YAML files. -Based on your Citrix ADC deployment, you can use Citrix Observability Exporter to export metrics and transactions from Citrix ADC CPX, MPX, or VPX. +Based on your Citrix ADC deployment, you can use Citrix ADC Observability Exporter to export metrics and transactions from Citrix ADC CPX, MPX, or VPX. -The following diagram shows a deployment of Citrix Observability Exporter with all the supported endpoints. +The following diagram shows a deployment of Citrix ADC Observability Exporter with all the supported endpoints. -![Citrix Observability Exporter](../media/citrix-observability-exporter-deploy.png) +![Citrix ADC Observability Exporter](../media/citrix-observability-exporter-deploy.png) ## Prerequisites @@ -27,9 +27,9 @@ ensure that you have the following docker images installed in the Kubernetes clu - If Kafka is used as the endpoint for transactions, ensure that the Kafka server is installed and configured. - If Prometheus is used as the endpoint for time series data, ensure that Prometheus is installed and configured. -## Deploy Citrix Observability Exporter using YAML +## Deploy Citrix ADC Observability Exporter using YAML -To deploy Citrix Observability Exporter using Kubernetes YAML, perform the following steps for the required endpoint: +To deploy Citrix ADC Observability Exporter using Kubernetes YAML, perform the following steps for the required endpoint: 1. Create a secret using the certificate [ingress.crt](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.crt) and key [ingress.key](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/ingress.key) provided. You can also use your own certificate and key. @@ -41,9 +41,9 @@ To deploy Citrix Observability Exporter using Kubernetes YAML, perform the follo 3. Create a Kubernetes ConfigMap, Deployment, and Service with Log stream configuration for the required endpoint: - - For Citrix Observability Exporter with Zipkin tracing support: + - For Citrix ADC Observability Exporter with Zipkin tracing support: - Deploy Citrix Observability Exporter using the [coe-zipkin.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/deployment/coe-zipkin.yaml) file. + Deploy Citrix ADC Observability Exporter using the [coe-zipkin.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/deployment/coe-zipkin.yaml) file. kubectl create -f coe-zipkin.yaml @@ -54,58 +54,58 @@ To deploy Citrix Observability Exporter using Kubernetes YAML, perform the follo ServerUrl= or - If you specify only the IP address, Citrix Observability Exporter considers the port as the default Zipkin port (9411) and takes the default upload path (`/api/v1/spans`). + If you specify only the IP address, Citrix ADC Observability Exporter considers the port as the default Zipkin port (9411) and takes the default upload path (`/api/v1/spans`). - Explicitly provide the tracer IP address or DNS name, port, and the upload path information: ServerUrl=:/api/v1/spans - - For Citrix Observability Exporter with Elasticsearch as the endpoint: + - For Citrix ADC Observability Exporter with Elasticsearch as the endpoint: - Deploy Citrix Observability Exporter using the [coe-es.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/deployment/coe-es.yaml) file. + Deploy Citrix ADC Observability Exporter using the [coe-es.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/deployment/coe-es.yaml) file. kubectl create -f coe-es.yaml Set the Elasticsearch server details in the `ServerUrl` environment variable either based on IP address or DNS name, along with port information. - - For Citrix Observability Exporter with Kafka as the endpoint: + - For Citrix ADC Observability Exporter with Kafka as the endpoint: - Deploy Citrix Observability Exporter using the [coe-kafka.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/deployment/coe-kafka.yaml) file. + Deploy Citrix ADC Observability Exporter using the [coe-kafka.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/deployment/coe-kafka.yaml) file. kubectl create -f coe-kafka.yaml - - Enable the Kafka endpoint by setting the Kafka broker details in the `ServerUrl` environment variable either based on IP address or DNS name, along with port information. Then specify the Kafka topic details in `KafkaTopic`. You also must specify the Kafka cluster host IP mapping under HostAliases in the [Kubernetes Pod specification](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/#adding-additional-entries-with-hostaliases). - - For Citrix Observability Exporter with Prometheus as the endpoint for time series data: + Enable the Kafka endpoint by specifying the Kafka broker details in the `ServerUrl` environment variable. You can enable it either based on the IP address or the DNS name with the port information. Then, specify the Kafka topic details in `KafkaTopic`. Specify the Kafka cluster host IP mapping under the HostAliases in the [Kubernetes Pod specification](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/#adding-additional-entries-with-hostaliases). - You can enable Prometheus support by specifying the following annotations in the YAML files to deploy Zipkin, Kafka, or Elasticsearch and exposing the time series port. You need to also specify the time series parameter with metrics enable set as `true` and the mode set to `prometheus` in the respective `cic-configmap.yaml` file for the endpoint. + - For Citrix ADC Observability Exporter with Prometheus as the endpoint: + Enable Prometheus support by specifying the following annotations in the deployment YAML files for the supported end points. To enable Prometheus support, you must also expose the time series port. Specify the time series parameter by setting `metrics.enable` as *true* and `metrics.mode` as *prometheus* in the respective `cic-configmap.yaml` files for the endpoints. + prometheus.io/scrape: "true" prometheus.io/port: "5563" - The following command deploys Citrix Observability Exporter with both Elasticsearch and Prometheus as endpoints, using the [coe-es-prometheus.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/deployment/coe-es-prometheus.yaml) file. In this YAML file, annotations for Prometheus support are enabled and port 5563 is exposed which is used for the time series data. + You can use the following command to deploy Citrix ADC Observability Exporter with both Elasticsearch and Prometheus as endpoints, using the [coe-es-prometheus.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/deployment/coe-es-prometheus.yaml) file. In this YAML file, annotations for the Prometheus support are enabled and the port 5563 is exposed. The port 5563 is used for the time series data. kubectl create -f coe-es-prometheus.yaml - You should configure Prometheus to scrape the data from the Citrix Observability Exporter time series port. For enabling time series data processing, there is no specific configuration required on Citrix Observability Exporter. By default, if time series data is pushed to Citrix Observability Exporter, it is processed automatically. The time series port is enabled by default. + You can configure Prometheus to scrape the data from the Citrix ADC Observability Exporter time series port. To process the time series data, you do not perform any specific configuration on Citrix ADC Observability Exporter. If time series data is pushed to Citrix ADC Observability Exporter by default, it is processed automatically. The time series port is enabled, by default. **Note:** -Once you deploy a Citrix Observability Exporter instance with a specific endpoint, you cannot modify it. For changing the endpoint, you must bring down the Citrix Observability Exporter instance and deploy it again with the new endpoint. +After you deployed a Citrix ADC Observability Exporter instance with a specific endpoint, you cannot modify it. To change the endpoint, you must bring down the Citrix ADC Observability Exporter instance and deploy it again with the new endpoint. -## Configure Citrix Observability Exporter support on Citrix ADC +## Configure Citrix ADC Observability Exporter support on Citrix ADC -Once you deploy Citrix Observability Exporter, you need to deploy the Citrix ADC appliance. You can either deploy Citrix ADC CPXs as pods inside the Kubernetes cluster or deploy a Citrix ADC MPX or VPX appliance outside the cluster. +After deploying Citrix ADC Observability Exporter, you must deploy the Citrix ADC appliance. You can either deploy Citrix ADC CPX as a pod inside the Kubernetes cluster or deploy a Citrix ADC MPX or VPX appliance outside the cluster. -### Deploy Citrix ADC CPX with Citrix Observability Exporter Support +### Deploy Citrix ADC CPX with Citrix ADC Observability Exporter Support In this procedure, a Citrix ADC CPX is deployed with the Citrix ingress controller as a sidecar. The Citrix ADC CPX instance load balances the North-South traffic to microservices in your Kubernetes cluster. -Depending on the endpoint you are using, you can choose the YAML file for deploying Citrix ADC CPX. These YAML files include the configuration required for Citrix Observability Exporter. +Depending on the endpoint you use, you can choose the YAML file for deploying Citrix ADC CPX. This YAML file includes the configuration required for Citrix ADC Observability Exporter. -Perform the following steps to deploy a Citrix ADC CPX instance with Citrix Observability Exporter support enabled. +Perform the following steps to deploy a Citrix ADC CPX instance with Citrix ADC Observability Exporter support enabled. -1. Download the YAML file for deploying Citrix ADC CPX according to the endpoint. +1. Download the YAML file for deploying Citrix ADC CPX in accordance with the endpoint. - For tracing support with Zipkin: [cpx-ingress-tracing.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/tracing/cpx-ingress-tracing.yaml) - For Elasticsearch as the transaction endpoint: [cpx-ingress-es.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/elasticsearch/cpx-ingress-es.yaml) @@ -144,19 +144,19 @@ For example: **Note:** -You can also define the parameters to import using smart annotations for service. You can specify the parameters in the YAML for deploying Citrix Observability Exporter. However, you can use service annotations only when the service type is `LoadBalancer`. +You can also define the parameters to import using smart annotations for a service. You can specify the parameters in the YAML for deploying Citrix ADC Observability Exporter. However, you can use service annotations only when the service type is `LoadBalancer`. For example: service.citrix.com/analyticsprofile: '{"":'{"webinsight": {"httpurl":"ENABLED", "httpuseragent":"ENABLED"} -### Deploy the Citrix ingress controller with Citrix Observability Exporter support for Citrix ADC MPX or VPX +### Deploy the Citrix ingress controller with Citrix ADC Observability Exporter support for Citrix ADC MPX or VPX -In this deployment, the Citrix ingress controller is deployed as a standalone pod in the Kubernetes cluster. It controls the Citrix ADC MPX or VPX appliance deployed outside the cluster. The Citrix Observability Exporter support is enabled in the Citrix ingress controller configuration. +In this deployment, the Citrix ingress controller is deployed as a standalone pod in the Kubernetes cluster. It controls the Citrix ADC MPX or VPX appliance deployed outside the cluster. The Citrix ADC Observability Exporter support is enabled in the Citrix ingress controller configuration. -Perform the following steps to deploy the Citrix ingress controller as a pod in the Kubernetes cluster with Citrix Observability Exporter support enabled. +Perform the following steps to deploy the Citrix ingress controller as a pod in the Kubernetes cluster with Citrix ADC Observability Exporter. -You need to complete the [prerequisites](https://developer-docs.citrix.com/projects/citrix-k8s-ingress-controller/en/latest/deploy/deploy-cic-yaml/#prerequisites) for deploying the Citrix ingress controller as a standalone pod. +You must complete the [prerequisites](https://developer-docs.citrix.com/projects/citrix-k8s-ingress-controller/en/latest/deploy/deploy-cic-yaml/#prerequisites) before deploying the Citrix ingress controller as a standalone pod. 1. Download the [vpx-ingress.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/vpx-ingress.yaml) file. @@ -170,11 +170,11 @@ You need to complete the [prerequisites](https://developer-docs.citrix.com/proje ## Deploy sample applications -Once you create the necessary secrets, Citrix ADC deployment, and Citrix Observability Exporter, you can test the Citrix Observability Exporter deployment with a sample application. +After creating the necessary secrets and deploying Citrix ADC and Citrix ADC Observability Exporter, you can verify the Citrix ADC Observability Exporter deployment with a sample application. -### Verify Citrix Observability Exporter tracing support +### Verify Citrix ADC Observability Exporter tracing support -This example shows how to verify the Citrix Observability Exporter deployment and distributed tracing using a sample application. In this example, a Citrix ADC CPX instance is deployed with Citrix Observability Exporter support enabled. +The following example shows how to verify the Citrix ADC Observability Exporter deployment and distributed tracing using a sample application. In this example, a Citrix ADC CPX instance is deployed with Citrix ADC Observability Exporter. 1. Deploy a sample web application using the [watches-app-tracing.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/tracing/watches-app-tracing.yaml) file. This file includes the deployment, service, and Ingress. @@ -193,25 +193,25 @@ You can see the traces as shown in the following image. ![Zipkin](../media/zipkin-ui.png) -This image shows a trace created for a request in Zipkin. You can see that multiple microservices are invoked to serve a single request and spans for each microservice is created. The time taken to process a request on each microservice is displayed. Spans starting with `k8s_*` are created for Citrix ADC CPX and other spans are for back end web servers. +This image shows a trace created for a request in Zipkin. You can see that multiple microservices are invoked to serve a single request and spans for each microservice are created. The time taken to process a request on each microservice is displayed. Spans starting with `k8s_*` are created for Citrix ADC CPX and other spans are for back end web servers. -### Verify Citrix Observability Exporter transaction support +### Verify Citrix ADC Observability Exporter transaction support -This example shows how to verify a Citrix Observability Exporter deployment with Elasticsearch as the transaction endpoint. +This example shows how to verify a Citrix ADC Observability Exporter deployment with Elasticsearch as the transaction endpoint. -You must complete the following steps before performing the steps in this example: +Complete the following steps before performing the steps in this example: -- Deploy Citrix Observability Exporter with Elasticsearch as the transaction endpoint. -- Deploy Citrix ADC CPX with Citrix Observability Exporter support enabled +- Deploy Citrix ADC Observability Exporter with Elasticsearch as the transaction endpoint. +- Deploy Citrix ADC CPX with Citrix ADC Observability Exporter support enabled -Once you deploy Citrix Observability Exporter and Citrix ADC CPX perform the following steps: +Once you deploy Citrix ADC Observability Exporter and Citrix ADC CPX perform the following steps: 1. Deploy a sample web application using the [webserver-es.yaml](https://github.com/citrix/citrix-observability-exporter/blob/master/examples/elasticsearch/webserver-es.yaml) file. This sample web application is added as a service in the Ingress. kubectl create -f webserver-es.yaml -1. Create a host entry for the web application in Citrix ADC CPX hosts file and map it to the IP address of the Kubernetes master node for DNS resolution. +1. Create a host entry for the web application in Citrix ADC CPX hosts file. Map it to the IP address of the Kubernetes master node for DNS resolution. www.samplewebserver.com ip-address @@ -232,7 +232,7 @@ file. This sample web application is added as a service in the Ingress. You can use the following sample Kibana dashboard to visualize transactions. - ![Kibana-dashboard](../media/kibana-template.png) + ![Kibana dashboard](../media/kibana-template.png) **Note:** You can import the Kibana dashboard template from [dashboards](https://github.com/citrix/citrix-observability-exporter/blob/master/dashboards/KibanaAppTrans.ndjson). @@ -242,7 +242,7 @@ file. This sample web application is added as a service in the Ingress. Following is a sample Grafana dashboard which visualizes time series data from Prometheus. Kafka is used as the transaction endpoint. -![Grafana-dashboard](../media/COE-GrafanaDashboard.png) +![Grafana dashboard](../media/COE-GrafanaDashboard.png) **Note:** You can import the Grafana dashboard template from [dashboards](https://github.com/citrix/citrix-observability-exporter/blob/master/dashboards). diff --git a/docs/index.md b/docs/index.md index f657c60..cc24ea0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,10 @@ -# Citrix Observability Exporter +# Citrix ADC Observability Exporter - Citrix Observability Exporter is a container which collects metrics and transactions from Citrix ADCs and transforms them to suitable formats (such as JSON, AVRO) for [supported endpoints](#Supported-Endpoints). You can export the data collected by Citrix Observability Exporter to the desired endpoint. By analyzing the data exported to the endpoint, you can get valuable insights at a microservices level for applications proxied by Citrix ADCs. + Citrix ADC Observability Exporter is a container that collects metrics and transactions from Citrix ADCs and transforms them to suitable formats (such as JSON, AVRO) for [supported endpoints](#Supported-Endpoints). You can export the data collected by Citrix ADC Observability Exporter to the desired endpoint. By analyzing the data exported to the endpoint, you get valuable insights at a microservices level for the applications proxied by Citrix ADCs. ## Supported Endpoints - Citrix Observability Exporter currently supports the following endpoints: + Citrix ADC Observability Exporter currently supports the following endpoints: - [Zipkin](https://zipkin.io/) - [Kafka](https://kafka.apache.org/) @@ -15,54 +15,53 @@ ### Distributed tracing support with Zipkin -In a microservice architecture, a single end-user request may span across multiple microservices and tracking a transaction and fixing sources of errors is challenging. In such cases, traditional ways for performance monitoring cannot accurately pinpoint where failures occur and what is the reason behind poor performance. You need a way to capture data points specific to each microservice which is handling a request and analyze them to get meaningful insights. +In a microservice architecture, a single user request does span across multiple microservices and tracking a transaction and fixing sources of errors is challenging. In such cases, traditional ways for performance monitoring cannot accurately pinpoint where failures occur and what is the reason behind poor performance. You need a way to capture data points specific to each microservice which is handling a request and analyze them to get meaningful insights. -Distributed tracing addresses this challenge by providing a way to track a transaction end-to-end and understand how it is being handled across multiple microservices. [OpenTracing](https://opentracing.io/) is a specification and standard set of APIs for designing and implementing distributed tracing. Distributed tracers allow you to visualize the data flow between your microservices and helps to identify the bottlenecks in your microservices architecture. +Distributed tracing addresses this challenge by providing a way to track an end-to-end transaction and understand how it is handled across multiple microservices. [OpenTracing](https://opentracing.io/) is a specification and standard set of APIs for designing and implementing distributed tracing. Distributed tracers allow you to visualize the data flow between your microservices and helps to identify the bottlenecks in your microservices architecture. -Citrix Observability Exporter implements distributed tracing for Citrix ADC and currently supports [Zipkin](https://zipkin.io/) as the distributed tracer. +Citrix ADC Observability Exporter implements distributed tracing for Citrix ADC and currently supports [Zipkin](https://zipkin.io/) as the distributed tracer. -Currently, you can monitor performance at the application level using Citrix ADC. Using Citrix Observability Exporter with Citrix ADC, you can get tracing data for microservices of each application proxied by your Citrix ADC CPX, MPX, or VPX. +Currently, you can monitor performance at the application level using Citrix ADC. Using Citrix ADC Observability Exporter with Citrix ADC, you can trace data of each application proxied by Citrix ADC CPX, MPX, or VPX. ### Transaction collection and streaming support -Citrix Observability Exporter supports collecting transactions and streaming them to endpoints. Currently, Citrix Observability Exporter supports Elasticsearch and Kafka as transaction endpoints. +Citrix ADC Observability Exporter supports collecting transactions and streaming them to endpoints. Currently, Citrix ADC Observability Exporter supports Elasticsearch and Kafka as transaction endpoints. ### Time series data support -Citrix Observability Exporter supports collecting time series data (metrics) from Citrix ADC instances and exports them to Prometheus. Prometheus is a monitoring solution for storing time series data like metrics. You can then add Prometheus as a data source to Grafana and graphically view the Citrix ADC metrics and analyze the metrics. +Citrix ADC Observability Exporter supports collecting time series data (metrics) from Citrix ADC instances and exports them to Prometheus. Prometheus is a monitoring solution for storing time series data like metrics. You can then add Prometheus as a data source to Grafana and graphically view the Citrix ADC metrics and analyze the metrics. -## How does Citrix Observability Exporter work +## How does Citrix ADC Observability Exporter work -### Distributed tracing with Zipkin using Citrix Observability Exporter +### Distributed tracing with Zipkin using Citrix ADC Observability Exporter -Logstream is a Citrix-owned protocol that is used as one of the transport modes to efficiently transfer transactions from Citrix ADC instances. Citrix Observability Exporter collects tracing data as Logstream records from multiple Citrix ADCs and aggregates them. Citrix Observability Exporter converts the data into a format understood by the tracer and then uploads to the tracer (Zipkin in this case). For Zipkin, the data is converted into JSON, with Zipkin-specific key values. +Logstream is a Citrix-owned protocol that is used as one of the transport modes to efficiently transfer transactions from Citrix ADC instances. Citrix ADC Observability Exporter collects tracing data as Logstream records from multiple Citrix ADCs and aggregates them. Citrix ADC Observability Exporter converts the data into a format understood by the tracer and then uploads to the tracer (Zipkin in this case). For Zipkin, the data is converted into JSON, with Zipkin-specific key values. You can view the traces using the Zipkin user interface. However, you can also enhance the trace analysis by using [Elasticsearch](https://www.elastic.co/products/elasticsearch) and [Kibana](https://www.elastic.co/products/kibana) with Zipkin. Elasticsearch provides long-term retention of the trace data and Kibana allows you to get much deeper insight into the data. -### Citrix Observability Exporter with Elasticsearch as the transaction endpoint +### Citrix ADC Observability Exporter with Elasticsearch as the transaction endpoint -When Elasticsearch is specified as the transaction endpoint, Citrix Observability Exporter converts the data to JSON format. On the Elasticsearch server, Citrix Observability Exporter creates Elasticsearch indexes for each ADC on an hourly basis. These indexes are based on data, hour, UUID of the ADC, and the type of HTTP data (http_event or http_error). Then, Citrix Observability Exporter uploads the data in JSON format under Elastic search indexes for each ADC. All regular transactions are placed into the http_event index and any anomalies are placed into the http_error index. +When Elasticsearch is specified as the transaction endpoint, Citrix ADC Observability Exporter converts the data to JSON format. On the Elasticsearch server, Citrix ADC Observability Exporter creates Elasticsearch indexes for each ADC on an hourly basis. These indexes are based on data, hour, UUID of the ADC, and the type of HTTP data (http_event or http_error). Then, Citrix ADC Observability Exporter uploads the data in JSON format under Elasticsearch indexes for each ADC. All regular transactions are placed into the `http_event` index and anomalies are placed into the `http_error` index. -### Citrix Observability Exporter with Kafka as the transaction endpoint +### Citrix ADC Observability Exporter with Kafka as the transaction endpoint -When Kafka is specified as the transaction endpoint, Citrix Observability Exporter converts the transaction data to [Avro](http://avro.apache.org/docs/current/Avro) format and streams them to Kafka. +When Kafka is specified as the transaction endpoint, Citrix ADC Observability Exporter converts the transaction data to [Avro](http://avro.apache.org/docs/current/Avro) format and streams them to Kafka. -### Citrix Observability Exporter with Prometheus as the endpoint for time series data +### Citrix ADC Observability Exporter with Prometheus as the endpoint for time series data -When Prometheus is specified as the format for time series data, Citrix Observability Exporter collects various metrics from Citrix ADCs and converts them to appropriate Prometheus format and exports them to the Prometheus server. These metrics include counters of the virtual servers, services to which the analytics profile is bound and global counters of HTTP, TCP and so on. +When Prometheus is specified as the endpoint for time series data, Citrix ADC Observability Exporter collects various metrics from Citrix ADCs and converts them to the appropriate Prometheus format and exports them to the Prometheus server. These metrics include counters of the virtual servers, services to which the analytics profile is bound and global counters of HTTP, TCP, and so on. ## Deployment -You can deploy Citrix Observability Exporter using Kubernetes YAML. To deploy Citrix Observability Exporter using Kubernetes YAML, see [Deployment](deploy-coe.md). To deploy Citrix Observability Exporter using Helm charts, see [Deploy using Helm charts](https://github.com/citrix/citrix-helm-charts/tree/master/citrix-observability-exporter). +You can deploy Citrix ADC Observability Exporter using Kubernetes YAML. To deploy Citrix ADC Observability Exporter using Kubernetes YAML, see [Deployment](deploy-coe.md). To deploy Citrix ADC Observability Exporter using Helm charts, see [Deploy using Helm charts](https://github.com/citrix/citrix-helm-charts/tree/master/citrix-observability-exporter). ## Features ### Custom header logging -Custom header logging enables logging of all HTTP headers of a transaction and currently supported on the Kafka endpoint. -For more information, see [Custom header logging](https://github.com/citrix/citrix-observability-exporter/tree/master/custom-header). +Custom header logging enables logging of all HTTP headers of a transaction. This feature is supported on the Kafka endpoint. For more information, see [Custom header logging](https://github.com/citrix/citrix-observability-exporter/tree/master/custom-header). ### Elasticsearch support enhancements -Effective with the Citrix Observability Exporter release 1.2.001, when the Citrix Observability Exporter sends the data to the Elasticsearch server some of the fields are available in the string format. Also, index configuration options are also added for Elasticsearch. For more information on fields which are in the string format and how to configure the Elasticsearch index, see [Elasticsearch support enhancements](https://github.com/citrix/citrix-observability-exporter/blob/master/es-enhancements/README.md). \ No newline at end of file +Effective with the Citrix ADC Observability Exporter release 1.2.001, some fields are available in the string format when Citrix ADC Observability Exporter exports the data to the Elasticsearch server. Also, index configuration options are also added for Elasticsearch. For more information on the fields which are in the string format and how to configure the Elasticsearch index, see [Elasticsearch support enhancements](https://github.com/citrix/citrix-observability-exporter/blob/master/es-enhancements/README.md). \ No newline at end of file