Skip to content

Commit

Permalink
Add dollar signs to commands in observability.md (MystenLabs#1619)
Browse files Browse the repository at this point in the history
Also break the command in the Jaeger steps into separate lines
  • Loading branch information
Clay-Mysten authored May 2, 2022
1 parent 1170dba commit f5543e8
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions doc/src/contribute/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,12 +176,18 @@ Also notice `elapsed_milliseconds` which logs the duration of each span.

To see nested spans visualized with [Jaeger](https://www.jaegertracing.io), do the following:

1. Run this to get a local Jaeger container: `docker run -d -p6831:6831/udp -p6832:6832/udp -p16686:16686 jaegertracing/all-in-one:latest`.
1. Run Sui like this (trace enables the most detailed spans): `SUI_TRACING_ENABLE=1 RUST_LOG="info,sui_core=trace" ./sui start`.
1. Run this to get a local Jaeger container:
```shell
$ docker run -d -p6831:6831/udp -p6832:6832/udp -p16686:16686 jaegertracing/all-in-one:latest
```
1. Run Sui like this (trace enables the most detailed spans):
```shell
$ SUI_TRACING_ENABLE=1 RUST_LOG="info,sui_core=trace" ./sui start
```
1. Run some transfers with wallet, or run the benchmarking tool.
1. Browse to `http://localhost:16686/` and select Sui as the Service.
4. Browse to `http://localhost:16686/` and select Sui as the service.

NOTE: separate spans (which are not nested) are not connected as a single trace for now.
> **Note:** Separate spans (which are not nested) are not connected as a single trace for now.
### Live async inspection / Tokio Console

Expand All @@ -191,4 +197,4 @@ NOTE: separate spans (which are not nested) are not connected as a single trace
2. Start Sui with `SUI_TOKIO_CONSOLE` set to 1.
3. Clone the console repo and `cargo run` to launch the console.

NOTE: Adding Tokio-console support may significantly slow down Sui validators/gateways.
> **Note:** Adding Tokio-console support may significantly slow down Sui validators/gateways.

0 comments on commit f5543e8

Please sign in to comment.