mirror of
https://github.com/1f349/dendrite.git
synced 2024-11-25 05:01:41 +00:00
7cde99a7a7
Currently, the documentation makes use of the old names for the binary and configuration files. This updates the documentation so that users can follow the guide without issues again. These changes don't require any go unit tests because it does not modify any golang code. Signed-off-by: `Robin Westerik <gh@westerik.me>`
58 lines
1.4 KiB
Markdown
58 lines
1.4 KiB
Markdown
---
|
|
title: Setup
|
|
parent: OpenTracing
|
|
grand_parent: Development
|
|
permalink: /development/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
|
|
|
|
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 \
|
|
-p 5775:5775/udp \
|
|
-p 6831:6831/udp \
|
|
-p 6832:6832/udp \
|
|
-p 5778:5778 \
|
|
-p 16686:16686 \
|
|
-p 14268:14268 \
|
|
-p 14250:14250 \
|
|
-p 9411:9411 \
|
|
jaegertracing/all-in-one:1.18
|
|
```
|
|
|
|
## 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
|
|
jaeger:
|
|
serviceName: "dendrite"
|
|
disabled: false
|
|
rpc_metrics: true
|
|
tags: []
|
|
sampler:
|
|
type: const
|
|
param: 1
|
|
```
|
|
|
|
then run the monolith server:
|
|
|
|
```
|
|
./dendrite --tls-cert server.crt --tls-key server.key --config dendrite.yaml
|
|
```
|
|
|
|
## Checking traces
|
|
|
|
Visit <http://localhost:16686> to see traces under `DendriteMonolith`.
|