fix(zetaclient): use name in pending tx metric

[gartnera]

#2568 started putting integer chain IDs in the zetaclient_pending_txs_total metric. We want string IDs so dashboards and alerts are readable at a glance. This also is not consistent with our other metrics like zetaclient_rpc_getBlockByNumber_count

Current (develop) state:

# HELP zetaclient_pending_txs_total Number of pending transactions per chain
# TYPE zetaclient_pending_txs_total gauge
zetaclient_pending_txs_total{chain="chain_1337"} 500
zetaclient_pending_txs_total{chain="chain_18444"} 0
zetaclient_pending_txs_total{chain="chain_902"} 0
# HELP zetaclient_rpc_getBlockByNumber_count Count of getLogs per chain
# TYPE zetaclient_rpc_getBlockByNumber_count counter
zetaclient_rpc_getBlockByNumber_count{chain="goerli_localnet"} 15135
# HELP zetaclient_rpc_getFilterLogs_count Count of getLogs per chain
# TYPE zetaclient_rpc_getFilterLogs_count counter
zetaclient_rpc_getFilterLogs_count{chain="goerli_localnet"} 30270

New (desired) state:

# HELP zetaclient_pending_txs_total Number of pending transactions per chain
# TYPE zetaclient_pending_txs_total gauge
zetaclient_pending_txs_total{chain="btc_regtest"} 0
zetaclient_pending_txs_total{chain="goerli_localnet"} 3
zetaclient_pending_txs_total{chain="solana_localnet"} 0
# HELP zetaclient_rpc_getBlockByNumber_count Count of getLogs per chain
# TYPE zetaclient_rpc_getBlockByNumber_count counter
zetaclient_rpc_getBlockByNumber_count{chain="goerli_localnet"} 131
# HELP zetaclient_rpc_getFilterLogs_count Count of getLogs per chain
# TYPE zetaclient_rpc_getFilterLogs_count counter
zetaclient_rpc_getFilterLogs_count{chain="goerli_localnet"} 260

Summary by CodeRabbit

• New Features

  • Introduced a method to retrieve the name of the chain, improving usability.
  • Updated metrics reporting to use the chain's name for clarity.

• Bug Fixes

  • Enhanced metric labeling for better semantic understanding by using chain names instead of IDs.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Walkthrough

The recent changes enhance the Chain struct in the zetaclient/context package by introducing a new Name() method, enabling users to retrieve the chain's name easily. Additionally, the runScheduler function in the orchestrator package has been updated to utilize this new method for generating metrics, improving clarity and semantic representation. Overall, these modifications improve usability and the expressiveness of the codebase without altering existing control flows.

Changes

Files	Change Summary
zetaclient/context/chain.go	Added a new method Name() to the Chain struct, allowing access to the chain's name, enhancing usability and expressiveness.
zetaclient/orchestrator/orchestrator.go	Updated the runScheduler function to generate metric labels using chain.Name() instead of fmt.Sprintf("chain_%d", chainID), improving semantic clarity.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

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

CodeRabbit Configuration 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.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 70.54%. Comparing base (eb61f2d) to head (2a478f9).
Report is 4 commits behind head on develop.

Files	Patch %	Lines
zetaclient/context/chain.go	0.00%	2 Missing ⚠️
zetaclient/orchestrator/orchestrator.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2642      +/-   ##
===========================================
- Coverage    70.55%   70.54%   -0.01%     
===========================================
  Files          335      335              
  Lines        18345    18347       +2     
===========================================
  Hits         12943    12943              
- Misses        4821     4823       +2     
  Partials       581      581              

Files	Coverage Δ
zetaclient/orchestrator/orchestrator.go	22.34% <0.00%> (ø)
zetaclient/context/chain.go	79.48% <0.00%> (-2.10%)	⬇️

[coderabbitai]

Actionable comments posted: 2

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between eb61f2d and 2a478f9.

Files selected for processing (2)

• zetaclient/context/chain.go (1 hunks)
• zetaclient/orchestrator/orchestrator.go (1 hunks)

Additional context used

Path-based instructions (2)

zetaclient/context/chain.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

zetaclient/orchestrator/orchestrator.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

GitHub Check: codecov/patch

zetaclient/context/chain.go

[warning] 135-136: zetaclient/context/chain.go#L135-L136
Added lines #L135 - L136 were not covered by tests

zetaclient/orchestrator/orchestrator.go

[warning] 378-378: zetaclient/orchestrator/orchestrator.go#L378
Added line #L378 was not covered by tests