Skip to content

Commit 96bb252

Browse files
committed
docs: added snippet for exposing OTEL collector
1 parent 4b5107a commit 96bb252

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,38 @@ hyperdx:
106106
otelExporterEndpoint: "http://your-otel-collector:4318"
107107
```
108108
109+
#### Configuring Ingress for OTEL Collector
110+
111+
If you need to expose your OTEL collector endpoints through ingress, you can use the additional ingresses configuration. The example below uses a regex pattern to capture all OTLP endpoints (traces, metrics, and logs) in a single path rule:
112+
113+
```yaml
114+
hyperdx:
115+
ingress:
116+
enabled: true
117+
additionalIngresses:
118+
- name: otel-collector
119+
annotations:
120+
nginx.ingress.kubernetes.io/ssl-redirect: "false"
121+
nginx.ingress.kubernetes.io/force-ssl-redirect: "false"
122+
nginx.ingress.kubernetes.io/use-regex: "true"
123+
hosts:
124+
- host: collector.yourdomain.com
125+
paths:
126+
- path: /v1/(traces|metrics|logs)
127+
pathType: Prefix
128+
port: 4318
129+
tls:
130+
- hosts:
131+
- collector.yourdomain.com
132+
secretName: collector-tls
133+
```
134+
135+
This configuration creates a separate ingress resource for the OTEL collector endpoints, allowing you to:
136+
- Use a different domain for collector traffic
137+
- Configure specific TLS settings
138+
- Apply custom annotations for the collector ingress
139+
- Route all telemetry signals through a single regex-based path rule
140+
109141
### Minimal Deployment
110142
111143
For organizations with existing infrastructure:
@@ -285,7 +317,7 @@ helm install my-hyperdx hyperdx/hdx-oss-v2 \
285317
# values-gke.yaml
286318
hyperdx:
287319
appUrl: "http://34.123.61.99" # Use your LoadBalancer external IP
288-
320+
289321
otel:
290322
opampServerUrl: "http://my-hyperdx-hdx-oss-v2-app.default.svc.cluster.local:4320"
291323

0 commit comments

Comments
 (0)