New documentation: https://matrix-org.github.io/dendrite/

docs/tracing/setup.md

@@ -1,14 +1,20 @@
-## OpenTracing Setup
+---
+title: Setup
+parent: OpenTracing
+grand_parent: Development
+permalink: /development/opentracing/setup
+---
 
-![Trace when sending an event into a room](/docs/tracing/jaeger.png)
+# OpenTracing Setup
 
 Dendrite uses [Jaeger](https://www.jaegertracing.io/) for tracing between microservices.
 Tracing shows the nesting of logical spans which provides visibility on how the microservices interact.
 This document explains how to set up Jaeger locally on a single machine.
 
-### Set up the Jaeger backend
+## Set up the Jaeger backend
 
 The [easiest way](https://www.jaegertracing.io/docs/1.18/getting-started/) is to use the all-in-one Docker image:
+
 ```
 $ docker run -d --name jaeger \
   -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
@@ -23,9 +29,10 @@ $ docker run -d --name jaeger \
   jaegertracing/all-in-one:1.18
 ```
 
-### Configuring Dendrite to talk to Jaeger
+## Configuring Dendrite to talk to Jaeger
 
 Modify your config to look like: (this will send every single span to Jaeger which will be slow on large instances, but for local testing it's fine)
+
 ```
 tracing:
   enabled: true
@@ -40,10 +47,11 @@ tracing:
 ```
 
 then run the monolith server with `--api true` to use polylith components which do tracing spans:
+
 ```
-$ ./dendrite-monolith-server --tls-cert server.crt --tls-key server.key --config dendrite.yaml --api true
+./dendrite-monolith-server --tls-cert server.crt --tls-key server.key --config dendrite.yaml --api true
 ```
 
-### Checking traces
+## Checking traces
 
-Visit http://localhost:16686 to see traces under `DendriteMonolith`.
+Visit <http://localhost:16686> to see traces under `DendriteMonolith`.