change(doc): Refactor docs for feature flags (#7567)
* Update links in Tracing section * Move Sentry to Tracing section * Refactor the section on features in `README.md` - I tried to keep only the most relevant features for users. - I tried using links that lead to the most descriptive pages. These changes are subjective. * Remove the networking section from `README.md` The network requirements are well documented in section System Requirements in the Zebra book. The readme already points to this section in a link in section Getting Started. The motivation for this change is to keep the readme short. * Update README.md Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com> --------- Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com>
This commit is contained in:
Marek
GitHub
parent
4f6d28f9b1
commit
a652e2e257
20
README.md
20
README.md
|
|
@ -12,7 +12,6 @@
|
|||
- [Docker](#docker)
|
||||
- [Building Zebra](#building-zebra)
|
||||
- [Optional Features](#optional-features)
|
||||
- [Network Ports](#network-ports)
|
||||
- [Known Issues](#known-issues)
|
||||
- [Future Work](#future-work)
|
||||
- [Documentation](#documentation)
|
||||
|
|
@ -121,10 +120,11 @@ sections in the book for more details.
|
|||
|
||||
You can also build Zebra with additional [Cargo features](https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options):
|
||||
|
||||
- `sentry` for [Sentry monitoring](https://zebra.zfnd.org/user/requirements.html#sentry-production-monitoring)
|
||||
- `journald` for [`journald` logging](https://zebra.zfnd.org/user/tracing.html#journald-logging)
|
||||
- `prometheus` for [Prometheus metrics](https://doc.zebra.zfnd.org/zebrad/#metrics)
|
||||
- `getblocktemplate-rpcs` for [mining support](https://zebra.zfnd.org/user/mining.html)
|
||||
- `prometheus` for [Prometheus metrics](https://zebra.zfnd.org/user/metrics.html)
|
||||
- `progress-bar` [experimental progress bars](https://zfnd.org/experimental-zebra-progress-bars/)
|
||||
- `sentry` for [Sentry monitoring](https://zebra.zfnd.org/user/tracing.html#sentry-production-monitoring)
|
||||
- `elasticsearch` for [experimental Elasticsearch support](https://zebra.zfnd.org/user/elasticsearch.html)
|
||||
|
||||
You can combine multiple features by listing them as parameters of the `--features` flag:
|
||||
|
||||
|
|
@ -138,17 +138,6 @@ documentation](https://doc.zebra.zfnd.org/zebrad/index.html#zebra-feature-flags)
|
|||
Some debugging and monitoring features are disabled in release builds to increase
|
||||
performance.
|
||||
|
||||
### Network Ports
|
||||
|
||||
Zebra uses the following inbound and outbound TCP ports:
|
||||
|
||||
- 8233 on Mainnet
|
||||
- 18233 on Testnet
|
||||
|
||||
Please see the [Network
|
||||
Requirements](https://zebra.zfnd.org/user/requirements.html#network-requirements-and-ports)
|
||||
section of the Zebra book for more details.
|
||||
|
||||
## Known Issues
|
||||
|
||||
There are a few bugs in Zebra that we're still working on fixing:
|
||||
|
|
@ -165,7 +154,6 @@ There are a few bugs in Zebra that we're still working on fixing:
|
|||
|
||||
- Experimental Tor support is disabled until [Zebra upgrades to the latest `arti-client`](https://github.com/ZcashFoundation/zebra/issues/5492). This happened due to a Rust dependency conflict, which could only be resolved by `arti` upgrading to a version of `x25519-dalek` with the dependency fix.
|
||||
|
||||
|
||||
## Future Work
|
||||
|
||||
We will continue to add new features as part of future network upgrades, and in response to community feedback.
|
||||
|
|
|
|||
|
|
@ -54,7 +54,3 @@ so some version upgrades might require a full download of the whole chain.
|
|||
Zebra needs some peers which have a round-trip latency of 2 seconds or less. If
|
||||
this is a problem for you, please [open a
|
||||
ticket.](https://github.com/ZcashFoundation/zebra/issues/new/choose)
|
||||
|
||||
## Sentry Production Monitoring
|
||||
|
||||
Compile Zebra with `--features sentry` to monitor it using Sentry in production.
|
||||
|
|
|
|||
|
|
@ -32,9 +32,14 @@ Zebra can generate [flamegraphs] of tracing spans.
|
|||
Activate flamegraphs using the `flamegraph` compile-time feature,
|
||||
and the [`flamegraph`][flamegraph] runtime config option.
|
||||
|
||||
[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
|
||||
## Sentry Production Monitoring
|
||||
|
||||
Compile Zebra with `--features sentry` to monitor it using [Sentry][sentry] in production.
|
||||
|
||||
[tracing_section]: https://doc.zebra.zfnd.org/zebrad/components/tracing/struct.Config.html
|
||||
[filter]: https://doc.zebra.zfnd.org/zebrad/components/tracing/struct.Config.html#structfield.filter
|
||||
[flamegraph]: https://doc.zebra.zfnd.org/zebrad/components/tracing/struct.Config.html#structfield.flamegraph
|
||||
[flamegraphs]: http://www.brendangregg.com/flamegraphs.html
|
||||
[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
|
||||
[use_journald]: https://doc.zebra.zfnd.org/zebrad/components/tracing/struct.Config.html#structfield.use_journald
|
||||
[sentry]: https://sentry.io/welcome/
|
||||
|
|
|
|||
Loading…
Reference in New Issue