Deoxys-TUI: an optional TUI dashboard #17
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the new behavior ?
When running the node with the
--tuicommand-line argument (after building it with thetuifeature), a dashboard shows some node's metrics like CPU usage, RAM usage, storage usage, network traffic, and classified L1 and L2 logs.Does this introduce a breaking change?
Not really, just a cool feature
Other information
The dashboard is made with ratatui, implemented as a crate and launched in a thread from
node/commands/run.rsinrun_nodeif the--tuiargument is provided.To be able to redirect substrate logs to the TUI, it is necessary to define a writer for tracing (used by substrate). However, in its current state, substrate doesn't allow us to define a custom subscriber, so I had to write a script to directly modify the sources of the version of substrate cloned by cargo. This script is automatically executed in Deoxys if built with the
tuiflag, so the user doesn't have to worry about it. This modification will not affect the default behavior of substrate and therefore of Deoxys (it ensures that if an environment variableSUBSCRIBER_DEFINEDspecifying that a subscriber has already been defined, substrate does not redefine it and does not cause a panic).Coming soon: Fully modular widgets and tabs, more data, p2p map...