Added jaeger readme (#28)

osstotalsoft · Nov 24, 2021 · 5d8625b · 5d8625b
1 parent 3279b6a
commit 5d8625b
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/examples/components/config-node-pipeline.yaml b/examples/components/config-node-pipeline.yaml
@@ -8,7 +8,7 @@ spec:
   tracing:
     samplingRate: '1'
     jaeger:
-      useAgent: true
+      useAgent: false
       collectorEndpointAddress: 'http://kube-worker1.totalsoft.local:31034/api/traces'
   subscriberPipeline:
     handlers:

diff --git a/internal/tracing/Readme.md b/internal/tracing/Readme.md
@@ -0,0 +1,26 @@
+
+## Jaeger config
+* `useAgent` (bool) set to true if using a Jaeger Agent
+* `collectorEndpointAddress` the Jaeger Collector Endpoint. Set only if `useAgent` is false, to send the tracing data directly to the collector.
+
+Example:
+
+```yaml
+  tracing:
+    samplingRate: '1'
+    jaeger:
+      useAgent: false
+      collectorEndpointAddress: 'http://kube-worker1.totalsoft.local:31034/api/traces'
+
+```
+
+## Development environment
+On the development environment we can configure Jaeger to send data directly to the collector.
+
+Alternatively we can install a jaeger agent on the local machine:
+
+```cmd
+docker pull jaegertracing/jaeger-agent:1.12.0
+
+docker run -it -p 6831:6831/udp jaegertracing/jaeger-agent:1.12.0 --collector.host-port='kube-worker1.totalsoft.local:31335'
+```