Update opentracing docs to reference the configuration manual rather than the configuation file. (#13076)

This commit is contained in:
Shay 2022-06-17 10:47:38 -07:00 committed by GitHub
parent d4b1c0d800
commit 3d94d07db3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 2 deletions

1
changelog.d/13076.doc Normal file
View file

@ -0,0 +1 @@
Update OpenTracing docs to reference the configuration manual rather than the configuration file.

View file

@ -57,8 +57,9 @@ https://www.jaegertracing.io/docs/latest/getting-started.
## Enable OpenTracing in Synapse
OpenTracing is not enabled by default. It must be enabled in the
homeserver config by uncommenting the config options under `opentracing`
as shown in the [sample config](./sample_config.yaml). For example:
homeserver config by adding the `opentracing` option to your config file. You can find
documentation about how to do this in the [config manual under the header 'Opentracing'](usage/configuration/config_documentation.md#opentracing).
See below for an example Opentracing configuration:
```yaml
opentracing: