Skip to content

Commit 043a6e6

Browse files
authored
Merge pull request #54 from citrix/prometheus-fix
changes for prometheus fix
2 parents b30d348 + ea6fd34 commit 043a6e6

1 file changed

Lines changed: 30 additions & 8 deletions

File tree

docs/deploy-coe-with-prometheus.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
You can configure Prometheus as an endpoint to pull data from Citrix ADC Observability Exporter. You can also configure Grafana to visualize the same data graphically.
44

5-
Citrix ADC Observability Exporter has a push-gateway server that listens to port 5563 to serve metrics based on pull requests from Prometheus. Citrix ADC Observability Exporter exports time series data to Prometheus.
5+
Citrix ADC Observability Exporter has a push-gateway server that listens to port 5563 to serve metrics based on pull requests from Prometheus. Citrix ADC Observability Exporter exports time series data to Prometheus.
66

77
![Prometheus and Grafana architecture](media/coe-prometheus-grafana-architecture.png)
88

@@ -80,20 +80,42 @@ To deploy Prometheus and Grafana using YAML files, perform the following steps:
8080
kubectl create -f prometheus-grafana.yaml
8181

8282
**Note**: Prometheus and Grafana are deployed in the default namespace of the same Kubernetes cluster.
83-
83+
8484
### Deploy Citrix ADC Observability Exporter using the YAML file
8585

8686
You can deploy Citrix ADC Observability Exporter using the YAML file. Download the YAML file from [coe-prometheus.yaml](https://raw.githubusercontent.com/citrix/citrix-observability-exporter/master/examples/prometheus/coe-prometheus.yaml).
8787

88-
To deploy Citrix ADC Observability Exporter using the Kubernetes YAML, run the following command:
89-
90-
kubectl create -f coe-prometheus.yaml
88+
- For Citrix ADC Observability Exporter version 1.3.001 and previous versions, you can use the ConfigMap configuration provided in the `coe-prometheus.yaml` YAML file.
89+
90+
- For Citrix ADC Observability Exporter version 1.4.001, you need to modify the ConfigMap in the `coe-prometheus.yaml` file as follows before deployment.
91+
9192

92-
**Note**: Modify the YAML file for Citrix ADC Observability Exporter if you have a custom namespace.
93+
apiVersion: v1
94+
kind: ConfigMap
95+
metadata:
96+
name: coe-config-prometheus
97+
data:
98+
lstreamd_default.conf: |
99+
{
100+
101+
"Endpoints": {
102+
"ZIPKIN": {
103+
"ServerUrl":"http://0.0.0.0:0",
104+
"RecordType":{},
105+
"PrometheusMode":"yes"
106+
}
107+
}
108+
}
109+
110+
To deploy Citrix ADC Observability Exporter using the Kubernetes YAML, run the following command.
111+
112+
kubectl create -f coe-prometheus.yaml
93113

114+
**Note**: Modify the YAML file for Citrix ADC Observability Exporter if you have a custom namespace.
115+
94116
### Configure Citrix ADC to export metrics (optional)
95117

96-
**Note**: If you do not use CIC to configure, then you can do the following manual configuration on your Citrix ADC.
118+
**Note**: If you do not use Citrix ingress controller to configure Citrix ADC, then you can do the following manual configuration on your Citrix ADC.
97119

98120
You can manually configure Citrix ADCs to export metrics to the Citrix ADC Observability exporter. Specify the Citrix ADC Observability Exporter IP/FQDN address as an HTTP service and combine it to the default `ns_analytics_time_series_profile` analytics profile. Enable the metrics export and set the output mode to Prometheus.
99121

@@ -126,7 +148,7 @@ In the current deployment, a Prometheus server has already been added as a data
126148

127149
You can create a Grafana dashboard and select the key metrics and the visualization type that is suitable for the data.
128150

129-
The following procedure shows adding of the ADC CPU metric to a Grafana panel:
151+
The following procedure shows how to add the ADC CPU metric to a Grafana panel:
130152

131153
1. Specify the Panel Title as *ADC CPU*.
132154
2. In the Query tab, for the query A, specify the metric as *cpu_use*.

0 commit comments

Comments
 (0)