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

Define, Prioritize, and implement all necessary SwingSet Kernel Metrics #10882

Open
siarhei-agoric opened this issue Jan 23, 2025 · 0 comments
Open
Assignees
Labels
enhancement New feature or request telemetry

Comments

@siarhei-agoric
Copy link
Contributor

siarhei-agoric commented Jan 23, 2025

What is the Problem Being Solved?

We need to be able to monitor all of the key aspects to SwingSet Kernel's inner workings for proactive development and ease of troubleshooting.

Description of the Design

Identify critical metrics, collect them internally, and make them available for outside monitoring.
https://docs.google.com/document/d/11fjd0A2S-mgrkN7i7IePYMpuGdpbEZwhfHRJAxJjoPU/edit?tab=t.0#heading=h.vzrutkd4jeh7

Security Considerations

Monitoring interface of any one node can be abused if exposed externally. Observing some metrics may be disclosing node-specific information regarding its performance limitations, which can be used to mount an effective DDOS attack.

Scaling Considerations

Changes are node-local and not in consensus.

Test Plan

Mostly manual for now. Some automation is possible.

Upgrade Considerations

This will be rolled out as part of standard release process, likely over several iterations.

@siarhei-agoric siarhei-agoric added the enhancement New feature or request label Jan 23, 2025
mergify bot pushed a commit that referenced this issue Jan 28, 2025
closes: #10883
refs: #10882

## Description
Add metrics for the following action types:
-   CORE_EVAL
-   DELIVER_INBOUND
-   IBC_EVENT
-   INSTALL_BUNDLE
-   PLEASE_PROVISION
-   VBANK_BALANCE_UPDATE
-   WALLET_ACTION
-   WALLET_SPEND_ACTION
-   VTRANSFER_IBC_EVENT
-   KERNEL_UPGRADE_EVENTS

### Security Considerations
Metrics may expose inner state which could be used to mount an effective attack.

### Scaling Considerations
No impact on a local node performance expected.

### Documentation Considerations
Metric names and their meaning need to be documented as now available via standard reporting interface. 

### Testing Considerations
manual testing?

### Upgrade Considerations
This will roll out as part of standard release.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request telemetry
Projects
None yet
Development

No branches or pull requests

4 participants