From: Omri Zeneva <ozeneva@redhat.com>
Date: Tue, 22 Mar 2022 10:19:35 +0000 (+0200)
Subject: docs: add tracing services documentation
X-Git-Tag: v18.0.0~592^2~6
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=83b8912e1bb1ac8c5af129245179ede77e01c127;p=ceph-ci.git

docs: add tracing services documentation

Signed-off-by: Omri Zeneva <ozeneva@redhat.com>
---

diff --git a/doc/cephadm/services/index.rst b/doc/cephadm/services/index.rst
index be9b3661a9e..8c51deafb2a 100644
--- a/doc/cephadm/services/index.rst
+++ b/doc/cephadm/services/index.rst
@@ -18,6 +18,7 @@ for details on individual services:
     custom-container
     monitoring
     snmp-gateway
+    tracing
 
 Service Status
 ==============
diff --git a/doc/cephadm/services/tracing.rst b/doc/cephadm/services/tracing.rst
new file mode 100644
index 00000000000..08b7b3ad2c3
--- /dev/null
+++ b/doc/cephadm/services/tracing.rst
@@ -0,0 +1,45 @@
+================
+Tracing Services
+================
+
+.. _cephadm-tracing:
+
+
+Jaeger Tracing
+==============
+
+Ceph uses Jaeger as the tracing backend. in order to use tracing, we need to deploy those services.
+
+Further details on tracing in ceph:
+
+`Ceph Tracing documentation <https://docs.ceph.com/en/latest/jaegertracing/#jaeger-distributed-tracing/>`_
+
+Deployment
+==========
+
+Jaeger services consist of 3 services:
+
+1. Jaeger Agent
+
+2. Jaeger Collector
+
+3. Jaeger Query
+
+Jaeger requires a database for the traces. we use ElasticSearch by default.
+
+
+To deploy jaeger tracing service, without ElasticSearch:
+
+#. Deploy jaeger services, with a new elasticsearch container:
+
+    .. prompt:: bash #
+
+        ceph orch apply jaeger
+
+
+#. Deploy jaeger services, with existing elasticsearch cluster:
+
+     .. prompt:: bash #
+
+        ceph orch apply jaeger -es_nodes=ip:port,..
+