Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(log): Make sync error logs more user-friendly #3944

Merged
merged 1 commit into from
Mar 26, 2022
Merged

fix(log): Make sync error logs more user-friendly #3944

merged 1 commit into from
Mar 26, 2022

Conversation

teor2345
Copy link
Contributor

@teor2345 teor2345 commented Mar 23, 2022 •
edited by dconnolly
Loading

Motivation

The sync fix changed some of the syncer logs. Some of those logs could be alarming to users.

(And they are annoying during testing, because they contain long backtraces.)

eyre::Report API Reference

This PR uses the one-line mode with more info, but no backtrace or multi-line error:
https://docs.rs/eyre/0.6.7/eyre/struct.Report.html#display-representations

Solution

  • use info level, there is nothing the user needs to do, particularly for a single error
  • explain that the errors are temporary
  • hide backtraces, because they look like crashes

Review

Anyone can review this PR, it's a low priority log/usability/dev fix.

Reviewer Checklist

  • Syncer logs are smaller and less alarming

@teor2345
Make sync error logs more user-friendly
01d6323 
- use info level, there is nothing the user needs to do,
  particularly for a single error
- explain that the errors are temporary
- hide backtraces, because they look like crashes
@teor2345 teor2345 added C-bug Category: This is a bug P-Low ❄️ I-usability Zebra is hard to understand or use A-diagnostics Area: Diagnosing issues or monitoring performance labels Mar 23, 2022
@teor2345 teor2345 requested a review from a team as a code owner March 23, 2022 05:48
@teor2345 teor2345 self-assigned this Mar 23, 2022
@teor2345 teor2345 requested review from jvff and removed request for a team March 23, 2022 05:48
mergify bot added a commit that referenced this pull request Mar 25, 2022
@mergify
Merge of #3944
7183844
@mergify mergify bot mentioned this pull request Mar 25, 2022
Closed
19 tasks
@mergify mergify bot merged commit 9d1702e into main Mar 26, 2022
@mergify mergify bot deleted the scary-sync-log branch March 26, 2022 02:28
teor2345 added a commit that referenced this pull request Mar 28, 2022
@teor2345
Make sync error logs more user-friendly (#3944)
de81420 
- use info level, there is nothing the user needs to do,
  particularly for a single error
- explain that the errors are temporary
- hide backtraces, because they look like crashes
teor2345 added a commit that referenced this pull request Apr 19, 2022
@conradoplg @oxarbitrage
@teor2345 @jvff @mergify @dconnolly @rex4539
change(nu5): use new V5 transaction script verification API (#3799)
d79e71e 
* update librustzcash; adapt to new API

* add ticket reference for removing zcash_proofs duplicated dependencies

* update to new zcash_script V5 API

* use zp_tx shorthand

* update to Zcash 4.7.0 dependencies

* update protocol versions

* feat(rpc): Implement `getblockchaininfo` RPC method (#3891)

* Implement `getblockchaininfo` RPC method

* add a test for `get_blockchain_info`

* fix tohex/fromhex

* move comment

* Update lightwalletd acceptance test for getblockchaininfo RPC (#3914)

* change(rpc): Return getblockchaininfo network upgrades in height order (#3915)

* Update lightwalletd acceptance test for getblockchaininfo RPC

* Update some doc comments for network upgrades

* List network upgrades in order in the getblockchaininfo RPC

Also:
- Use a constant for the "missing consensus branch ID" RPC value
- Simplify fetching consensus branch IDs
- Make RPC type derives consistent
- Update RPC type documentation

* Make RPC type derives consistent

* Fix a confusing test comment

* get hashand height at the same time

* fix estimated_height

* fix lint

* add extra check

Co-authored-by: Janito Vaqueiro Ferreira Filho <janito.vff@gmail.com>

* fix typo

Co-authored-by: Janito Vaqueiro Ferreira Filho <janito.vff@gmail.com>

* split test

Co-authored-by: Janito Vaqueiro Ferreira Filho <janito.vff@gmail.com>

* fix(rpc): ignore an expected error in the RPC acceptance tests (#3961)

* Add ignored regexes to test command failure regex methods

* Ignore empty chain error in getblockchaininfo

We expect this error when zebrad starts up with an empty state.

Co-authored-by: teor <teor@riseup.net>
Co-authored-by: Janito Vaqueiro Ferreira Filho <janito.vff@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Make sync error logs more user-friendly (#3944)

- use info level, there is nothing the user needs to do,
  particularly for a single error
- explain that the errors are temporary
- hide backtraces, because they look like crashes

* Update test.patch.yml with lightwalletd job (#3970)

* Update test.patch.yml with lightwalletd job

* Remove a workflow condition that will always be false

In general, patch workflows need the
opposite conditions to the original workflow.

But in this case, we know the result of the
condition will always be true, so we can just delete it.

Co-authored-by: teor <teor@riseup.net>

* fix(doc): Fix bugs in the lightwalletd database design (#3964)

* Re-order column families in design in dependency order

* Minor RFC design tweaks and fixes

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Repoint zebra image links to our new zfnd.org site for now (#3949)

* Repoint zebra image links to our new zfnd.org site for now

* Remove images/

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Fix typos (#3956)

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: teor <teor@riseup.net>

* bump database version to trigger testnet rollback

* reduce minimum protocol version for now (will be changed later)

* update dependencies

* Apply suggestions from code review

Co-authored-by: teor <teor@riseup.net>

* update versions to match zcash 4.7.0

* deny.toml: update 'darling'

Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com>
Co-authored-by: teor <teor@riseup.net>
Co-authored-by: Janito Vaqueiro Ferreira Filho <janito.vff@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Deirdre Connolly <durumcrustulum@gmail.com>
Co-authored-by: Dimitris Apostolou <dimitris.apostolou@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dconnolly dconnolly dconnolly approved these changes

@jvff jvff Awaiting requested review from jvff jvff is a code owner automatically assigned from ZcashFoundation/network-reviewers

Assignees

@teor2345 teor2345

Labels
A-diagnostics Area: Diagnosing issues or monitoring performance C-bug Category: This is a bug I-usability Zebra is hard to understand or use
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@teor2345 @dconnolly