Skip to content

Commit d03194a

Browse files
VajiraPrabuddhakaVajiraPrabuddhaka
authored
docs: clarify OTLP HTTP traces endpoint (#610)
The HTTP row in the "Instrumenting Applications" table previously included a /v1/traces suffix in the endpoint URL. OpenTelemetry SDKs append that path automatically when using OTLP/HTTP, so users who copy-pasted the URL into OTEL_EXPORTER_OTLP_ENDPOINT ended up with a doubled path and silent export failures. Drop the suffix from the URL and add a note explaining the SDK behavior. Applied across the live docs and all versioned copies (v1.1.0-alpha-1, v1.0.x, v0.17.x, v0.16.x). Signed-off-by: VajiraPrabuddhaka <vajiraprabuddhaka@gmail.com>
1 parent ac623d6 commit d03194a

5 files changed

Lines changed: 34 additions & 14 deletions

File tree

‎docs/platform-engineer-guide/observability-alerting.mdx‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,10 +176,14 @@ The traces are enriched with Kubernetes metadata to support querying by OpenChor
176176

177177
Applications must be instrumented to send traces to the OpenTelemetry Collector. Configure your application to send OTLP traces to one of the following endpoints when using single-cluster mode:
178178

179-
| Protocol | Endpoint |
180-
| -------- | ------------------------------------------------------------------------------------------------ |
181-
| HTTP | `http://opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4318/v1/traces` |
182-
| gRPC | `opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4317` |
179+
| Protocol | Endpoint |
180+
| -------- | -------------------------------------------------------------------------------------- |
181+
| HTTP | `http://opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4318` |
182+
| gRPC | `opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4317` |
183+
184+
:::note
185+
OpenTelemetry SDKs append `/v1/traces` to the HTTP endpoint automatically, so configure your application with the base URL above rather than including the path explicitly.
186+
:::
183187

184188
When using multi-cluster mode, the traces are published to the observability plane through the gateway ingress of the observability plane. Configure the applications accordingly.
185189

‎versioned_docs/version-v0.16.x/operations/observability-alerting.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,13 @@ Applications must be instrumented to send traces to the OpenTelemetry Collector.
227227

228228
| Protocol | Endpoint |
229229
|----------|----------|
230-
| HTTP | `http://opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4318/v1/traces` |
230+
| HTTP | `http://opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4318` |
231231
| gRPC | `opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4317` |
232232

233+
:::note
234+
OpenTelemetry SDKs append `/v1/traces` to the HTTP endpoint automatically, so configure your application with the base URL above rather than including the path explicitly.
235+
:::
236+
233237
**Example: OpenTelemetry SDK Configuration (Go)**
234238

235239
```go

‎versioned_docs/version-v0.17.x/operations/observability-alerting.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,13 @@ Applications must be instrumented to send traces to the OpenTelemetry Collector.
227227

228228
| Protocol | Endpoint |
229229
|----------|----------|
230-
| HTTP | `http://opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4318/v1/traces` |
230+
| HTTP | `http://opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4318` |
231231
| gRPC | `opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4317` |
232232

233+
:::note
234+
OpenTelemetry SDKs append `/v1/traces` to the HTTP endpoint automatically, so configure your application with the base URL above rather than including the path explicitly.
235+
:::
236+
233237
**Example: OpenTelemetry SDK Configuration (Go)**
234238

235239
```go

‎versioned_docs/version-v1.0.x/platform-engineer-guide/observability-alerting.mdx‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,10 +176,14 @@ The traces are enriched with Kubernetes metadata to support querying by OpenChor
176176

177177
Applications must be instrumented to send traces to the OpenTelemetry Collector. Configure your application to send OTLP traces to one of the following endpoints when using single-cluster mode:
178178

179-
| Protocol | Endpoint |
180-
| -------- | ------------------------------------------------------------------------------------------------ |
181-
| HTTP | `http://opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4318/v1/traces` |
182-
| gRPC | `opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4317` |
179+
| Protocol | Endpoint |
180+
| -------- | ---------------------------------------------------------------------------------------- |
181+
| HTTP | `http://opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4318` |
182+
| gRPC | `opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4317` |
183+
184+
:::note
185+
OpenTelemetry SDKs append `/v1/traces` to the HTTP endpoint automatically, so configure your application with the base URL above rather than including the path explicitly.
186+
:::
183187

184188
When using multi-cluster mode, the traces are published to the observability plane through the gateway ingress of the observability plane. Configure the applications accordingly.
185189

‎versioned_docs/version-v1.1.0-alpha-1/platform-engineer-guide/observability-alerting.mdx‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,10 +176,14 @@ The traces are enriched with Kubernetes metadata to support querying by OpenChor
176176

177177
Applications must be instrumented to send traces to the OpenTelemetry Collector. Configure your application to send OTLP traces to one of the following endpoints when using single-cluster mode:
178178

179-
| Protocol | Endpoint |
180-
| -------- | ------------------------------------------------------------------------------------------------ |
181-
| HTTP | `http://opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4318/v1/traces` |
182-
| gRPC | `opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4317` |
179+
| Protocol | Endpoint |
180+
| -------- | ---------------------------------------------------------------------------------------- |
181+
| HTTP | `http://opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4318` |
182+
| gRPC | `opentelemetry-collector.openchoreo-observability-plane.svc.cluster.local:4317` |
183+
184+
:::note
185+
OpenTelemetry SDKs append `/v1/traces` to the HTTP endpoint automatically, so configure your application with the base URL above rather than including the path explicitly.
186+
:::
183187

184188
When using multi-cluster mode, the traces are published to the observability plane through the gateway ingress of the observability plane. Configure the applications accordingly.
185189

0 commit comments

Comments
 (0)