Merge pull request #53463 from rh-max/srvls-distributed-tracing-eventing

[SRVKE-1323] Add the Eventing distributed tracing configuration

Author: gabriel-rh

modules/serverless-jaeger-config.adoc

@@ -18,7 +18,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
 * You have access to an {product-title} account with cluster or dedicated administrator access.
 endif::[]
 
-* You have installed the {ServerlessOperatorName} and Knative Serving.
+* You have installed the {ServerlessOperatorName}, Knative Serving, and Knative Eventing.
 * You have installed the {JaegerName} Operator.
 * You have installed the OpenShift CLI (`oc`).
 * You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
@@ -39,7 +39,7 @@ metadata:
 
 . Enable tracing for Knative Serving, by editing the `KnativeServing` CR and adding a YAML configuration for tracing:
 +
-.Tracing YAML example
+.Tracing YAML example for Serving
 [source,yaml]
 ----
 apiVersion: operator.knative.dev/v1alpha1
@@ -61,6 +61,30 @@ spec:
 <3> The `zipkin-endpoint` must point to your `jaeger-collector` service endpoint. To get this endpoint, substitute the namespace where the Jaeger CR is applied.
 <4> Debugging should be set to `false`. Enabling debug mode by setting `debug: "true"` allows all spans to be sent to the server, bypassing sampling.
 
+. Enable tracing for Knative Eventing by editing the `KnativeEventing` CR:
++
+.Tracing YAML example for Eventing
+[source,yaml]
+----
+apiVersion: operator.knative.dev/v1alpha1
+kind: KnativeEventing
+metadata:
+  name: knative-eventing
+  namespace: knative-eventing
+spec:
+  config:
+    tracing:
+      sample-rate: "0.1" <1>
+      backend: zipkin <2>
+      zipkin-endpoint: "http://jaeger-collector.default.svc.cluster.local:9411/api/v2/spans" <3>
+      debug: "false" <4>
+----
++
+<1> The `sample-rate` defines sampling probability. Using `sample-rate: "0.1"` means that 1 in 10 traces are sampled.
+<2> Set `backend` to `zipkin`.
+<3> Point the `zipkin-endpoint` to your `jaeger-collector` service endpoint. To get this endpoint, substitute the namespace where the Jaeger CR is applied.
+<4> Debugging should be set to `false`. Enabling debug mode by setting `debug: "true"` allows all spans to be sent to the server, bypassing sampling.
+
 .Verification
 
 You can access the Jaeger web console to see tracing data, by using the `jaeger` route.

modules/serverless-open-telemetry.adoc

@@ -11,7 +11,7 @@
 .Prerequisites
 
 * You have access to an {product-title} account with cluster administrator access.
-* You have not yet installed the {ServerlessOperatorName} and Knative Serving. These must be installed after the {DTProductName} installation.
+* You have not yet installed the {ServerlessOperatorName}, Knative Serving, and Knative Eventing. These must be installed after the {DTProductName} installation.
 * You have installed {DTProductName} by following the {product-title} "Installing distributed tracing" documentation.
 * You have installed the OpenShift CLI (`oc`).
 * You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
@@ -77,7 +77,7 @@ cluster-collector-collector-headless            ClusterIP   None             <no
 jaeger-all-in-one-inmemory-collector-headless   ClusterIP   None             <none>        9411/TCP,14250/TCP,14267/TCP,14268/TCP   16m
 ----
 +
-These services are used to configure Jaeger and Knative Serving. The name of the Jaeger service may vary.
+These services are used to configure Jaeger, Knative Serving, and Knative Eventing. The name of the Jaeger service may vary.
 
 . Install the {ServerlessOperatorName} by following the "Installing the {ServerlessOperatorName}" documentation.
 
@@ -96,7 +96,27 @@ spec:
     tracing:
       backend: "zipkin"
       zipkin-endpoint: "http://cluster-collector-collector-headless.tracing-system.svc:9411/api/v2/spans"
-      debug: "true"
+      debug: "false"
+      sample-rate: "0.1" <1>
+----
+<1> The `sample-rate` defines sampling probability. Using `sample-rate: "0.1"` means that 1 in 10 traces are sampled.
+
+. Install Knative Eventing by creating the following `KnativeEventing` CR:
++
+.Example KnativeEventing CR
+[source,yaml]
+----
+apiVersion: operator.knative.dev/v1alpha1
+kind: KnativeEventing
+metadata:
+    name: knative-eventing
+    namespace: knative-eventing
+spec:
+  config:
+    tracing:
+      backend: "zipkin"
+      zipkin-endpoint: "http://cluster-collector-collector-headless.tracing-system.svc:9411/api/v2/spans"
+      debug: "false"
       sample-rate: "0.1" <1>
 ----
 <1> The `sample-rate` defines sampling probability. Using `sample-rate: "0.1"` means that 1 in 10 traces are sampled.