Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

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

Merged
merged 4 commits into from
Jun 17, 2022
Merged

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
850bc9f
update opentracing doc with reference to config manual
H-Shay Jun 15, 2022
97101a1
newsfragment
H-Shay Jun 15, 2022
b56a005
apply suggestion
H-Shay Jun 17, 2022
8542aa7
apply suggestion
H-Shay Jun 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog.d/13076.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Update opentracing docs to reference the configuration manual rather than the configuation file.

H-Shay marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 3 additions & 2 deletions docs/opentracing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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](usage/configuration/config_documentation.md)
under the header `opentracing`. See below for an example opentracing configuration:
H-Shay marked this conversation as resolved.
Show resolved Hide resolved

```yaml
opentracing:
Expand Down