Commit Graph

3 Commits (e3d9454f8ade71a879bb9dd5fa925f1eaf2c6bd6)

Author SHA1 Message Date
Raphael Taylor-Davies 826d50f14a
chore: update tracing and logging docs (#2657)
* chore: update tracing and logging docs

* chore: review feedback

* chore: add log-format to basic usage section
2021-09-30 08:46:23 +00:00
Dom 41f5099691 refactor: compile out trace! level for release builds
Configures the IOx tracing to compile out trace!() level events in the release
binary. This effectively gives contributors three levels of output:

* Important to the user (info & friends)
* Not important for regular running, but needed to debug
* Only useful to devs in a specific part of the system, never seen by user

Documents this behaviour (and general usage guidelines) for contributors.
2020-12-14 12:06:53 +00:00
Dom 80da024212 docs(tracing): add IOx tracing usage doc
Describes the components involved in, and usage of the tracing system in IOx.
2020-12-14 12:06:53 +00:00