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.

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

chore: make telemetry consistent #20025

Merged
merged 1 commit into from
Apr 12, 2024
Merged

chore: make telemetry consistent #20025

merged 1 commit into from
Apr 12, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Apr 12, 2024

Description

While fixing the conflicts in #20017, noticed some inconsistencies in main after #19903

Follow-up of #19903

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
  • 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.

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

  • Refactor
    • Updated telemetry measurement methods in various modules to enhance accuracy and performance.
  • Chores
    • Removed unnecessary telemetry code from specific modules to streamline operations.

@julienrbrt julienrbrt requested a review from a team as a code owner April 12, 2024 09:05
Copy link
Contributor

coderabbitai bot commented Apr 12, 2024

Walkthrough

Walkthrough

The recent updates focus on modifying telemetry handling across several modules. The changes include replacing time.Now() with telemetry.Now() for more consistent telemetry timestamps and removing telemetry-related code from certain modules. This affects how performance metrics are gathered and reported during the initialization and block processing phases in the application.

Changes

File Path Change Summary
baseapp/abci.go Replaced time.Now() with telemetry.Now() in BaseApp's Query method.
x/circuit/module.go Removed telemetry code from InitGenesis function.
x/crisis/module.go Removed telemetry measurement from InitGenesis.
x/epochs/.../abci.go Replaced time.Now() with telemetry.Now() in BeginBlocker function.

These modifications streamline telemetry practices and potentially enhance the performance monitoring capabilities of the system.


Recent Review Details

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between ab919fe and 8d299d6.
Files selected for processing (4)
  • baseapp/abci.go (1 hunks)
  • x/circuit/module.go (2 hunks)
  • x/crisis/module.go (2 hunks)
  • x/epochs/keeper/abci.go (2 hunks)
Additional Context Used
Path-based Instructions (4)
x/epochs/keeper/abci.go (1)

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

x/circuit/module.go (1)

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

x/crisis/module.go (1)

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

baseapp/abci.go (1)

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

Additional comments not posted (3)
x/epochs/keeper/abci.go (1)

14-14: Standardized telemetry time measurement implemented correctly.

x/circuit/module.go (1)

Line range hint 1-1: Telemetry code removal in InitGenesis function aligns with PR objectives.

Verification successful

Based on the executed script, which searched for the term "telemetry" within the Go files in the x/circuit/ directory and returned no results, it can be confirmed that telemetry code has been successfully removed from the InitGenesis function and likely from other parts of the module as well. This aligns with the objectives of the PR.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify that telemetry code is removed from other parts of the circuit module.
rg --type go 'telemetry' x/circuit/

Length of output: 35

baseapp/abci.go (1)

180-180: Change to use telemetry.Now() instead of time.Now() for telemetry measurement is appropriate for consistency.

Verification successful

The script executed to search for other instances where time.Now() might still be used with telemetry in the Cosmos SDK did not return any results. This indicates that there are no other occurrences of time.Now() being used in conjunction with telemetry.MeasureSince in the .go files of the Cosmos SDK. This supports the consistency of the change made in the baseapp/abci.go file, where telemetry.Now() is used instead of time.Now().

Based on this information, the change to use telemetry.Now() for telemetry measurement in the Query method of the BaseApp struct is verified as consistent across the codebase, and no further instances of the old pattern (time.Now()) exist.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Search for other instances where `time.Now()` might still be used with telemetry in the Cosmos SDK.
rg --type go 'telemetry\.MeasureSince.*time\.Now\(\)' --glob '**/*.go'

Length of output: 72


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Actionable comments outside the diff hunks (1)
x/crisis/module.go (1)

[!TIP]
Codebase Verification

The verification process has revealed that while telemetry measurement has been removed from the InitGenesis function in the crisis module, it is still present in the abci.go file within the same module. This suggests that the removal was specific to the InitGenesis function and not the entire module. If the intent of the PR was to remove telemetry only from InitGenesis, this is consistent with the changes. However, if the intent was broader, this might indicate incomplete implementation.

Analysis chain

Line range hint 1-1: Removal of telemetry measurement in InitGenesis function aligns with PR objectives.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify that telemetry measurement is removed from other parts of the crisis module.
rg --type go 'telemetry' x/crisis/

Length of output: 212

@julienrbrt julienrbrt changed the title chore: make telemetry consistent follow-up of #19903 chore: make telemetry consistent Apr 12, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Apr 12, 2024
Merged via the queue into main with commit d40677a Apr 12, 2024
68 checks passed
@julienrbrt julienrbrt deleted the julien/follow-up-19903 branch April 12, 2024 11:13
alpe added a commit to alpe/cosmos-sdk that referenced this pull request Apr 15, 2024
* main: (25 commits)
  fix: Implement gogoproto customtype to secp256r1 keys (cosmos#20027)
  fix(x/epochs): avoid invalid epoch duration in simulation (cosmos#20030)
  fix(x/bank): align query with multi denoms for send-enabled (cosmos#20028)
  refactor(x/slashing)!: remove Accounts String (cosmos#20026)
  refactor(x/evidence)!: remove Address.String() (cosmos#20016)
  chore: make telemetry consistent (cosmos#20025)
  chore: prepare x/tx changelog (cosmos#20015)
  build(deps): Bump actions/add-to-project from 1.0.0 to 1.0.1 (cosmos#20018)
  feat(x/bank): support depinject for send restrictions (cosmos#20014)
  feat: Conditionally emit metrics based on enablement (cosmos#19903)
  fix(store): fix the typo (cosmos#20011)
  docs(x/feegrant): fix allowance typo (cosmos#20000)
  chore(confix): update latest config value (cosmos#20012)
  refactor(x/auth): auth module can recognize x/accounts account (cosmos#20002)
  fix(mempool): use no-op mempool as default (cosmos#19970)
  fix(simapp): add epoch store to upgrade (cosmos#20007)
  test(kv): add unit tests for the helpers functions kv.AssertKeyAtLeas… (cosmos#19965)
  feat(x/tx): Rename custom Amino JSON encoder to "inline_json" (cosmos#19919)
  refactor(x/auth): use transaction service (cosmos#19967)
  fix(client/v2): add encoder for `cosmos.base.v1beta1.DecCoin` (cosmos#19976)
  ...
alpe added a commit that referenced this pull request Apr 15, 2024
* main:
  fix: Implement gogoproto customtype to secp256r1 keys (#20027)
  fix(x/epochs): avoid invalid epoch duration in simulation (#20030)
  fix(x/bank): align query with multi denoms for send-enabled (#20028)
  refactor(x/slashing)!: remove Accounts String (#20026)
  refactor(x/evidence)!: remove Address.String() (#20016)
  chore: make telemetry consistent (#20025)
  chore: prepare x/tx changelog (#20015)
  build(deps): Bump actions/add-to-project from 1.0.0 to 1.0.1 (#20018)
  feat(x/bank): support depinject for send restrictions (#20014)
  feat: Conditionally emit metrics based on enablement (#19903)
  fix(store): fix the typo (#20011)
  docs(x/feegrant): fix allowance typo (#20000)
  chore(confix): update latest config value (#20012)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants