From 08d7169e73da954a34099ce138abe2475857b90f Mon Sep 17 00:00:00 2001 From: Neil Alexander Date: Wed, 11 May 2022 15:38:18 +0100 Subject: [PATCH] OpenTracing --- docs/assets/css/style.scss | 3 --- docs/tracing/opentracing.md | 5 ++--- docs/tracing/setup.md | 10 +++++----- 3 files changed, 7 insertions(+), 11 deletions(-) delete mode 100644 docs/assets/css/style.scss diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss deleted file mode 100644 index 8a5ed3d8d..000000000 --- a/docs/assets/css/style.scss +++ /dev/null @@ -1,3 +0,0 @@ -footer.site-footer { - opacity: 10%; -} \ No newline at end of file diff --git a/docs/tracing/opentracing.md b/docs/tracing/opentracing.md index 1d3da5854..8528c2ba3 100644 --- a/docs/tracing/opentracing.md +++ b/docs/tracing/opentracing.md @@ -1,12 +1,11 @@ --- -title: Opentracing +title: OpenTracing has_children: true parent: Development permalink: /development/opentracing --- -Opentracing -=========== +# OpenTracing Dendrite extensively uses the [opentracing.io](http://opentracing.io) framework to trace work across the different logical components. diff --git a/docs/tracing/setup.md b/docs/tracing/setup.md index 9e4fef7a3..06f89bf85 100644 --- a/docs/tracing/setup.md +++ b/docs/tracing/setup.md @@ -1,17 +1,17 @@ --- title: Setup -parent: Opentracing +parent: OpenTracing grand_parent: Development permalink: /development/opentracing/setup --- -## OpenTracing Setup +# 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: @@ -29,7 +29,7 @@ $ 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) @@ -52,6 +52,6 @@ then run the monolith server with `--api true` to use polylith components which ./dendrite-monolith-server --tls-cert server.crt --tls-key server.key --config dendrite.yaml --api true ``` -### Checking traces +## Checking traces Visit to see traces under `DendriteMonolith`.