This is an automated email from the ASF dual-hosted git repository.
sarvekshayr pushed a commit to branch HDDS-9225-website-v2
in repository https://gitbox.apache.org/repos/asf/ozone-site.git
The following commit(s) were added to refs/heads/HDDS-9225-website-v2 by this
push:
new 1e08244df HDDS-14263. [Website v2] [Docs] [Administrator Guide]
Distributed tracing (#184)
1e08244df is described below
commit 1e08244dfa9c7f28d1c2d211fa5061fe14a64e31
Author: Eric C. Ho <[email protected]>
AuthorDate: Wed Dec 31 18:08:31 2025 +0800
HDDS-14263. [Website v2] [Docs] [Administrator Guide] Distributed tracing
(#184)
---
.../09-observability/06-distributed-tracing.md | 27 ++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git
a/docs/05-administrator-guide/03-operations/09-observability/06-distributed-tracing.md
b/docs/05-administrator-guide/03-operations/09-observability/06-distributed-tracing.md
new file mode 100644
index 000000000..6aff0ea70
--- /dev/null
+++
b/docs/05-administrator-guide/03-operations/09-observability/06-distributed-tracing.md
@@ -0,0 +1,27 @@
+---
+sidebar_label: Distributed tracing
+---
+
+# Distributed tracing
+
+Distributed tracing can help to understand performance bottleneck with
visualizing end-to-end performance.
+Ozone makes use of [OpenTelemetry](https://opentelemetry.io/) API for tracing
and uses OTLP with gRPC format for sending traces.
+[jaeger](https://jaegertracing.io) tracing library as collector can collect
traces from Ozone over default port 4317 (as default).
+
+Tracing is turned off by default, but can be turned on with
`hdds.tracing.enabled` from `ozone-site.xml`
+
+```xml
+<property>
+ <name>hdds.tracing.enabled</name>
+ <value>true</value>
+</property>
+```
+
+Below are the configuration steps for setting the collector endpoint and
sampling strategy. Set these environment variables to be set for each Ozone
component (OM, SCM, Datanode) and for the Ozone client to enable tracing.
+
+```env
+OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
+OTEL_TRACES_SAMPLER_ARG=0.01
+```
+
+This configuration will record 1% of the requests to limit the performance
overhead.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
