Skip to content

Commit f4d9a2f

Browse files
authored
Merge pull request #13 from citrix/devdocs
added links for helm charts and custom header logging feature
2 parents a3988a0 + d9c2c0a commit f4d9a2f

4 files changed

Lines changed: 18 additions & 4 deletions

File tree

README.md

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

99
- [Zipkin](https://zipkin.io/)
1010
- [Kafka](https://kafka.apache.org/)
11-
- [Elasticsearch](https://www.elastic.co/products/elasticsearch)
11+
- [Elasticsearch](https://www.elastic.co/products/elasticsearch)
1212
- [Prometheus](https://prometheus.io/docs/introduction/overview/)
1313

1414
## Overview
@@ -53,7 +53,14 @@ When Prometheus is specified as the format for time series data, Citrix Observab
5353

5454
## Deployment
5555

56-
You can deploy Citrix Observability Exporter using Kubernetes YAML or Helm charts. To deploy Citrix Observability Exporter using Kubernetes YAML, see [Deployment](deployment/README.md).
56+
You can deploy Citrix Observability Exporter using Kubernetes YAML or Helm charts. To deploy Citrix Observability Exporter using Kubernetes YAML, see [Deployment](deployment/README.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).
57+
58+
## Features
59+
60+
### Custom header logging
61+
62+
Custom header logging enables logging of all HTTP headers of a transaction and currently supported on the Kafka endpoint.
63+
For more information, see [Custom header logging](https://github.com/citrix/citrix-observability-exporter/tree/master/custom-header).
5764

5865
## Questions
5966

deployment/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Deploy Citrix Observability Exporter
22

33
This topic provides information on how to deploy Citrix Observability Exporter using Kubernetes YAML files.
4+
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).
45
<!---
56
You can deploy Citrix Observability Exporter using Kubernetes YAML files or using Helm charts.
67
-->

docs/deploy-coe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Deploy Citrix Observability Exporter
22

3-
This topic provides information on how to deploy Citrix Observability Exporter using Kubernetes YAML files.
3+
This topic provides information on how to deploy Citrix Observability Exporter using Kubernetes YAML files. 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).
44
<!---
55
You can deploy Citrix Observability Exporter using Kubernetes YAML files.
66
-->

docs/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,11 @@ When Prometheus is specified as the format for time series data, Citrix Observab
5454

5555
## Deployment
5656

57-
You can deploy Citrix Observability Exporter using Kubernetes YAML. To deploy Citrix Observability Exporter using Kubernetes YAML, see [Deployment](deploy-coe.md).
57+
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).
5858

59+
## Features
60+
61+
### Custom header logging
62+
63+
Custom header logging enables logging of all HTTP headers of a transaction and currently supported on the Kafka endpoint.
64+
For more information, see [Custom header logging](https://github.com/citrix/citrix-observability-exporter/tree/master/custom-header).

0 commit comments

Comments
 (0)