doc: add warning for otlp over grpc

istio · Aug 5, 2024 · 99a17d8 · 99a17d8
1 parent a13a2bb
commit 99a17d8
Show file tree

Hide file tree

Showing 2 changed files with 24 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.

diff --git a/content/en/docs/tasks/observability/distributed-tracing/opentelemetry/snips.sh b/content/en/docs/tasks/observability/distributed-tracing/opentelemetry/snips.sh
@@ -22,6 +22,15 @@
 source "content/en/boilerplates/snips/start-otel-collector-service.sh"
 source "content/en/boilerplates/snips/trace-generation.sh"
 
+! IFS=$'\n' read -r -d '' snip_exporting_via_grpc_2 <<\ENDSNIP
+spec:
+  ports:
+    - name: grpc-otlp
+      port: 4317
+      protocol: TCP
+      targetPort: 4317
+ENDSNIP
+
 snip_install_otlp_http() {
 cat <<EOF | istioctl install --set values.pilot.env.PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING=true -y -f -
 apiVersion: install.istio.io/v1alpha1