Skip to content

docs: Minor recommendations prior to v0.34.21 release#9267

Merged
thanethomson merged 8 commits intov0.34.xfrom
thane/minor-updates-v0.34.21
Aug 18, 2022
Merged

docs: Minor recommendations prior to v0.34.21 release#9267
thanethomson merged 8 commits intov0.34.xfrom
thane/minor-updates-v0.34.21

Conversation

@thanethomson
Copy link
Contributor

In preparation for the v0.34.21 release, I was looking through the changes and thought we could better document them.


PR checklist

  • Tests written/updated, or no tests needed
  • CHANGELOG_PENDING.md updated, or no changelog entry needed
  • Updated relevant documentation (docs/) and code comments, or no
    documentation updates needed

@thanethomson thanethomson requested a review from ebuchman as a code owner August 16, 2022 11:36
@thanethomson thanethomson requested a review from a team August 16, 2022 11:36
@thanethomson thanethomson force-pushed the thane/minor-updates-v0.34.21 branch from 511ca81 to 1d19ac9 Compare August 16, 2022 12:53
@thanethomson thanethomson changed the title Minor recommendations prior to v0.34.21 release docs: Minor recommendations prior to v0.34.21 release Aug 16, 2022
Comment on lines +6 to +9
- A new RPC configuration flag, `discard_abci_responses`, which, if enabled,
discards all ABCI responses except the latest one in order to reduce disk
space usage in the state store. Note that, if enabled, this means that the
`block_results` RPC endpoint will only be able to return the latest block.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually if enabled /block_results will return an error saying that the node isn't persisting abci responses

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if adding the RPC part is confusing. Yes it's in the RPC section but that's because we didn't want to create a new section and wasn't sure where such a change would best fit so we landed it in RPC but really this is a storage engine config

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually if enabled /block_results will return an error saying that the node isn't persisting abci responses

Ah, I missed this somehow. In terms of the way it's implemented now though, does this make sense given that we do actually store the last ABCI response and can actually give the latest block results? Should we really always be returning an error if we have the results? (Mainly asking for context around the decision-making there)

I wonder if adding the RPC part is confusing. Yes it's in the RPC section but that's because we didn't want to create a new section

Is it really a big deal to create a new section, especially when the flag's off by default? I'd say that, since it's technically a state store option, so it could either go into a [statestore] section, or more generically a [storage] section.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I missed this somehow. In terms of the way it's implemented now though, does this make sense given that we do actually store the last ABCI response and can actually give the latest block results? Should we really always be returning an error if we have the results? (Mainly asking for context around the decision-making there)

We definitely could. There needs to be some added logic but it's possible. The design decision was one of simplicity - easier just to close of the entire RPC endpoint than to have it error for every height except the latest

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it really a big deal to create a new section, especially when the flag's off by default? I'd say that, since it's technically a state store option, so it could either go into a [statestore] section, or more generically a [storage] section.

It's possible to maybe have a general storage section. It's not clear to me yet what other configuration options there might be

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We definitely could. There needs to be some added logic but it's possible.

Speaking to the IBC-rs team now, it may actually be better to just keep it as-is. The relayer could then just ping the /block_results endpoint on startup and, if it errors out with the current error, they can notify the user that the relevant node isn't correctly configured.

@thanethomson thanethomson force-pushed the thane/minor-updates-v0.34.21 branch from 8ba7205 to 1794237 Compare August 16, 2022 15:13
- A new RPC configuration flag, `discard_abci_responses`, which, if enabled,
discards all ABCI responses except the latest one in order to reduce disk
space usage in the state store. Note that, if enabled, this means that the
`block_results` RPC endpoint will only be able to return the latest block.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

omit "be able to"

Copy link
Contributor

@cmwaters cmwaters left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update a few things given recent changes but looks good other than that

Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson thanethomson force-pushed the thane/minor-updates-v0.34.21 branch from 1794237 to 20ec497 Compare August 17, 2022 15:33
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson thanethomson merged commit bca737c into v0.34.x Aug 18, 2022
@thanethomson thanethomson deleted the thane/minor-updates-v0.34.21 branch August 18, 2022 01:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants