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

Improve agent logging #1797

Merged
merged 26 commits into from
Feb 12, 2023
Merged

Improve agent logging #1797

merged 26 commits into from
Feb 12, 2023

Conversation

mattiekat
Copy link
Contributor

@mattiekat mattiekat commented Feb 9, 2023 •
edited
Loading

Description

Lots of changes to logging...

  • added custom debug logging to a number of types to help pare down the garbage printed
  • byte slices should now print as hex (e.g. metadata, body, ...)
  • tweaked a few log levels
  • eliminated reqwest's debug logging unless trace logging is enabled
  • tweaked logging defaults in case the operator does not configure it
  • improved logging of failure to fetch metadata
  • updated ethers to also support these changes and make things even more readable
  • added new utilities for formatting addresses based on domains
  • added new utility for formatting byte slices
  • limits max release tracing level (to save on overhead for trace level)
  • changes our log level to debug
  • some work on standardizing log messages

Drive-by changes

A few minor changes to code flow to make it easier to read, all changes outside of logging should be logically equivalent.

Related issues

Backward compatibility

Are these changes backward compatible?

Yes

Are there any infrastructure implications, e.g. changes that would prohibit deploying older commits using this infra tooling?

None

Testing

What kind of testing have these changes undergone?

Manual - been using e2e test to view what the logs look like

@mattiekat
Just use defaults of individual components
65a8547
@mattiekat
Removed redundant log info
0728580
@mattiekat
Reduced "Indexed block range" to debug
775b94b
@mattiekat
Make serial submitter a little easier to read
6b000b7
@mattiekat
Make sponsored call op a little easier to parse
36eff14
@mattiekat
Filter out debug messages from hyper
92d139f
@mattiekat
Minor cleanup
077f58c
@mattiekat
Decrease verbosity of metadata builder in logs
0634c29
@mattiekat
log updates
c0e18be
@mattiekat
More logging updates
4a114a1
@mattiekat
update ethers for testing
d5eef63
@mattiekat
Merge branch 'main' into mattie/improve-relayer-logs
8abaaf3 
# Conflicts:
#	rust/agents/relayer/src/msg/metadata_builder.rs
#	rust/agents/scraper/Cargo.toml
#	rust/hyperlane-base/Cargo.toml
#	rust/hyperlane-core/Cargo.toml
@mattiekat
run locally with debug logging
56f2921
@mattiekat
Drop retriable jsonrpc warn to info
00f93ed
@mattiekat
Update ethers
6c363dd
@mattiekat
More log cleanup
bd7540e
@mattiekat
Fix hyperlane message span
0b4449e
@mattiekat
Limit max release log level
f87a520
@mattiekat
Change our log level to debug
3e821aa
@mattiekat mattiekat changed the title Improve logging Improve agent logging Feb 9, 2023
@mattiekat mattiekat marked this pull request as ready for review February 9, 2023 23:29
asaj
asaj reviewed Feb 10, 2023
View reviewed changes
Copy link
Contributor

@asaj asaj left a comment

Choose a reason for hiding this comment

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

Very nice! Just some nits and clarifying questions, looking forward to shipping this :)

rust/agents/relayer/Cargo.toml Show resolved Hide resolved
rust/agents/relayer/src/msg/gelato_submitter/sponsored_call_op.rs Outdated Show resolved Hide resolved
rust/agents/relayer/src/msg/gelato_submitter/sponsored_call_op.rs Outdated Show resolved Hide resolved
rust/agents/relayer/src/msg/metadata_builder.rs Show resolved Hide resolved
rust/agents/relayer/src/msg/serial_submitter.rs Outdated Show resolved Hide resolved
rust/hyperlane-core/src/db/hyperlane_db.rs Outdated Show resolved Hide resolved
rust/hyperlane-core/src/types/message.rs Show resolved Hide resolved
rust/hyperlane-core/src/types/message.rs Show resolved Hide resolved
rust/hyperlane-core/src/types/message.rs Show resolved Hide resolved
rust/utils/run-locally/src/main.rs Show resolved Hide resolved
@mattiekat mattiekat requested a review from asaj February 10, 2023 20:56
asaj
asaj approved these changes Feb 11, 2023
View reviewed changes
Copy link
Contributor

@asaj asaj left a comment

Choose a reason for hiding this comment

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

:shipit:

@github-actions
Copy link
Contributor

Solidity Coverage Report

Coverage after merging mattie/improve-relayer-logs into main will be
77.73% 0.00%
Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
contracts
   Create2Factory.sol0%100%0%0%101–102, 110, 112, 33, 58, 64–65, 77–78, 98
   GasRouter.sol73.33%100%50%100%
   HyperlaneConnectionClient.sol52.50%100%43.75%58.33%100–101, 131, 160, 164–165, 85–86, 98–99
   Mailbox.sol77.61%100%48%95.24%231, 275
   OwnableMulticall.sol50%100%40%66.67%18
   PausableReentrancyGuard.sol95.24%100%90%100%
   Router.sol80%100%69.57%88.89%46, 53, 64
   ValidatorAnnounce.sol76%100%42.86%88.89%55–56
contracts/igps
   InterchainGasPaymaster.sol91.30%100%77.78%100%
   OverheadIgp.sol63.16%100%45.45%87.50%45
contracts/isms
   MultisigIsm.sol82%100%51.52%97.01%337, 339
contracts/libs
   Call.sol0%100%0%0%13–18, 24–29, 39, 41–44, 48–50
   EnumerableMapExtended.sol36.36%100%28.57%50%45, 61, 69–70
   Merkle.sol91.04%100%50%98.25%44
   Message.sol60.61%100%45.45%90.91%109
   MinimalProxy.sol66.67%100%50%100%
   MultisigIsmMetadata.sol70.59%100%50%100%
   TypeCasts.sol30.77%100%33.33%28.57%11–13, 17–18
   ValidatorAnnouncements.sol75%100%50%100%
contracts/middleware
   InterchainAccountRouter.sol58.33%100%33.33%76.19%107, 40, 42–43, 59
   InterchainQueryRouter.sol67.74%100%33.33%76%105–109, 65
contracts/middleware/liquidity-layer
   LiquidityLayerRouter.sol73.08%100%40%93.75%34
contracts/middleware/liquidity-layer/adapters
   CircleBridgeAdapter.sol35.59%100%17.65%42.86%169, 176, 178, 185, 191–192, 194–195, 200–201, 203, 211–212, 214–215, 221–222, 224, 58–59, 75, 77–78, 81
   PortalAdapter.sol52.27%100%20%68.97%192, 199, 201, 52–53, 69, 71–73

@asaj asaj merged commit 8105913 into main Feb 12, 2023
@asaj asaj deleted the mattie/improve-relayer-logs branch February 12, 2023 23:17
@mattiekat mattiekat mentioned this pull request Feb 15, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asaj asaj asaj approved these changes

@tkporter tkporter Awaiting requested review from tkporter tkporter is a code owner

@nambrot nambrot Awaiting requested review from nambrot

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@mattiekat @asaj