pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-12 19:21:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add logger configuration hook (#10440)

Browse Source 
* Initial poc

Signed-off-by: Andrei Sandu <andrei-mihail@parity.io>

* Make config available to logger hook

Signed-off-by: Andrei Sandu <andrei-mihail@parity.io>

* fmt

Signed-off-by: Andrei Sandu <andrei-mihail@parity.io>

* Fix tests

Signed-off-by: Andrei Sandu <andrei-mihail@parity.io>

* fmt

Signed-off-by: Andrei Sandu <andrei-mihail@parity.io>

* Add metric prefix option in sc_cli::RunCmd

Signed-off-by: Andrei Sandu <andrei-mihail@parity.io>

* Remove print

Signed-off-by: Andrei Sandu <andrei-mihail@parity.io>

* Review fixes

Signed-off-by: Andrei Sandu <andrei-mihail@parity.io>

* fmt

Signed-off-by: Andrei Sandu <andrei-mihail@parity.io>

* fix docs

Signed-off-by: Andrei Sandu <andrei-mihail@parity.io>
This commit is contained in:
sandreim
2021-12-16 13:18:24 +02:00
committed by GitHub
parent f99307b600
commit 9b73a8a6fc
7 changed files with 148 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/client/tracing/src/lib.rs
+46 -20
View File
@@ -58,7 +58,7 @@ const ZERO_DURATION: Duration = Duration::from_nanos(0);
/// Responsible for assigning ids to new spans, which are not re-used.
pub struct ProfilingLayer {
targets: Vec<(String, Level)>,
trace_handler: Box<dyn TraceHandler>,
trace_handlers: Vec<Box<dyn TraceHandler>>,
}
/// Used to configure how to receive the metrics
@@ -76,14 +76,14 @@ impl Default for TracingReceiver {
/// A handler for tracing `SpanDatum`
pub trait TraceHandler: Send + Sync {
/// Process a `SpanDatum`
fn handle_span(&self, span: SpanDatum);
/// Process a `TraceEvent`
fn handle_event(&self, event: TraceEvent);
/// Process a `SpanDatum`.
fn handle_span(&self, span: &SpanDatum);
/// Process a `TraceEvent`.
fn handle_event(&self, event: &TraceEvent);
}
/// Represents a tracing event, complete with values
#[derive(Debug)]
#[derive(Debug, Clone)]
pub struct TraceEvent {
/// Name of the event.
pub name: String,
@@ -98,7 +98,7 @@ pub struct TraceEvent {
}
/// Represents a single instance of a tracing span
#[derive(Debug)]
#[derive(Debug, Clone)]
pub struct SpanDatum {
/// id for this span
pub id: Id,
@@ -213,6 +213,15 @@ impl fmt::Display for Values {
}
}
/// Trace handler event types.
#[derive(Debug)]
pub enum TraceHandlerEvents {
/// An event.
Event(TraceEvent),
/// A span.
Span(SpanDatum),
}
impl ProfilingLayer {
/// Takes a `TracingReceiver` and a comma separated list of targets,
/// either with a level: "pallet=trace,frame=debug"
@@ -231,7 +240,12 @@ impl ProfilingLayer {
/// wasm_tracing indicates whether to enable wasm traces
pub fn new_with_handler(trace_handler: Box<dyn TraceHandler>, targets: &str) -> Self {
let targets: Vec<_> = targets.split(',').map(|s| parse_target(s)).collect();
Self { targets, trace_handler }
Self { targets, trace_handlers: vec![trace_handler] }
}
/// Attach additional handlers to allow handling of custom events/spans.
pub fn add_handler(&mut self, trace_handler: Box<dyn TraceHandler>) {
self.trace_handlers.push(trace_handler);
}
fn check_target(&self, target: &str, level: &Level) -> bool {
@@ -242,6 +256,18 @@ impl ProfilingLayer {
}
false
}
/// Sequentially dispatch a trace event to all handlers.
fn dispatch_event(&self, event: TraceHandlerEvents) {
match &event {
TraceHandlerEvents::Span(span_datum) => {
self.trace_handlers.iter().for_each(|handler| handler.handle_span(span_datum));
},
TraceHandlerEvents::Event(event) => {
self.trace_handlers.iter().for_each(|handler| handler.handle_event(event));
},
}
}
}
// Default to TRACE if no level given or unable to parse Level
@@ -320,7 +346,7 @@ where
values,
parent_id,
};
self.trace_handler.handle_event(trace_event);
self.dispatch_event(TraceHandlerEvents::Event(trace_event));
}
fn on_enter(&self, span: &Id, ctx: Context<S>) {
@@ -348,10 +374,10 @@ where
span_datum.target = t;
}
if self.check_target(&span_datum.target, &span_datum.level) {
self.trace_handler.handle_span(span_datum);
self.dispatch_event(TraceHandlerEvents::Span(span_datum));
}
} else {
self.trace_handler.handle_span(span_datum);
self.dispatch_event(TraceHandlerEvents::Span(span_datum));
}
}
}
@@ -374,7 +400,7 @@ fn log_level(level: Level) -> log::Level {
}
impl TraceHandler for LogTraceHandler {
fn handle_span(&self, span_datum: SpanDatum) {
fn handle_span(&self, span_datum: &SpanDatum) {
if span_datum.values.is_empty() {
log::log!(
log_level(span_datum.level),
@@ -383,7 +409,7 @@ impl TraceHandler for LogTraceHandler {
span_datum.name,
span_datum.overall_time.as_nanos(),
span_datum.id.into_u64(),
span_datum.parent_id.map(|s| s.into_u64()),
span_datum.parent_id.as_ref().map(|s| s.into_u64()),
);
} else {
log::log!(
@@ -393,18 +419,18 @@ impl TraceHandler for LogTraceHandler {
span_datum.name,
span_datum.overall_time.as_nanos(),
span_datum.id.into_u64(),
span_datum.parent_id.map(|s| s.into_u64()),
span_datum.parent_id.as_ref().map(|s| s.into_u64()),
span_datum.values,
);
}
}
fn handle_event(&self, event: TraceEvent) {
fn handle_event(&self, event: &TraceEvent) {
log::log!(
log_level(event.level),
"{}, parent_id: {:?}, {}",
event.target,
event.parent_id.map(|s| s.into_u64()),
event.parent_id.as_ref().map(|s| s.into_u64()),
event.values,
);
}
@@ -447,12 +473,12 @@ mod tests {
}
impl TraceHandler for TestTraceHandler {
fn handle_span(&self, sd: SpanDatum) {
self.spans.lock().push(sd);
fn handle_span(&self, sd: &SpanDatum) {
self.spans.lock().push(sd.clone());
}
fn handle_event(&self, event: TraceEvent) {
self.events.lock().push(event);
fn handle_event(&self, event: &TraceEvent) {
self.events.lock().push(event.clone());
}
}
substrate/client/tracing/src/logging/mod.rs
+23 -2
View File
@@ -193,6 +193,7 @@ where
pub struct LoggerBuilder {
directives: String,
profiling: Option<(crate::TracingReceiver, String)>,
custom_profiler: Option<Box<dyn crate::TraceHandler>>,
log_reloading: bool,
force_colors: Option<bool>,
detailed_output: bool,
@@ -204,6 +205,7 @@ impl LoggerBuilder {
Self {
directives: directives.into(),
profiling: None,
custom_profiler: None,
log_reloading: false,
force_colors: None,
detailed_output: false,
@@ -220,6 +222,15 @@ impl LoggerBuilder {
self
}
/// Add a custom profiler.
pub fn with_custom_profiling(
&mut self,
custom_profiler: Box<dyn crate::TraceHandler>,
) -> &mut Self {
self.custom_profiler = Some(custom_profiler);
self
}
/// Wether or not to disable log reloading.
pub fn with_log_reloading(&mut self, enabled: bool) -> &mut Self {
self.log_reloading = enabled;
@@ -256,7 +267,12 @@ impl LoggerBuilder {
self.detailed_output,
|builder| enable_log_reloading!(builder),
)?;
let profiling = crate::ProfilingLayer::new(tracing_receiver, &profiling_targets);
let mut profiling =
crate::ProfilingLayer::new(tracing_receiver, &profiling_targets);
self.custom_profiler
.into_iter()
.for_each(|profiler| profiling.add_handler(profiler));
tracing::subscriber::set_global_default(subscriber.with(profiling))?;
@@ -269,7 +285,12 @@ impl LoggerBuilder {
self.detailed_output,
|builder| builder,
)?;
let profiling = crate::ProfilingLayer::new(tracing_receiver, &profiling_targets);
let mut profiling =
crate::ProfilingLayer::new(tracing_receiver, &profiling_targets);
self.custom_profiler
.into_iter()
.for_each(|profiler| profiling.add_handler(profiler));
tracing::subscriber::set_global_default(subscriber.with(profiling))?;