This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
Allow adding a prefix to the informant #6174
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,90 +19,138 @@ | |
| //! Console informant. Prints sync progress and block events. Runs on the calling thread. | ||
|
|
||
| use ansi_term::Colour; | ||
| use futures::prelude::*; | ||
| use log::{info, trace, warn}; | ||
| use parity_util_mem::MallocSizeOf; | ||
| use sc_client_api::{BlockchainEvents, UsageProvider}; | ||
| use sc_network::{network_state::NetworkState, NetworkStatus}; | ||
| use sp_blockchain::HeaderMetadata; | ||
| use sp_runtime::traits::{Block as BlockT, Header}; | ||
| use sp_transaction_pool::TransactionPool; | ||
| use sp_utils::mpsc::TracingUnboundedReceiver; | ||
| use std::fmt::Display; | ||
| use std::sync::Arc; | ||
| use std::time::Duration; | ||
|
|
||
| mod display; | ||
|
|
||
| /// The format to print telemetry output in. | ||
| #[derive(Clone)] | ||
| pub struct OutputFormat { | ||
| /// Use colors to display the logs | ||
| pub colors: bool, | ||
cecton marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| /// Add a prefix before every log line | ||
| pub prefix: String, | ||
|
Comment on lines
+42
to
+43
There was a problem hiding this comment. It should here also again should be made aware that this does not uses a whitespace in front of. While I'm still not sure if we should not add the whitespace by default for a prefix. Another point, please create the following: This will make it possible for the user to supply a style as well. There was a problem hiding this comment. We should not add the whitespace imo. People might want to use something like There was a problem hiding this comment. I think the style is not really useful as people can put it in the String already. Do you really want it? |
||
| } | ||
|
|
||
| macro_rules! build { | ||
| ($client:expr, $network_status_stream_builder:expr, $pool:expr, $format:expr) => {{ | ||
| let mut display = display::InformantDisplay::new($format.clone()); | ||
|
|
||
| let client_1 = $client.clone(); | ||
| let display_notifications = $network_status_stream_builder(Duration::from_millis(5000)) | ||
| .for_each(move |(net_status, _)| { | ||
| let info = client_1.usage_info(); | ||
| if let Some(ref usage) = info.usage { | ||
| trace!(target: "usage", "Usage statistics: {}", usage); | ||
| } else { | ||
| trace!( | ||
| target: "usage", | ||
| "Usage statistics not displayed as backend does not provide it", | ||
| ) | ||
| } | ||
| #[cfg(not(target_os = "unknown"))] | ||
| trace!( | ||
| target: "usage", | ||
| "Subsystems memory [txpool: {} kB]", | ||
| parity_util_mem::malloc_size(&*$pool) / 1024, | ||
| ); | ||
| display.display(&info, net_status); | ||
| future::ready(()) | ||
| }); | ||
|
|
||
| let mut last_best = { | ||
| let info = $client.usage_info(); | ||
| Some((info.chain.best_number, info.chain.best_hash)) | ||
| }; | ||
|
|
||
| let display_block_import = $client.import_notification_stream().for_each(move |n| { | ||
| // detect and log reorganizations. | ||
| if let Some((ref last_num, ref last_hash)) = last_best { | ||
| if n.header.parent_hash() != last_hash && n.is_new_best { | ||
| let maybe_ancestor = sp_blockchain::lowest_common_ancestor( | ||
| &*$client, | ||
| last_hash.clone(), | ||
| n.hash, | ||
| ); | ||
|
|
||
| match maybe_ancestor { | ||
| Ok(ref ancestor) if ancestor.hash != *last_hash => info!( | ||
| "♻️ Reorg on #{},{} to #{},{}, common ancestor #{},{}", | ||
|
There was a problem hiding this comment. Prefix? And also does not checks if color output is enabled. There was a problem hiding this comment. Prefix => done in 36c4148
That I wanted to discuss with you. I propose that we drop the color check entirely and use only colors. The reason is that the colors are strip anyway. It will reduce the code size and maintenance a bit. |
||
| Colour::Red.bold().paint(format!("{}", last_num)), last_hash, | ||
| Colour::Green.bold().paint(format!("{}", n.header.number())), n.hash, | ||
| Colour::White.bold().paint(format!("{}", ancestor.number)), ancestor.hash, | ||
| ), | ||
| Ok(_) => {}, | ||
| Err(e) => warn!("Error computing tree route: {}", e), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if n.is_new_best { | ||
| last_best = Some((n.header.number().clone(), n.hash.clone())); | ||
| } | ||
|
|
||
| info!( | ||
| target: "substrate", "✨ {}Imported #{} ({})", | ||
| $format.prefix, Colour::White.bold().paint(format!("{}", n.header.number())), n.hash, | ||
| ); | ||
| future::ready(()) | ||
| }); | ||
|
|
||
| future::join( | ||
| display_notifications, | ||
| display_block_import | ||
| ).map(|_| ()) | ||
| }} | ||
| } | ||
|
|
||
| /// Creates an informant in the form of a `Future` that must be polled regularly. | ||
cecton marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| #[cfg(not(target_os = "unknown"))] | ||
| pub fn build<B: BlockT, C>( | ||
| client: Arc<C>, | ||
| network_status_stream_builder: impl FnOnce( | ||
| Duration, | ||
| ) -> TracingUnboundedReceiver<( | ||
| NetworkStatus<B>, | ||
| NetworkState, | ||
| )>, | ||
| pool: Arc<impl TransactionPool + MallocSizeOf>, | ||
|
There was a problem hiding this comment. Just because of this Please create a trait that based on the target os has different super trait requirements. |
||
| format: OutputFormat, | ||
| ) -> impl futures::Future<Output = ()> | ||
| where | ||
| C: UsageProvider<B> + HeaderMetadata<B> + BlockchainEvents<B>, | ||
| <C as HeaderMetadata<B>>::Error: Display, | ||
| { | ||
| build!(client, network_status_stream_builder, pool, format) | ||
| } | ||
|
|
||
| /// Creates an informant in the form of a `Future` that must be polled regularly. | ||
| #[cfg(target_os = "unknown")] | ||
| pub fn build<B: BlockT, C>( | ||
| client: Arc<C>, | ||
| network_status_stream_builder: impl FnOnce( | ||
| Duration, | ||
| ) -> TracingUnboundedReceiver<( | ||
| NetworkStatus<B>, | ||
| NetworkState, | ||
| )>, | ||
| pool: Arc<impl TransactionPool>, | ||
| format: OutputFormat, | ||
| ) -> impl futures::Future<Output = ()> | ||
| where | ||
| C: UsageProvider<B> + HeaderMetadata<B> + BlockchainEvents<B>, | ||
| <C as HeaderMetadata<B>>::Error: Display, | ||
| { | ||
| build!(client, network_status_stream_builder, pool, format) | ||
| } | ||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if self.format.colorsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in e32866a