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

feat: expose code metrics #2214

Open
weboko opened this issue Jan 18, 2025 · 1 comment
Open

feat: expose code metrics #2214

weboko opened this issue Jan 18, 2025 · 1 comment

Comments

@weboko
Copy link
Collaborator

weboko commented Jan 18, 2025

Description

Following example of js-libp2p we should consider exposing internal behavior of js-waku through a set of packages and API in order to allow application developers to track and measure behavior of it.

On top we should investigate if we can provide some simple pre-setup boards that can visualize captured metrics.

With this sub-task we should be cautious and facilitate needs only relevant for Browser environment. From that PoV some things might not be needed.

User Story

  • As a consumer, I want to see past performance of the node by uploading logs to a visualizer.
  • As a consumer, I want to measure performance of the node in run time and report to a server if needed.

Proposed Solution / Feature Design

Expose internal metrics through new API and potentially new packages.

Notes

Refer to the main feature task for details.

@chair28980 chair28980 added this to Waku Jan 18, 2025
@weboko weboko moved this to Triage in Waku Jan 18, 2025
@weboko
Copy link
Collaborator Author

weboko commented Jan 18, 2025

This task has low priority and should be approached only when we see the need of more structural telemetry / metrics capturing OR/AND if we see it useful to provide some visualization to logs/metrics in order to speed up debugging and investigations.

@weboko weboko moved this from Triage to Icebox in Waku Jan 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Icebox
Development

No branches or pull requests

1 participant