citrix/citrix-observability-exporter

Chart version: 1.2.001
Api version: v2
App version: 1.2.001
A Helm chart for Citrix Observability Exporter
application
Chart Type
Active
Status
Unknown
License
341
Downloads
https://citrix.github.io/citrix-helm-charts
Set me up:
helm repo add center https://repo.chartcenter.io
Install Chart:
helm install citrix-observability-exporter center/citrix/citrix-observability-exporter
Versions (0)

Citrix 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 like Elasticsearch, Kafka, Tracer, Prometheus. 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.

TL; DR;

   helm repo add citrix https://citrix.github.io/citrix-helm-charts/
   
   For Kafka as endpoint with timeseries enabled:
   helm install coe citrix/citrix-observability-exporter --set kafka.enabled=true --set kafka.broker="X.X.X.X\,Y.Y.Y.Y" --set kafka.topic=HTTP --set timeseries.enabled=true

   For Elasticsearch as endpoint and Tracing enabled:
   helm install coe citrix/citrix-observability-exporter --set elasticsearch.enabled=true --set elasticsearch.server=elasticsearch:9200 --set ns_tracing.enabled=true

Introduction

This Helm chart deploys Citrix Observability Exporter in the Kubernetes cluster using Helm package manager.

Prerequisites

  • The Kubernetes version 1.6 or later if using Kubernetes environment.

  • The Helm version is 3.x or later. You can follow instruction given here to install Helm in Kubernetes environment.

    • To enable Tracing, set ns_tracing.enabled to true and ns_tracing.server to the tracer endpoint like zipkin.default.cluster.svc.local:9411/api/v1/spans. Default value for Zipkin server is zipkin:9411/api/v1/spans.

    • To enable Elasticsearch endpoint for transactions, set elasticsearch.enabled to true and server to the elasticsearch endpoint like elasticsearch.default.svc.cluster.local:9200. Default value for Elasticsearch endpoint is elasticsearch:9200.

    • To enable Kafka endpoint for transactions, set kafka.enabled to true, kafka.broker to kafka broker IPs and kafka.topic. Default value for kafka topic is HTTP.

    • To enable Timeseries data upload in prometheus format, set timeseries.enabled to true

Installing the Chart

Add the Citrix Observability Exporter helm chart repository using command:

   helm repo add citrix https://citrix.github.io/citrix-helm-charts/

For Kubernetes:

1. Citrix Observability Exporter

To install the chart with the release name, my-release, use the following command, after setting the required endpoint in values.yaml:

    helm install my-release citrix/citrix-observability-exporter

Important:

Citrix Observability Exporter is exposed using Nodeport 30001 and 30002 by default. Please make sure these ports are available for use in your cluster before deploying this helm chart.

Configuration

The following table lists the mandatory and optional parameters that you can configure during installation:

Parameters Mandatory or Optional Default value Description
license.accept Mandatory no Set yes to accept the CIC end user license agreement.
image Mandatory quay.io/citrix/citrix-observability-exporter:1.1.001 The COE image.
pullPolicy Mandatory IfNotPresent The COE image pull policy.
transaction.nodePort Optional 30001 Specify the port used to expose COE service outside cluster for transaction endpoint.
ns_tracing.enabled Optional false Set true to enable sending trace data to tracing server.
ns_tracing.server Optional zipkin:9411/api/v1/spans The tracing server api endpoint.
elasticsearch.enabled Optional false Set true to enable sending transaction data to elasticsearch server.
elasticsearch.server Optional elasticsearch:9200 The Elasticsearch server api endpoint.
kafka.enabled Optional false Set true to enable sending transaction data to kafka server.
kafka.broker Optional The kafka broker IP details.
kafka.topic Optional HTTP The kafka topic details to upload data.
timeseries.enabled Optional false Set true to enable sending timeseries data to prometheus.
timeseries.nodePort Optional 30002 Specify the port used to expose COE service outside cluster for timeseries endpoint.

Alternatively, you can define a YAML file with the values for the parameters and pass the values while installing the chart.

For example:

   helm install my-release citrix/citrix-observability-exporter -f values.yaml

Tip:

The values.yaml contains the default values of the parameters.

Uninstalling the Chart

To uninstall/delete the my-release deployment:

   helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Related documentation