tracing poc

Author: joostjager

lightning-background-processor/Cargo.toml

@@ -28,6 +28,7 @@ lightning = { version = "0.2.0", path = "../lightning", default-features = false
 lightning-rapid-gossip-sync = { version = "0.2.0", path = "../lightning-rapid-gossip-sync", default-features = false }
 lightning-liquidity = { version = "0.2.0", path = "../lightning-liquidity", default-features = false }
 possiblyrandom = { version = "0.2", path = "../possiblyrandom", default-features = false }
+tracing = "0.1.41"
 
 [dev-dependencies]
 tokio = { version = "1.35", features = [ "macros", "rt", "rt-multi-thread", "sync", "time" ] }

lightning-liquidity/Cargo.toml

@@ -33,6 +33,7 @@ chrono = { version = "0.4", default-features = false, features = ["serde", "allo
 serde = { version = "1.0", default-features = false, features = ["derive", "alloc"] }
 serde_json = { version = "1.0", default-features = false, features = ["alloc"] }
 backtrace = { version = "0.3", optional = true }
+tracing = "0.1.41"
 
 [dev-dependencies]
 lightning = { version = "0.2.0", path = "../lightning", default-features = false, features = ["_test_utils"] }

lightning-macros/src/lib.rs

@@ -25,7 +25,7 @@ use proc_macro::{Delimiter, Group, TokenStream, TokenTree};
 use proc_macro2::TokenStream as TokenStream2;
 use quote::quote;
 use syn::spanned::Spanned;
-use syn::{parse, ImplItemFn, Token};
+use syn::{parse, Attribute, FnArg, ImplItem, ImplItemFn, ItemImpl, Meta, Token, Visibility};
 use syn::{parse_macro_input, Item};
 
 fn add_async_method(mut parsed: ImplItemFn) -> TokenStream {
@@ -400,3 +400,30 @@ pub fn xtest_inventory(_input: TokenStream) -> TokenStream {
 
 	TokenStream::from(expanded)
 }
+
+/// Auto-enters the parent span.
+#[proc_macro_attribute]
+pub fn auto_span_methods(_attr: TokenStream, item: TokenStream) -> TokenStream {
+	let mut input = parse_macro_input!(item as ItemImpl);
+
+	for item in input.items.iter_mut() {
+		if let ImplItem::Fn(method) = item {
+			if let Visibility::Public(_) = method.vis {
+				// Skip the method that sets the node_span
+				if method.sig.ident == "set_node_id" {
+					continue;
+				}
+
+				if let Some(FnArg::Receiver(_)) = method.sig.inputs.first() {
+					let block = &method.block;
+					method.block = syn::parse_quote!({
+						let _entered_span = self.node_span.enter();
+						#block
+					});
+				}
+			}
+		}
+	}
+
+	TokenStream::from(quote!(#input))
+}

lightning-rapid-gossip-sync/Cargo.toml

@@ -19,6 +19,7 @@ lightning = { version = "0.2.0", path = "../lightning", default-features = false
 bitcoin = { version = "0.32.2", default-features = false }
 bitcoin_hashes = { version = "0.14.0", default-features = false }
 bitcoin-io = { version = "0.1.2", default-features = false }
+tracing = "0.1.41"
 
 [target.'cfg(ldk_bench)'.dependencies]
 criterion = { version = "0.4", optional = true, default-features = false }

lightning/Cargo.toml

@@ -50,6 +50,8 @@ backtrace = { version = "0.3", optional = true }
 
 libm = { version = "0.2", default-features = false }
 inventory = { version = "0.3", optional = true  }
+tracing = "0.1.41"
+tracing-subscriber = "0.3.20"
 
 [dev-dependencies]
 regex = "1.5.6"

lightning/src/ln/channel.rs

@@ -1006,6 +1006,20 @@ where
 	}
 }
 
+pub fn span_from_context<S: Deref>(
+	context: &ChannelContext<S>, payment_hash: Option<PaymentHash>,
+) -> tracing::Span
+where
+	S::Target: SignerProvider,
+{
+	tracing::info_span!(
+		"channel",
+		peer_id = %context.counterparty_node_id,
+		channel_id = %context.channel_id,
+		payment_hash = %payment_hash
+	)
+}
+
 macro_rules! secp_check {
 	($res: expr, $err: expr) => {
 		match $res {