Add link compression tutorial #881
Conversation
mDuo13
commented
Aug 3, 2020
mDuo13
commented
- Add tutorial for enabling link compression as introduced in Protocol message compression support rippled#3287
- Add mention of the tutorial to Capacity Planning document
- Move metadata to frontmatter for the two affected pages
There was a problem hiding this comment.
Looks good. One question. Does it make sense to mention that a subset of protocol messages is compressed? We only attempt to compress the following messages: protocol::mtMANIFESTS, protocol::mtENDPOINTS, protocol::mtTRANSACTION, protocol::mtGET_LEDGER, protocol::mtLEDGER_DATA, protocol::mtGET_OBJECTS, protocol::mtVALIDATORLIST. Also, if a message is not compressible, then we send uncompressed message.
| To enable link compression on your server, complete the following steps: | ||
|
|
||
| ### 1. Edit your `rippled`'s config file. | ||
|
|
There was a problem hiding this comment.
Why not use the following? Seems weird to add the possessive to rippled, and using "server" is consistent with the other docs.
Edit your rippled server's config file.
| # Enable Link Compression | ||
|
|
||
| The `rippled` server can save bandwidth by compressing its [peer-to-peer communications](peer-protocol.html), at a cost of greater CPU usage. If you enable link compression, the server automatically compresses communications with peer servers that also have link compression enabled. The server uses uncompressed communications with peers who do not have have link compression enabled or do not support link compression. [New in: rippled 1.6.0][] | ||
|
|
There was a problem hiding this comment.
Was wondering how much CPU usage would be saved by this. Makes sense to compress bandwidth if you knew this setting is the norm for most other hosts.
Anyway to recast the last sentence? There's also a repeated "have" in the sentence:
The server uses uncompressed communications with peers who do not have have link compression enabled or do not support link compression.
Something like this, maybe?
Peer-to-peer link compression works only with peer servers that support link compression and have link compression enabled. In the absence of either, your server defaults to uncompressed communications with that peer.
There was a problem hiding this comment.
Was thinking about it and I decided the best way to rephrase the sentence was to remove it.
It's implied by the previous sentence and awkwardly long pretty much no matter what, so I think in reality it's more likely to confuse people than it is to help.
