mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-15 03:25:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add docs on how to use tracing for local Node dev

Browse Source
This commit is contained in:
Andrew Ferrazzutti
2023-06-16 11:51:10 -04:00
parent ef0c230bd3
commit bb1bfbcb48
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
bindings/matrix-sdk-crypto-nodejs/README.md
View File

@@ -184,6 +184,20 @@ See
[`tracing-subscriber`](https://tracing.rs/tracing_subscriber/index.html)
to learn more about the `RUST_LOG`/`MATRIX_LOG` environment variable.
#### Using tracing in a development environment
To use tracing in client applications that import these bindings, here's how to do it in
a local development environment:
- In this directory, run `npm link` to make your local build of the bindings available to
other Node projects on your system
- In your client app's source directory, run `npm link @matrix-org/matrix-sdk-crypto-nodejs`
to make it use your trace-enabled local build of the bindings
- In your client app's source code, add a call to `initTracing` near startup time
- Run your app with the `MATRIX_LOG` environment variable set to the desired log level
Either `npm link` command may be substituted with `yarn link`.
## Documentation
[The documentation can be found