feat(baseapp): add per message telemetry #22175

ziscky · 2024-10-08T15:50:49Z

Description

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

included the correct type prefix in the PR title, you can find examples of the prefixes below:
confirmed ! in the type prefix if API or client breaking change
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

New Features
- Enhanced performance monitoring for message processing with telemetry measurements.
- Improved validation for nested transaction messages to ensure correct processing.
- Added support for simulating nested messages in the base application.
- Introduced a Linux-only backend for the crypto/keyring module.
- Enhanced client/keys module to support importing hex keys via standard input.
Improvements
- Adjusted simulation tests to skip when running dry on validators.
- Updated CLI to query addresses by account ID instead of ID.
Bug Fixes
- Addressed issues with the handling of nested messages to enhance transaction accuracy.
- Fixed issues in the simulation framework and CLI commands for better functionality.

coderabbitai · 2024-10-08T15:50:58Z

📝 Walkthrough

Walkthrough

The changes in the pull request primarily enhance the BaseApp class in the baseapp/baseapp.go file. Modifications include the introduction of telemetry measurements to monitor message processing times within the runMsgs method and updates to the simulateNestedMessages method to validate nested transaction messages. These adjustments aim to improve performance tracking and ensure the correctness of message handling during transaction execution.

Changes

File	Change Summary
baseapp/baseapp.go	Added telemetry measurements to `runMsgs` for tracking message processing time. Updated `simulateNestedMessages` to validate nested messages.
CHANGELOG.md	Updated to include new features, improvements, and bug fixes related to the base application and other modules.

Assessment against linked issues

Objective	Addressed	Explanation
Measure average time consumed per each `Message` (#13981)	✅

Possibly related PRs

chore: add crisis changelog #22280: This PR includes updates to the CHANGELOG.md that detail the addition of features such as simulating nested messages in the base application, which directly relates to the changes made in the main PR regarding the simulateNestedMessages method.

Suggested labels

C:CLI, C:x/tx

Suggested reviewers

aaronc
kocubinski
JulianToledano
testinginprod
sontrinh16
tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1b6e8c0 and 4444348.

📒 Files selected for processing (1)

CHANGELOG.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

CHANGELOG.md

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

baseapp/baseapp.go

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 43c41be and d5d5a6d.

📒 Files selected for processing (1)

baseapp/baseapp.go (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

baseapp/baseapp.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🔇 Additional comments (1)

baseapp/baseapp.go (1)

1081-1081: Approved: Telemetry measurement correctly added

The telemetry.MeasureSince call accurately captures the processing time for each message, aligning with the PR objective to add per-message telemetry. The implementation is appropriate and follows best practices.

baseapp/baseapp.go

julienrbrt · 2024-11-04T14:09:24Z

May needs to be backported because 0.54 won't have baseapp

julienrbrt · 2024-11-04T14:10:41Z

I am realizing there are a few changes that made it to baseapp on main while baseapp will be gone.
However it is too late to integrate them in 0.52.

* main: (24 commits) build(deps): upgrade to iavl@v1.3.1 (#22436) docs: Update tendermint validators query pagination documentation (#22412) refactor(client/v2): offchain uses client/v2/factory (#22344) feat: wire new handlers to grpc (#22333) fix(x/group): proper address rendering in error (#22425) refactor(serevr/v2/cometbft): update `RegisterQueryHandlers` and GRPC queries (#22403) docs: update ADR 59 (#22423) build(deps): Bump github.com/fsnotify/fsnotify from 1.7.0 to 1.8.0 in /tools/cosmovisor (#22407) docs: Module account address documentation (#22289) feat(baseapp): add per message telemetry (#22175) docs: Update Twitter Links to X in Documentation (#22408) docs: redirect the remote generation page (#22404) refactor(serverv2): remove unused interface methods, honuor context (#22394) fix(server/v2): return ErrHelp (#22399) feat(indexer): implement `schema.HasModuleCodec` interface in the `bank` module (#22349) refactor(math): refactor ApproxRoot for readality (#22263) docs: fix KWallet Handbook (#22395) feat(client/v2): broadcast logic (#22282) refactor(server/v2): eager config loading (#22267) test(system): check feePayers signature (#22389) ...

feat(baseapp): add per message telemetry

d5d5a6d

ziscky requested review from facundomedica, aaronc, testinginprod, kocubinski and a team as code owners October 8, 2024 15:50

github-prbot assigned aaronc, facundomedica and kocubinski Oct 8, 2024

This comment has been minimized.

Sign in to view

github-prbot assigned testinginprod Oct 8, 2024

github-actions bot reviewed Oct 8, 2024

View reviewed changes

baseapp/baseapp.go Outdated Show resolved Hide resolved

ziscky marked this pull request as draft October 8, 2024 15:52

coderabbitai bot reviewed Oct 8, 2024

View reviewed changes

baseapp/baseapp.go Outdated Show resolved Hide resolved

ziscky added 2 commits October 31, 2024 16:40

Merge branch 'main' into ziscky/13981-msg-telemetry

6305e1d

fix(baseapp): move var definition

1b6e8c0

ziscky marked this pull request as ready for review October 31, 2024 13:41

github-actions bot reviewed Oct 31, 2024

View reviewed changes

baseapp/baseapp.go Show resolved Hide resolved

ziscky and others added 2 commits November 4, 2024 14:03

Merge branch 'main' into ziscky/13981-msg-telemetry

89f0779

chore(baseapp): changelog

4444348

kocubinski approved these changes Nov 4, 2024

View reviewed changes

tac0turtle approved these changes Nov 4, 2024

View reviewed changes

tac0turtle added this pull request to the merge queue Nov 4, 2024

julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Nov 4, 2024

julienrbrt removed this pull request from the merge queue due to a manual request Nov 4, 2024

julienrbrt removed the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Nov 4, 2024

julienrbrt added this pull request to the merge queue Nov 4, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 4, 2024

julienrbrt added this pull request to the merge queue Nov 4, 2024

Merged via the queue into main with commit 80402e7 Nov 4, 2024
83 of 91 checks passed

julienrbrt deleted the ziscky/13981-msg-telemetry branch November 4, 2024 14:23

coderabbitai bot mentioned this pull request Dec 5, 2024

feat(tools/benchmark): introduce benchmark module #22778

Merged

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(baseapp): add per message telemetry #22175

feat(baseapp): add per message telemetry #22175

ziscky commented Oct 8, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 8, 2024 •

edited

Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

This comment has been minimized.

coderabbitai bot left a comment

julienrbrt commented Nov 4, 2024 •

edited

Loading

julienrbrt commented Nov 4, 2024

feat(baseapp): add per message telemetry #22175

feat(baseapp): add per message telemetry #22175

Conversation

ziscky commented Oct 8, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Oct 8, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

This comment has been minimized.

coderabbitai bot left a comment

Choose a reason for hiding this comment

julienrbrt commented Nov 4, 2024 • edited Loading

julienrbrt commented Nov 4, 2024

ziscky commented Oct 8, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 8, 2024 •

edited

Loading

julienrbrt commented Nov 4, 2024 •

edited

Loading