]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
docs: add tracing services documentation
authorOmri Zeneva <ozeneva@redhat.com>
Tue, 22 Mar 2022 10:19:35 +0000 (12:19 +0200)
committerOmri Zeneva <ozeneva@redhat.com>
Thu, 16 Jun 2022 09:29:58 +0000 (12:29 +0300)
Signed-off-by: Omri Zeneva <ozeneva@redhat.com>
doc/cephadm/services/index.rst
doc/cephadm/services/tracing.rst [new file with mode: 0644]

index be9b3661a9e245980c0b7e1205d1d4c413ae2799..8c51deafb2a4f574e10eec36ab72fcf32c867f6a 100644 (file)
@@ -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 (file)
index 0000000..08b7b3a
--- /dev/null
@@ -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,..
+