doc: add warning for otlp over grpc

istio · Aug 2, 2024 · 22714ae · 22714ae
1 parent a13a2bb
commit 22714ae
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/content/en/docs/tasks/observability/distributed-tracing/opentelemetry/index.md b/content/en/docs/tasks/observability/distributed-tracing/opentelemetry/index.md
@@ -54,6 +54,21 @@ spec:
 EOF
 {{< /text >}}
 
+{{< warning >}}
+To actually receive traces, make sure your OpenTelemetry Collector service's gRPC port starts with the `grpc-` prefix, which is like:
+
+{{< text syntax=yaml >}}
+spec:
+  ports:
+    - name: grpc-otlp
+      port: 4317
+      protocol: TCP
+      targetPort: 4317
+{{< /text >}}
+
+Otherwise the traces may not be reported.
+{{< /warning >}}
+
 ### Exporting via HTTP
 
 In this example, traces will be exported via OTLP/HTTP to the OpenTelemetry Collector.