zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zebra/book/src/user/tracing.md

41 lines
1.7 KiB
Markdown
Raw Normal View History

Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
# Tracing Zebra
breaking(diagnostics): make zebrad diagnostics into optional compile-time features (#4539) * Disable the flamegraph feature by default at compile time * Disable the journald feature by default at compile time * Also disable inferno dependency, and rearrange features * Disable the prometheus feature by default at compile time * Disable the tracing filter reload feature by default at compile time * Disable tests when corresponding features are disabled * Add compile-time tracing features to user docs * Add compile-time features to the metrics user docs * Document diagnostics as part of the start command tasks and services * breaking(diagnostics): rename "enable-sentry" feature to "sentry" (#4623) * Also skip conflict tests when those ports are disabled * breaking(diagnostics): rename "enable-sentry" feature to "sentry" This is mostly: ```sh fastmod enable-sentry sentry ``` Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2022-06-16 12:56:40 -07:00
## Dynamic Tracing
Fix up links in some tracing docs (#4748) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2022-07-22 09:32:56 -07:00
Zebra supports dynamic tracing, configured using the config's
breaking(diagnostics): make zebrad diagnostics into optional compile-time features (#4539) * Disable the flamegraph feature by default at compile time * Disable the journald feature by default at compile time * Also disable inferno dependency, and rearrange features * Disable the prometheus feature by default at compile time * Disable the tracing filter reload feature by default at compile time * Disable tests when corresponding features are disabled * Add compile-time tracing features to user docs * Add compile-time features to the metrics user docs * Document diagnostics as part of the start command tasks and services * breaking(diagnostics): rename "enable-sentry" feature to "sentry" (#4623) * Also skip conflict tests when those ports are disabled * breaking(diagnostics): rename "enable-sentry" feature to "sentry" This is mostly: ```sh fastmod enable-sentry sentry ``` Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2022-06-16 12:56:40 -07:00
[`TracingSection`][tracing_section] and an HTTP RPC endpoint.
Activate this feature using the `filter-reload` compile-time feature,
and the [`filter`][filter] and `endpoint_addr` runtime config options.
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
If the `endpoint_addr` is specified, `zebrad` will open an HTTP endpoint
allowing dynamic runtime configuration of the tracing filter. For instance,
if the config had `endpoint_addr = '127.0.0.1:3000'`, then
* `curl -X GET localhost:3000/filter` retrieves the current filter string;
* `curl -X POST localhost:3000/filter -d "zebrad=trace"` sets the current filter string.
See the [`filter`][filter] documentation for more details.
breaking(diagnostics): make zebrad diagnostics into optional compile-time features (#4539) * Disable the flamegraph feature by default at compile time * Disable the journald feature by default at compile time * Also disable inferno dependency, and rearrange features * Disable the prometheus feature by default at compile time * Disable the tracing filter reload feature by default at compile time * Disable tests when corresponding features are disabled * Add compile-time tracing features to user docs * Add compile-time features to the metrics user docs * Document diagnostics as part of the start command tasks and services * breaking(diagnostics): rename "enable-sentry" feature to "sentry" (#4623) * Also skip conflict tests when those ports are disabled * breaking(diagnostics): rename "enable-sentry" feature to "sentry" This is mostly: ```sh fastmod enable-sentry sentry ``` Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2022-06-16 12:56:40 -07:00
## `journald` Logging
Zebra can send tracing spans and events to [systemd-journald][systemd_journald],
on Linux distributions that use `systemd`.
Activate `journald` logging using the `journald` compile-time feature,
and the [`use_journald`][use_journald] runtime config option.
## Flamegraphs
Zebra can generate [flamegraphs] of tracing spans.
Add journald support through tracing-journald (#2034) * Add journald support through tracing-journald * change journald to use_journald * more fixes
2021-04-21 16:31:06 -07:00
breaking(diagnostics): make zebrad diagnostics into optional compile-time features (#4539) * Disable the flamegraph feature by default at compile time * Disable the journald feature by default at compile time * Also disable inferno dependency, and rearrange features * Disable the prometheus feature by default at compile time * Disable the tracing filter reload feature by default at compile time * Disable tests when corresponding features are disabled * Add compile-time tracing features to user docs * Add compile-time features to the metrics user docs * Document diagnostics as part of the start command tasks and services * breaking(diagnostics): rename "enable-sentry" feature to "sentry" (#4623) * Also skip conflict tests when those ports are disabled * breaking(diagnostics): rename "enable-sentry" feature to "sentry" This is mostly: ```sh fastmod enable-sentry sentry ``` Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2022-06-16 12:56:40 -07:00
Activate flamegraphs using the `flamegraph` compile-time feature,
and the [`flamegraph`][flamegraph] runtime config option.
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
[tracing_section]: https://doc.zebra.zfnd.org/zebrad/config/struct.TracingSection.html
[filter]: https://doc.zebra.zfnd.org/zebrad/config/struct.TracingSection.html#structfield.filter
[flamegraph]: https://doc.zebra.zfnd.org/zebrad/config/struct.TracingSection.html#structfield.flamegraph
[flamegraphs]: http://www.brendangregg.com/flamegraphs.html
Add journald support through tracing-journald (#2034) * Add journald support through tracing-journald * change journald to use_journald * more fixes
2021-04-21 16:31:06 -07:00
[systemd_journald]: https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html
[use_journald]: https://doc.zebra.zfnd.org/zebrad/config/struct.TracingSection.html#structfield.use_journald