Skip to content

Add configurable logger#393

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.

Sign up for GitHub

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

Closed
domZippilli wants to merge 3 commits into from
Closed

Add configurable logger #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f82769
Rename FilesystemLogger to LdkNodeLogger.
domZippilli Oct 25, 2024
2c54a18
Make LdkNodeLogger technically customizable, retain default behavior.
domZippilli Oct 28, 2024
b0e7fef
Add customizable logging to configuration.
domZippilli Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 26 additions & 28 deletions src/builder.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
// accordance with one or both of these licenses.

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{default_user_config, Config, EsploraSyncConfig, WALLET_KEYS_SEED_LEN};
use crate::config::{
default_user_config, Config, EsploraSyncConfig, LoggingConfig, WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
use crate::event::EventQueue;
Expand All@@ -16,7 +18,9 @@ use crate::io::sqlite_store::SqliteStore;
use crate::io::utils::{read_node_metrics, write_node_metrics};
use crate::io::vss_store::VssStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
use crate::logger::{
default_format, log_error, log_info, FilesystemLogWriter, LdkNodeLogger, Logger,
};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::store::PaymentStore;
use crate::peer_store::PeerStore;
Expand All@@ -27,8 +31,8 @@ use crate::types::{
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
use crate::Node;
use crate::{io, NodeMetrics};
use crate::{LogLevel, Node};

use lightning::chain::{chainmonitor, BestBlock, Watch};
use lightning::io::Cursor;
Expand DownExpand Up@@ -298,12 +302,6 @@ impl NodeBuilder {
self
}

/// Sets the log dir path if logs need to live separate from the storage directory path.
pub fn set_log_dir_path(&mut self, log_dir_path: String) -> &mut Self {
self.config.log_dir_path = Some(log_dir_path);
self
}

/// Sets the Bitcoin network used.
pub fn set_network(&mut self, network: Network) -> &mut Self {
self.config.network = network;
Expand DownExpand Up@@ -333,12 +331,6 @@ impl NodeBuilder {
Ok(self)
}

/// Sets the level at which [`Node`] will log messages.
pub fn set_log_level(&mut self, level: LogLevel) -> &mut Self {
self.config.log_level = level;
self
}

/// Builds a [`Node`] instance with a [`SqliteStore`] backend and according to the options
/// previously configured.
pub fn build(&self) -> Result<Node, BuildError> {
Expand DownExpand Up@@ -734,7 +726,7 @@ fn build_with_store_internal(
config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
gossip_source_config: Option<&GossipSourceConfig>,
liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
logger: Arc<FilesystemLogger>, kv_store: Arc<DynStore>,
logger: Arc<LdkNodeLogger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
// Initialize the status fields.
let is_listening = Arc::new(AtomicBool::new(false));
Expand DownExpand Up@@ -1231,21 +1223,27 @@ fn build_with_store_internal(
})
}

fn setup_logger(config: &Config) -> Result<Arc<FilesystemLogger>, BuildError> {
let log_dir = match &config.log_dir_path {
Some(log_dir) => String::from(log_dir),
None => config.storage_dir_path.clone() + "/logs",
};

Ok(Arc::new(
FilesystemLogger::new(log_dir, config.log_level)
.map_err(|_| BuildError::LoggerSetupFailed)?,
))
fn setup_logger(config: &Config) -> Result<Arc<LdkNodeLogger>, BuildError> {
match config.logging_config {
LoggingConfig::Custom(ref logger) => Ok(logger.clone()),
LoggingConfig::Filesystem { ref log_dir, log_level } => {
let filesystem_log_writer = FilesystemLogWriter::new(log_dir.clone())
.map_err(|_| BuildError::LoggerSetupFailed)?;
Ok(Arc::new(
LdkNodeLogger::new(
log_level,
Box::new(default_format),
Box::new(move |s| filesystem_log_writer.write(s)),
)
.map_err(|_| BuildError::LoggerSetupFailed)?,
))
},
}
}

fn seed_bytes_from_config(
config: &Config, entropy_source_config: Option<&EntropySourceConfig>,
logger: Arc<FilesystemLogger>,
logger: Arc<LdkNodeLogger>,
) -> Result<[u8; 64], BuildError> {
match entropy_source_config {
Some(EntropySourceConfig::SeedBytes(bytes)) => Ok(bytes.clone()),
Expand All@@ -1267,7 +1265,7 @@ fn seed_bytes_from_config(
}

fn derive_vss_xprv(
config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<FilesystemLogger>,
config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<LdkNodeLogger>,
) -> Result<Xpriv, BuildError> {
use bitcoin::key::Secp256k1;

Expand Down
14 changes: 7 additions & 7 deletions src/chain/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use crate::fee_estimator::{
ConfirmationTarget, OnchainFeeEstimator,
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, FilesystemLogger, Logger};
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkNodeLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -112,13 +112,13 @@ pub(crate) enum ChainSource {
esplora_client: EsploraAsyncClient,
onchain_wallet: Arc<Wallet>,
onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
tx_sync: Arc<EsploraSyncClient<Arc<FilesystemLogger>>>,
tx_sync: Arc<EsploraSyncClient<Arc<LdkNodeLogger>>>,
lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>,
kv_store: Arc<DynStore>,
config: Arc<Config>,
logger: Arc<FilesystemLogger>,
logger: Arc<LdkNodeLogger>,
node_metrics: Arc<RwLock<NodeMetrics>>,
},
BitcoindRpc {
Expand All@@ -131,7 +131,7 @@ pub(crate) enum ChainSource {
tx_broadcaster: Arc<Broadcaster>,
kv_store: Arc<DynStore>,
config: Arc<Config>,
logger: Arc<FilesystemLogger>,
logger: Arc<LdkNodeLogger>,
node_metrics: Arc<RwLock<NodeMetrics>>,
},
}
Expand All@@ -140,7 +140,7 @@ impl ChainSource {
pub(crate) fn new_esplora(
server_url: String, sync_config: EsploraSyncConfig, onchain_wallet: Arc<Wallet>,
fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<FilesystemLogger>,
kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<LdkNodeLogger>,
node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Self {
let mut client_builder = esplora_client::Builder::new(&server_url);
Expand DownExpand Up@@ -170,7 +170,7 @@ impl ChainSource {
host: String, port: u16, rpc_user: String, rpc_password: String,
onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Self {
let bitcoind_rpc_client =
Arc::new(BitcoindRpcClient::new(host, port, rpc_user, rpc_password));
Expand DownExpand Up@@ -1118,7 +1118,7 @@ impl Filter for ChainSource {

fn periodically_archive_fully_resolved_monitors(
channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Result<(), Error> {
let mut locked_node_metrics = node_metrics.write().unwrap();
let cur_height = channel_manager.current_best_block().height;
Expand Down
41 changes: 33 additions & 8 deletions src/config.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@

//! Objects for configuring the node.

use crate::logger::LdkNodeLogger;
use crate::payment::SendingParameters;

use lightning::ln::msgs::SocketAddress;
Expand DownExpand Up@@ -105,8 +106,9 @@ pub struct Config {
pub storage_dir_path: String,
/// The path where logs are stored.
///
/// If set to `None`, logs can be found in the `logs` subdirectory in [`Config::storage_dir_path`].
pub log_dir_path: Option<String>,
/// In the default configuration logs can be found in the `logs` subdirectory in
/// [`Config::storage_dir_path`], and the log level is set to [`DEFAULT_LOG_LEVEL`].
pub logging_config: LoggingConfig,
/// The used Bitcoin network.
pub network: Network,
/// The addresses on which the node will listen for incoming connections.
Expand All@@ -132,10 +134,6 @@ pub struct Config {
/// Channels with available liquidity less than the required amount times this value won't be
/// used to send pre-flight probes.
pub probing_liquidity_limit_multiplier: u64,
/// The level at which we log messages.
///
/// Any messages below this level will be excluded from the logs.
pub log_level: LogLevel,
/// Configuration options pertaining to Anchor channels, i.e., channels for which the
/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
///
Expand DownExpand Up@@ -167,19 +165,46 @@ impl Default for Config {
fn default() -> Self {
Self {
storage_dir_path: DEFAULT_STORAGE_DIR_PATH.to_string(),
log_dir_path: None,
logging_config: LoggingConfig::default(),
network: DEFAULT_NETWORK,
listening_addresses: None,
trusted_peers_0conf: Vec::new(),
probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
log_level: DEFAULT_LOG_LEVEL,
anchor_channels_config: Some(AnchorChannelsConfig::default()),
sending_parameters: None,
node_alias: None,
}
}
}

/// Configuration options for logging.
#[derive(Debug, Clone)]
pub enum LoggingConfig {
/// An opinionated filesystem logger.
///
/// This logger will always write at `{log_dir}/ldk_node_latest.log`, which is a symlink to the
/// most recent log file, which is created and timestamped at initialization.
Filesystem {
/// The absolute path where logs are stored.
log_dir: String,
/// The level at which we log messages.
///
/// Any messages below this level will be excluded from the logs.
log_level: LogLevel,
},
/// A custom logger.
Custom(std::sync::Arc<LdkNodeLogger>),
}

impl Default for LoggingConfig {
fn default() -> Self {
Self::Filesystem {
log_dir: format!("{}/{}", DEFAULT_STORAGE_DIR_PATH, "logs"),
log_level: DEFAULT_LOG_LEVEL,
}
}
}

/// Configuration options pertaining to 'Anchor' channels, i.e., channels for which the
/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
///
Expand Down
8 changes: 4 additions & 4 deletions src/gossip.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
// accordance with one or both of these licenses.

use crate::config::RGS_SYNC_TIMEOUT_SECS;
use crate::logger::{log_trace, FilesystemLogger, Logger};
use crate::logger::{log_trace, LdkNodeLogger, Logger};
use crate::types::{GossipSync, Graph, P2PGossipSync, RapidGossipSync};
use crate::Error;

Expand All@@ -24,12 +24,12 @@ pub(crate) enum GossipSource {
gossip_sync: Arc<RapidGossipSync>,
server_url: String,
latest_sync_timestamp: AtomicU32,
logger: Arc<FilesystemLogger>,
logger: Arc<LdkNodeLogger>,
},
}

impl GossipSource {
pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<FilesystemLogger>) -> Self {
pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<LdkNodeLogger>) -> Self {
let gossip_sync = Arc::new(P2PGossipSync::new(
network_graph,
None::<Arc<dyn UtxoLookup + Send + Sync>>,
Expand All@@ -40,7 +40,7 @@ impl GossipSource {

pub fn new_rgs(
server_url: String, latest_sync_timestamp: u32, network_graph: Arc<Graph>,
logger: Arc<FilesystemLogger>,
logger: Arc<LdkNodeLogger>,
) -> Self {
let gossip_sync = Arc::new(RapidGossipSync::new(network_graph, Arc::clone(&logger)));
let latest_sync_timestamp = AtomicU32::new(latest_sync_timestamp);
Expand Down
6 changes: 3 additions & 3 deletions src/io/utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::{
NODE_METRICS_KEY, NODE_METRICS_PRIMARY_NAMESPACE, NODE_METRICS_SECONDARY_NAMESPACE,
};
use crate::logger::{log_error, FilesystemLogger};
use crate::logger::{log_error, LdkNodeLogger};
use crate::peer_store::PeerStore;
use crate::sweep::DeprecatedSpendableOutputInfo;
use crate::types::{Broadcaster, DynStore, KeysManager, Sweeper};
Expand DownExpand Up@@ -226,7 +226,7 @@ where
pub(crate) fn read_output_sweeper(
broadcaster: Arc<Broadcaster>, fee_estimator: Arc<OnchainFeeEstimator>,
chain_data_source: Arc<ChainSource>, keys_manager: Arc<KeysManager>, kv_store: Arc<DynStore>,
logger: Arc<FilesystemLogger>,
logger: Arc<LdkNodeLogger>,
) -> Result<Sweeper, std::io::Error> {
let mut reader = Cursor::new(kv_store.read(
OUTPUT_SWEEPER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -600,7 +600,7 @@ impl_read_write_change_set_type!(

// Reads the full BdkWalletChangeSet or returns default fields
pub(crate) fn read_bdk_wallet_change_set(
kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>,
kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>,
) -> Result<Option<BdkWalletChangeSet>, std::io::Error> {
let mut change_set = BdkWalletChangeSet::default();

Expand Down
14 changes: 7 additions & 7 deletions src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,7 @@ use types::{
};
pub use types::{ChannelDetails, PeerDetails, UserChannelId};

use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
use logger::{log_error, log_info, log_trace, LdkNodeLogger, Logger};

use lightning::chain::BestBlock;
use lightning::events::bump_transaction::Wallet as LdkWallet;
Expand DownExpand Up@@ -180,23 +180,23 @@ pub struct Node {
wallet: Arc<Wallet>,
chain_source: Arc<ChainSource>,
tx_broadcaster: Arc<Broadcaster>,
event_queue: Arc<EventQueue<Arc<FilesystemLogger>>>,
event_queue: Arc<EventQueue<Arc<LdkNodeLogger>>>,
channel_manager: Arc<ChannelManager>,
chain_monitor: Arc<ChainMonitor>,
output_sweeper: Arc<Sweeper>,
peer_manager: Arc<PeerManager>,
onion_messenger: Arc<OnionMessenger>,
connection_manager: Arc<ConnectionManager<Arc<FilesystemLogger>>>,
connection_manager: Arc<ConnectionManager<Arc<LdkNodeLogger>>>,
keys_manager: Arc<KeysManager>,
network_graph: Arc<Graph>,
gossip_source: Arc<GossipSource>,
liquidity_source: Option<Arc<LiquiditySource<Arc<FilesystemLogger>>>>,
liquidity_source: Option<Arc<LiquiditySource<Arc<LdkNodeLogger>>>>,
kv_store: Arc<DynStore>,
logger: Arc<FilesystemLogger>,
logger: Arc<LdkNodeLogger>,
_router: Arc<Router>,
scorer: Arc<Mutex<Scorer>>,
peer_store: Arc<PeerStore<Arc<FilesystemLogger>>>,
payment_store: Arc<PaymentStore<Arc<FilesystemLogger>>>,
peer_store: Arc<PeerStore<Arc<LdkNodeLogger>>>,
payment_store: Arc<PaymentStore<Arc<LdkNodeLogger>>>,
is_listening: Arc<AtomicBool>,
node_metrics: Arc<RwLock<NodeMetrics>>,
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add configurable logger by domZippilli · Pull Request #393 · lightningdevkit/ldk-node · GitHub
Skip to content
Add configurable logger#393

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.

 Sign up for GitHub

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

 Closed

domZippilli
wants to merge
3
commits into

from

 Closed


Add configurable logger
#393
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4f82769

Rename FilesystemLogger to LdkNodeLogger.


domZippilli Oct 25, 2024
2c54a18

Make LdkNodeLogger technically customizable, retain default behavior.


domZippilli Oct 28, 2024
b0e7fef

Add customizable logging to configuration.


domZippilli Oct 28, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


54 changes: 26 additions & 28 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
// accordance with one or both of these licenses.

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{default_user_config, Config, EsploraSyncConfig, WALLET_KEYS_SEED_LEN};
use crate::config::{
	default_user_config, Config, EsploraSyncConfig, LoggingConfig, WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
use crate::event::EventQueue;
Expand All@@ -16,7 +18,9 @@ use crate::io::sqlite_store::SqliteStore;
use crate::io::utils::{read_node_metrics, write_node_metrics};
use crate::io::vss_store::VssStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
use crate::logger::{
	default_format, log_error, log_info, FilesystemLogWriter, LdkNodeLogger, Logger,
};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::store::PaymentStore;
use crate::peer_store::PeerStore;
Expand All@@ -27,8 +31,8 @@ use crate::types::{
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
use crate::Node;
use crate::{io, NodeMetrics};
use crate::{LogLevel, Node};

use lightning::chain::{chainmonitor, BestBlock, Watch};
use lightning::io::Cursor;
Expand DownExpand Up@@ -298,12 +302,6 @@ impl NodeBuilder {
 self
	}

	/// Sets the log dir path if logs need to live separate from the storage directory path.
	pub fn set_log_dir_path(&mut self, log_dir_path: String) -> &mut Self {
 self.config.log_dir_path = Some(log_dir_path);
 self
	}

	/// Sets the Bitcoin network used.
	pub fn set_network(&mut self, network: Network) -> &mut Self {
 self.config.network = network;
Expand DownExpand Up@@ -333,12 +331,6 @@ impl NodeBuilder {
 Ok(self)
	}

	/// Sets the level at which [`Node`] will log messages.
	pub fn set_log_level(&mut self, level: LogLevel) -> &mut Self {
 self.config.log_level = level;
 self
	}

	/// Builds a [`Node`] instance with a [`SqliteStore`] backend and according to the options
	/// previously configured.
	pub fn build(&self) -> Result<Node, BuildError> {
Expand DownExpand Up@@ -734,7 +726,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<DynStore>,
	logger: Arc<LdkNodeLogger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	// Initialize the status fields.
	let is_listening = Arc::new(AtomicBool::new(false));
Expand DownExpand Up@@ -1231,21 +1223,27 @@ fn build_with_store_internal(
	})
}

fn setup_logger(config: &Config) -> Result<Arc<FilesystemLogger>, BuildError> {
	let log_dir = match &config.log_dir_path {
 Some(log_dir) => String::from(log_dir),
 None => config.storage_dir_path.clone() + "/logs",
	};

	Ok(Arc::new(
 FilesystemLogger::new(log_dir, config.log_level)
 .map_err(|_| BuildError::LoggerSetupFailed)?,
	))
fn setup_logger(config: &Config) -> Result<Arc<LdkNodeLogger>, BuildError> {
	match config.logging_config {
 LoggingConfig::Custom(ref logger) => Ok(logger.clone()),
 LoggingConfig::Filesystem { ref log_dir, log_level } => {
 let filesystem_log_writer = FilesystemLogWriter::new(log_dir.clone())
 .map_err(|_| BuildError::LoggerSetupFailed)?;
 Ok(Arc::new(
 LdkNodeLogger::new(
 log_level,
 Box::new(default_format),
 Box::new(move |s| filesystem_log_writer.write(s)),
 )
 .map_err(|_| BuildError::LoggerSetupFailed)?,
 ))
 },
	}
}

fn seed_bytes_from_config(
	config: &Config, entropy_source_config: Option<&EntropySourceConfig>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<[u8; 64], BuildError> {
	match entropy_source_config {
 Some(EntropySourceConfig::SeedBytes(bytes)) => Ok(bytes.clone()),
Expand All@@ -1267,7 +1265,7 @@ fn seed_bytes_from_config(
}

fn derive_vss_xprv(
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<FilesystemLogger>,
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<LdkNodeLogger>,
) -> Result<Xpriv, BuildError> {
	use bitcoin::key::Secp256k1;

Expand Down

14 changes: 7 additions & 7 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use crate::fee_estimator::{
	ConfirmationTarget, OnchainFeeEstimator,
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, FilesystemLogger, Logger};
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkNodeLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -112,13 +112,13 @@ pub(crate) enum ChainSource {
 esplora_client: EsploraAsyncClient,
 onchain_wallet: Arc<Wallet>,
 onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
 tx_sync: Arc<EsploraSyncClient<Arc<FilesystemLogger>>>,
 tx_sync: Arc<EsploraSyncClient<Arc<LdkNodeLogger>>>,
 lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
 fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
	BitcoindRpc {
Expand All@@ -131,7 +131,7 @@ pub(crate) enum ChainSource {
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
}
Expand All@@ -140,7 +140,7 @@ impl ChainSource {
	pub(crate) fn new_esplora(
 server_url: String, sync_config: EsploraSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<FilesystemLogger>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let mut client_builder = esplora_client::Builder::new(&server_url);
Expand DownExpand Up@@ -170,7 +170,7 @@ impl ChainSource {
 host: String, port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
 logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let bitcoind_rpc_client =
 Arc::new(BitcoindRpcClient::new(host, port, rpc_user, rpc_password));
Expand DownExpand Up@@ -1118,7 +1118,7 @@ impl Filter for ChainSource {

fn periodically_archive_fully_resolved_monitors(
	channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Result<(), Error> {
	let mut locked_node_metrics = node_metrics.write().unwrap();
	let cur_height = channel_manager.current_best_block().height;
Expand Down

41 changes: 33 additions & 8 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@

//! Objects for configuring the node.

use crate::logger::LdkNodeLogger;
use crate::payment::SendingParameters;

use lightning::ln::msgs::SocketAddress;
Expand DownExpand Up@@ -105,8 +106,9 @@ pub struct Config {
	pub storage_dir_path: String,
	/// The path where logs are stored.
	///
	/// If set to `None`, logs can be found in the `logs` subdirectory in [`Config::storage_dir_path`].
	pub log_dir_path: Option<String>,
	/// In the default configuration logs can be found in the `logs` subdirectory in
	/// [`Config::storage_dir_path`], and the log level is set to [`DEFAULT_LOG_LEVEL`].
	pub logging_config: LoggingConfig,
	/// The used Bitcoin network.
	pub network: Network,
	/// The addresses on which the node will listen for incoming connections.
Expand All@@ -132,10 +134,6 @@ pub struct Config {
	/// Channels with available liquidity less than the required amount times this value won't be
	/// used to send pre-flight probes.
	pub probing_liquidity_limit_multiplier: u64,
	/// The level at which we log messages.
	///
	/// Any messages below this level will be excluded from the logs.
	pub log_level: LogLevel,
	/// Configuration options pertaining to Anchor channels, i.e., channels for which the
	/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
	///
Expand DownExpand Up@@ -167,19 +165,46 @@ impl Default for Config {
	fn default() -> Self {
 Self {
 storage_dir_path: DEFAULT_STORAGE_DIR_PATH.to_string(),
log_dir_path: None,
logging_config: LoggingConfig::default(),
 network: DEFAULT_NETWORK,
 listening_addresses: None,
 trusted_peers_0conf: Vec::new(),
 probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
 log_level: DEFAULT_LOG_LEVEL,
 anchor_channels_config: Some(AnchorChannelsConfig::default()),
 sending_parameters: None,
 node_alias: None,
 }
	}
}

/// Configuration options for logging.
#[derive(Debug, Clone)]
pub enum LoggingConfig {
	/// An opinionated filesystem logger.
	///
	/// This logger will always write at `{log_dir}/ldk_node_latest.log`, which is a symlink to the
	/// most recent log file, which is created and timestamped at initialization.
	Filesystem {
 /// The absolute path where logs are stored.
 log_dir: String,
 /// The level at which we log messages.
 ///
 /// Any messages below this level will be excluded from the logs.
 log_level: LogLevel,
	},
	/// A custom logger.
	Custom(std::sync::Arc<LdkNodeLogger>),
}

impl Default for LoggingConfig {
	fn default() -> Self {
 Self::Filesystem {
 log_dir: format!("{}/{}", DEFAULT_STORAGE_DIR_PATH, "logs"),
 log_level: DEFAULT_LOG_LEVEL,
 }
	}
}

/// Configuration options pertaining to 'Anchor' channels, i.e., channels for which the
/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
///
Expand Down

8 changes: 4 additions & 4 deletions
src/gossip.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
// accordance with one or both of these licenses.

use crate::config::RGS_SYNC_TIMEOUT_SECS;
use crate::logger::{log_trace, FilesystemLogger, Logger};
use crate::logger::{log_trace, LdkNodeLogger, Logger};
use crate::types::{GossipSync, Graph, P2PGossipSync, RapidGossipSync};
use crate::Error;

Expand All@@ -24,12 +24,12 @@ pub(crate) enum GossipSource {
 gossip_sync: Arc<RapidGossipSync>,
 server_url: String,
 latest_sync_timestamp: AtomicU32,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	},
}

impl GossipSource {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<FilesystemLogger>) -> Self {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<LdkNodeLogger>) -> Self {
 let gossip_sync = Arc::new(P2PGossipSync::new(
 network_graph,
 None::<Arc<dyn UtxoLookup + Send + Sync>>,
Expand All@@ -40,7 +40,7 @@ impl GossipSource {

	pub fn new_rgs(
 server_url: String, latest_sync_timestamp: u32, network_graph: Arc<Graph>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	) -> Self {
 let gossip_sync = Arc::new(RapidGossipSync::new(network_graph, Arc::clone(&logger)));
 let latest_sync_timestamp = AtomicU32::new(latest_sync_timestamp);
Expand Down

6 changes: 3 additions & 3 deletions
src/io/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::{
	NODE_METRICS_KEY, NODE_METRICS_PRIMARY_NAMESPACE, NODE_METRICS_SECONDARY_NAMESPACE,
};
use crate::logger::{log_error, FilesystemLogger};
use crate::logger::{log_error, LdkNodeLogger};
use crate::peer_store::PeerStore;
use crate::sweep::DeprecatedSpendableOutputInfo;
use crate::types::{Broadcaster, DynStore, KeysManager, Sweeper};
Expand DownExpand Up@@ -226,7 +226,7 @@ where
pub(crate) fn read_output_sweeper(
	broadcaster: Arc<Broadcaster>, fee_estimator: Arc<OnchainFeeEstimator>,
	chain_data_source: Arc<ChainSource>, keys_manager: Arc<KeysManager>, kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<Sweeper, std::io::Error> {
	let mut reader = Cursor::new(kv_store.read(
 OUTPUT_SWEEPER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -600,7 +600,7 @@ impl_read_write_change_set_type!(

// Reads the full BdkWalletChangeSet or returns default fields
pub(crate) fn read_bdk_wallet_change_set(
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>,
) -> Result<Option<BdkWalletChangeSet>, std::io::Error> {
	let mut change_set = BdkWalletChangeSet::default();

Expand Down

14 changes: 7 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,7 @@ use types::{
};
pub use types::{ChannelDetails, PeerDetails, UserChannelId};

use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
use logger::{log_error, log_info, log_trace, LdkNodeLogger, Logger};

use lightning::chain::BestBlock;
use lightning::events::bump_transaction::Wallet as LdkWallet;
Expand DownExpand Up@@ -180,23 +180,23 @@ pub struct Node {
	wallet: Arc<Wallet>,
	chain_source: Arc<ChainSource>,
	tx_broadcaster: Arc<Broadcaster>,
	event_queue: Arc<EventQueue<Arc<FilesystemLogger>>>,
	event_queue: Arc<EventQueue<Arc<LdkNodeLogger>>>,
	channel_manager: Arc<ChannelManager>,
	chain_monitor: Arc<ChainMonitor>,
	output_sweeper: Arc<Sweeper>,
	peer_manager: Arc<PeerManager>,
	onion_messenger: Arc<OnionMessenger>,
	connection_manager: Arc<ConnectionManager<Arc<FilesystemLogger>>>,
	connection_manager: Arc<ConnectionManager<Arc<LdkNodeLogger>>>,
	keys_manager: Arc<KeysManager>,
	network_graph: Arc<Graph>,
	gossip_source: Arc<GossipSource>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<FilesystemLogger>>>>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<LdkNodeLogger>>>>,
	kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
	_router: Arc<Router>,
	scorer: Arc<Mutex<Scorer>>,
	peer_store: Arc<PeerStore<Arc<FilesystemLogger>>>,
	payment_store: Arc<PaymentStore<Arc<FilesystemLogger>>>,
	peer_store: Arc<PeerStore<Arc<LdkNodeLogger>>>,
	payment_store: Arc<PaymentStore<Arc<LdkNodeLogger>>>,
	is_listening: Arc<AtomicBool>,
	node_metrics: Arc<RwLock<NodeMetrics>>,
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add configurable logger by domZippilli · Pull Request #393 · lightningdevkit/ldk-node · GitHub
Skip to content
Add configurable logger#393

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.

 Sign up for GitHub

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

 Closed

domZippilli
wants to merge
3
commits into

from

 Closed


Add configurable logger
#393
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4f82769

Rename FilesystemLogger to LdkNodeLogger.


domZippilli Oct 25, 2024
2c54a18

Make LdkNodeLogger technically customizable, retain default behavior.


domZippilli Oct 28, 2024
b0e7fef

Add customizable logging to configuration.


domZippilli Oct 28, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


54 changes: 26 additions & 28 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
// accordance with one or both of these licenses.

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{default_user_config, Config, EsploraSyncConfig, WALLET_KEYS_SEED_LEN};
use crate::config::{
	default_user_config, Config, EsploraSyncConfig, LoggingConfig, WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
use crate::event::EventQueue;
Expand All@@ -16,7 +18,9 @@ use crate::io::sqlite_store::SqliteStore;
use crate::io::utils::{read_node_metrics, write_node_metrics};
use crate::io::vss_store::VssStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
use crate::logger::{
	default_format, log_error, log_info, FilesystemLogWriter, LdkNodeLogger, Logger,
};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::store::PaymentStore;
use crate::peer_store::PeerStore;
Expand All@@ -27,8 +31,8 @@ use crate::types::{
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
use crate::Node;
use crate::{io, NodeMetrics};
use crate::{LogLevel, Node};

use lightning::chain::{chainmonitor, BestBlock, Watch};
use lightning::io::Cursor;
Expand DownExpand Up@@ -298,12 +302,6 @@ impl NodeBuilder {
 self
	}

	/// Sets the log dir path if logs need to live separate from the storage directory path.
	pub fn set_log_dir_path(&mut self, log_dir_path: String) -> &mut Self {
 self.config.log_dir_path = Some(log_dir_path);
 self
	}

	/// Sets the Bitcoin network used.
	pub fn set_network(&mut self, network: Network) -> &mut Self {
 self.config.network = network;
Expand DownExpand Up@@ -333,12 +331,6 @@ impl NodeBuilder {
 Ok(self)
	}

	/// Sets the level at which [`Node`] will log messages.
	pub fn set_log_level(&mut self, level: LogLevel) -> &mut Self {
 self.config.log_level = level;
 self
	}

	/// Builds a [`Node`] instance with a [`SqliteStore`] backend and according to the options
	/// previously configured.
	pub fn build(&self) -> Result<Node, BuildError> {
Expand DownExpand Up@@ -734,7 +726,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<DynStore>,
	logger: Arc<LdkNodeLogger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	// Initialize the status fields.
	let is_listening = Arc::new(AtomicBool::new(false));
Expand DownExpand Up@@ -1231,21 +1223,27 @@ fn build_with_store_internal(
	})
}

fn setup_logger(config: &Config) -> Result<Arc<FilesystemLogger>, BuildError> {
	let log_dir = match &config.log_dir_path {
 Some(log_dir) => String::from(log_dir),
 None => config.storage_dir_path.clone() + "/logs",
	};

	Ok(Arc::new(
 FilesystemLogger::new(log_dir, config.log_level)
 .map_err(|_| BuildError::LoggerSetupFailed)?,
	))
fn setup_logger(config: &Config) -> Result<Arc<LdkNodeLogger>, BuildError> {
	match config.logging_config {
 LoggingConfig::Custom(ref logger) => Ok(logger.clone()),
 LoggingConfig::Filesystem { ref log_dir, log_level } => {
 let filesystem_log_writer = FilesystemLogWriter::new(log_dir.clone())
 .map_err(|_| BuildError::LoggerSetupFailed)?;
 Ok(Arc::new(
 LdkNodeLogger::new(
 log_level,
 Box::new(default_format),
 Box::new(move |s| filesystem_log_writer.write(s)),
 )
 .map_err(|_| BuildError::LoggerSetupFailed)?,
 ))
 },
	}
}

fn seed_bytes_from_config(
	config: &Config, entropy_source_config: Option<&EntropySourceConfig>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<[u8; 64], BuildError> {
	match entropy_source_config {
 Some(EntropySourceConfig::SeedBytes(bytes)) => Ok(bytes.clone()),
Expand All@@ -1267,7 +1265,7 @@ fn seed_bytes_from_config(
}

fn derive_vss_xprv(
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<FilesystemLogger>,
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<LdkNodeLogger>,
) -> Result<Xpriv, BuildError> {
	use bitcoin::key::Secp256k1;

Expand Down

14 changes: 7 additions & 7 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use crate::fee_estimator::{
	ConfirmationTarget, OnchainFeeEstimator,
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, FilesystemLogger, Logger};
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkNodeLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -112,13 +112,13 @@ pub(crate) enum ChainSource {
 esplora_client: EsploraAsyncClient,
 onchain_wallet: Arc<Wallet>,
 onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
 tx_sync: Arc<EsploraSyncClient<Arc<FilesystemLogger>>>,
 tx_sync: Arc<EsploraSyncClient<Arc<LdkNodeLogger>>>,
 lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
 fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
	BitcoindRpc {
Expand All@@ -131,7 +131,7 @@ pub(crate) enum ChainSource {
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
}
Expand All@@ -140,7 +140,7 @@ impl ChainSource {
	pub(crate) fn new_esplora(
 server_url: String, sync_config: EsploraSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<FilesystemLogger>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let mut client_builder = esplora_client::Builder::new(&server_url);
Expand DownExpand Up@@ -170,7 +170,7 @@ impl ChainSource {
 host: String, port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
 logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let bitcoind_rpc_client =
 Arc::new(BitcoindRpcClient::new(host, port, rpc_user, rpc_password));
Expand DownExpand Up@@ -1118,7 +1118,7 @@ impl Filter for ChainSource {

fn periodically_archive_fully_resolved_monitors(
	channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Result<(), Error> {
	let mut locked_node_metrics = node_metrics.write().unwrap();
	let cur_height = channel_manager.current_best_block().height;
Expand Down

41 changes: 33 additions & 8 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@

//! Objects for configuring the node.

use crate::logger::LdkNodeLogger;
use crate::payment::SendingParameters;

use lightning::ln::msgs::SocketAddress;
Expand DownExpand Up@@ -105,8 +106,9 @@ pub struct Config {
	pub storage_dir_path: String,
	/// The path where logs are stored.
	///
	/// If set to `None`, logs can be found in the `logs` subdirectory in [`Config::storage_dir_path`].
	pub log_dir_path: Option<String>,
	/// In the default configuration logs can be found in the `logs` subdirectory in
	/// [`Config::storage_dir_path`], and the log level is set to [`DEFAULT_LOG_LEVEL`].
	pub logging_config: LoggingConfig,
	/// The used Bitcoin network.
	pub network: Network,
	/// The addresses on which the node will listen for incoming connections.
Expand All@@ -132,10 +134,6 @@ pub struct Config {
	/// Channels with available liquidity less than the required amount times this value won't be
	/// used to send pre-flight probes.
	pub probing_liquidity_limit_multiplier: u64,
	/// The level at which we log messages.
	///
	/// Any messages below this level will be excluded from the logs.
	pub log_level: LogLevel,
	/// Configuration options pertaining to Anchor channels, i.e., channels for which the
	/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
	///
Expand DownExpand Up@@ -167,19 +165,46 @@ impl Default for Config {
	fn default() -> Self {
 Self {
 storage_dir_path: DEFAULT_STORAGE_DIR_PATH.to_string(),
log_dir_path: None,
logging_config: LoggingConfig::default(),
 network: DEFAULT_NETWORK,
 listening_addresses: None,
 trusted_peers_0conf: Vec::new(),
 probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
 log_level: DEFAULT_LOG_LEVEL,
 anchor_channels_config: Some(AnchorChannelsConfig::default()),
 sending_parameters: None,
 node_alias: None,
 }
	}
}

/// Configuration options for logging.
#[derive(Debug, Clone)]
pub enum LoggingConfig {
	/// An opinionated filesystem logger.
	///
	/// This logger will always write at `{log_dir}/ldk_node_latest.log`, which is a symlink to the
	/// most recent log file, which is created and timestamped at initialization.
	Filesystem {
 /// The absolute path where logs are stored.
 log_dir: String,
 /// The level at which we log messages.
 ///
 /// Any messages below this level will be excluded from the logs.
 log_level: LogLevel,
	},
	/// A custom logger.
	Custom(std::sync::Arc<LdkNodeLogger>),
}

impl Default for LoggingConfig {
	fn default() -> Self {
 Self::Filesystem {
 log_dir: format!("{}/{}", DEFAULT_STORAGE_DIR_PATH, "logs"),
 log_level: DEFAULT_LOG_LEVEL,
 }
	}
}

/// Configuration options pertaining to 'Anchor' channels, i.e., channels for which the
/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
///
Expand Down

8 changes: 4 additions & 4 deletions
src/gossip.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
// accordance with one or both of these licenses.

use crate::config::RGS_SYNC_TIMEOUT_SECS;
use crate::logger::{log_trace, FilesystemLogger, Logger};
use crate::logger::{log_trace, LdkNodeLogger, Logger};
use crate::types::{GossipSync, Graph, P2PGossipSync, RapidGossipSync};
use crate::Error;

Expand All@@ -24,12 +24,12 @@ pub(crate) enum GossipSource {
 gossip_sync: Arc<RapidGossipSync>,
 server_url: String,
 latest_sync_timestamp: AtomicU32,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	},
}

impl GossipSource {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<FilesystemLogger>) -> Self {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<LdkNodeLogger>) -> Self {
 let gossip_sync = Arc::new(P2PGossipSync::new(
 network_graph,
 None::<Arc<dyn UtxoLookup + Send + Sync>>,
Expand All@@ -40,7 +40,7 @@ impl GossipSource {

	pub fn new_rgs(
 server_url: String, latest_sync_timestamp: u32, network_graph: Arc<Graph>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	) -> Self {
 let gossip_sync = Arc::new(RapidGossipSync::new(network_graph, Arc::clone(&logger)));
 let latest_sync_timestamp = AtomicU32::new(latest_sync_timestamp);
Expand Down

6 changes: 3 additions & 3 deletions
src/io/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::{
	NODE_METRICS_KEY, NODE_METRICS_PRIMARY_NAMESPACE, NODE_METRICS_SECONDARY_NAMESPACE,
};
use crate::logger::{log_error, FilesystemLogger};
use crate::logger::{log_error, LdkNodeLogger};
use crate::peer_store::PeerStore;
use crate::sweep::DeprecatedSpendableOutputInfo;
use crate::types::{Broadcaster, DynStore, KeysManager, Sweeper};
Expand DownExpand Up@@ -226,7 +226,7 @@ where
pub(crate) fn read_output_sweeper(
	broadcaster: Arc<Broadcaster>, fee_estimator: Arc<OnchainFeeEstimator>,
	chain_data_source: Arc<ChainSource>, keys_manager: Arc<KeysManager>, kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<Sweeper, std::io::Error> {
	let mut reader = Cursor::new(kv_store.read(
 OUTPUT_SWEEPER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -600,7 +600,7 @@ impl_read_write_change_set_type!(

// Reads the full BdkWalletChangeSet or returns default fields
pub(crate) fn read_bdk_wallet_change_set(
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>,
) -> Result<Option<BdkWalletChangeSet>, std::io::Error> {
	let mut change_set = BdkWalletChangeSet::default();

Expand Down

14 changes: 7 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,7 @@ use types::{
};
pub use types::{ChannelDetails, PeerDetails, UserChannelId};

use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
use logger::{log_error, log_info, log_trace, LdkNodeLogger, Logger};

use lightning::chain::BestBlock;
use lightning::events::bump_transaction::Wallet as LdkWallet;
Expand DownExpand Up@@ -180,23 +180,23 @@ pub struct Node {
	wallet: Arc<Wallet>,
	chain_source: Arc<ChainSource>,
	tx_broadcaster: Arc<Broadcaster>,
	event_queue: Arc<EventQueue<Arc<FilesystemLogger>>>,
	event_queue: Arc<EventQueue<Arc<LdkNodeLogger>>>,
	channel_manager: Arc<ChannelManager>,
	chain_monitor: Arc<ChainMonitor>,
	output_sweeper: Arc<Sweeper>,
	peer_manager: Arc<PeerManager>,
	onion_messenger: Arc<OnionMessenger>,
	connection_manager: Arc<ConnectionManager<Arc<FilesystemLogger>>>,
	connection_manager: Arc<ConnectionManager<Arc<LdkNodeLogger>>>,
	keys_manager: Arc<KeysManager>,
	network_graph: Arc<Graph>,
	gossip_source: Arc<GossipSource>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<FilesystemLogger>>>>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<LdkNodeLogger>>>>,
	kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
	_router: Arc<Router>,
	scorer: Arc<Mutex<Scorer>>,
	peer_store: Arc<PeerStore<Arc<FilesystemLogger>>>,
	payment_store: Arc<PaymentStore<Arc<FilesystemLogger>>>,
	peer_store: Arc<PeerStore<Arc<LdkNodeLogger>>>,
	payment_store: Arc<PaymentStore<Arc<LdkNodeLogger>>>,
	is_listening: Arc<AtomicBool>,
	node_metrics: Arc<RwLock<NodeMetrics>>,
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add configurable logger by domZippilli · Pull Request #393 · lightningdevkit/ldk-node · GitHub
Skip to content
Add configurable logger#393

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.

 Sign up for GitHub

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

 Closed

domZippilli
wants to merge
3
commits into

from

 Closed


Add configurable logger
#393
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4f82769

Rename FilesystemLogger to LdkNodeLogger.


domZippilli Oct 25, 2024
2c54a18

Make LdkNodeLogger technically customizable, retain default behavior.


domZippilli Oct 28, 2024
b0e7fef

Add customizable logging to configuration.


domZippilli Oct 28, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


54 changes: 26 additions & 28 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
// accordance with one or both of these licenses.

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{default_user_config, Config, EsploraSyncConfig, WALLET_KEYS_SEED_LEN};
use crate::config::{
	default_user_config, Config, EsploraSyncConfig, LoggingConfig, WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
use crate::event::EventQueue;
Expand All@@ -16,7 +18,9 @@ use crate::io::sqlite_store::SqliteStore;
use crate::io::utils::{read_node_metrics, write_node_metrics};
use crate::io::vss_store::VssStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
use crate::logger::{
	default_format, log_error, log_info, FilesystemLogWriter, LdkNodeLogger, Logger,
};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::store::PaymentStore;
use crate::peer_store::PeerStore;
Expand All@@ -27,8 +31,8 @@ use crate::types::{
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
use crate::Node;
use crate::{io, NodeMetrics};
use crate::{LogLevel, Node};

use lightning::chain::{chainmonitor, BestBlock, Watch};
use lightning::io::Cursor;
Expand DownExpand Up@@ -298,12 +302,6 @@ impl NodeBuilder {
 self
	}

	/// Sets the log dir path if logs need to live separate from the storage directory path.
	pub fn set_log_dir_path(&mut self, log_dir_path: String) -> &mut Self {
 self.config.log_dir_path = Some(log_dir_path);
 self
	}

	/// Sets the Bitcoin network used.
	pub fn set_network(&mut self, network: Network) -> &mut Self {
 self.config.network = network;
Expand DownExpand Up@@ -333,12 +331,6 @@ impl NodeBuilder {
 Ok(self)
	}

	/// Sets the level at which [`Node`] will log messages.
	pub fn set_log_level(&mut self, level: LogLevel) -> &mut Self {
 self.config.log_level = level;
 self
	}

	/// Builds a [`Node`] instance with a [`SqliteStore`] backend and according to the options
	/// previously configured.
	pub fn build(&self) -> Result<Node, BuildError> {
Expand DownExpand Up@@ -734,7 +726,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<DynStore>,
	logger: Arc<LdkNodeLogger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	// Initialize the status fields.
	let is_listening = Arc::new(AtomicBool::new(false));
Expand DownExpand Up@@ -1231,21 +1223,27 @@ fn build_with_store_internal(
	})
}

fn setup_logger(config: &Config) -> Result<Arc<FilesystemLogger>, BuildError> {
	let log_dir = match &config.log_dir_path {
 Some(log_dir) => String::from(log_dir),
 None => config.storage_dir_path.clone() + "/logs",
	};

	Ok(Arc::new(
 FilesystemLogger::new(log_dir, config.log_level)
 .map_err(|_| BuildError::LoggerSetupFailed)?,
	))
fn setup_logger(config: &Config) -> Result<Arc<LdkNodeLogger>, BuildError> {
	match config.logging_config {
 LoggingConfig::Custom(ref logger) => Ok(logger.clone()),
 LoggingConfig::Filesystem { ref log_dir, log_level } => {
 let filesystem_log_writer = FilesystemLogWriter::new(log_dir.clone())
 .map_err(|_| BuildError::LoggerSetupFailed)?;
 Ok(Arc::new(
 LdkNodeLogger::new(
 log_level,
 Box::new(default_format),
 Box::new(move |s| filesystem_log_writer.write(s)),
 )
 .map_err(|_| BuildError::LoggerSetupFailed)?,
 ))
 },
	}
}

fn seed_bytes_from_config(
	config: &Config, entropy_source_config: Option<&EntropySourceConfig>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<[u8; 64], BuildError> {
	match entropy_source_config {
 Some(EntropySourceConfig::SeedBytes(bytes)) => Ok(bytes.clone()),
Expand All@@ -1267,7 +1265,7 @@ fn seed_bytes_from_config(
}

fn derive_vss_xprv(
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<FilesystemLogger>,
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<LdkNodeLogger>,
) -> Result<Xpriv, BuildError> {
	use bitcoin::key::Secp256k1;

Expand Down

14 changes: 7 additions & 7 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use crate::fee_estimator::{
	ConfirmationTarget, OnchainFeeEstimator,
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, FilesystemLogger, Logger};
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkNodeLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -112,13 +112,13 @@ pub(crate) enum ChainSource {
 esplora_client: EsploraAsyncClient,
 onchain_wallet: Arc<Wallet>,
 onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
 tx_sync: Arc<EsploraSyncClient<Arc<FilesystemLogger>>>,
 tx_sync: Arc<EsploraSyncClient<Arc<LdkNodeLogger>>>,
 lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
 fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
	BitcoindRpc {
Expand All@@ -131,7 +131,7 @@ pub(crate) enum ChainSource {
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
}
Expand All@@ -140,7 +140,7 @@ impl ChainSource {
	pub(crate) fn new_esplora(
 server_url: String, sync_config: EsploraSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<FilesystemLogger>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let mut client_builder = esplora_client::Builder::new(&server_url);
Expand DownExpand Up@@ -170,7 +170,7 @@ impl ChainSource {
 host: String, port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
 logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let bitcoind_rpc_client =
 Arc::new(BitcoindRpcClient::new(host, port, rpc_user, rpc_password));
Expand DownExpand Up@@ -1118,7 +1118,7 @@ impl Filter for ChainSource {

fn periodically_archive_fully_resolved_monitors(
	channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Result<(), Error> {
	let mut locked_node_metrics = node_metrics.write().unwrap();
	let cur_height = channel_manager.current_best_block().height;
Expand Down

41 changes: 33 additions & 8 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@

//! Objects for configuring the node.

use crate::logger::LdkNodeLogger;
use crate::payment::SendingParameters;

use lightning::ln::msgs::SocketAddress;
Expand DownExpand Up@@ -105,8 +106,9 @@ pub struct Config {
	pub storage_dir_path: String,
	/// The path where logs are stored.
	///
	/// If set to `None`, logs can be found in the `logs` subdirectory in [`Config::storage_dir_path`].
	pub log_dir_path: Option<String>,
	/// In the default configuration logs can be found in the `logs` subdirectory in
	/// [`Config::storage_dir_path`], and the log level is set to [`DEFAULT_LOG_LEVEL`].
	pub logging_config: LoggingConfig,
	/// The used Bitcoin network.
	pub network: Network,
	/// The addresses on which the node will listen for incoming connections.
Expand All@@ -132,10 +134,6 @@ pub struct Config {
	/// Channels with available liquidity less than the required amount times this value won't be
	/// used to send pre-flight probes.
	pub probing_liquidity_limit_multiplier: u64,
	/// The level at which we log messages.
	///
	/// Any messages below this level will be excluded from the logs.
	pub log_level: LogLevel,
	/// Configuration options pertaining to Anchor channels, i.e., channels for which the
	/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
	///
Expand DownExpand Up@@ -167,19 +165,46 @@ impl Default for Config {
	fn default() -> Self {
 Self {
 storage_dir_path: DEFAULT_STORAGE_DIR_PATH.to_string(),
log_dir_path: None,
logging_config: LoggingConfig::default(),
 network: DEFAULT_NETWORK,
 listening_addresses: None,
 trusted_peers_0conf: Vec::new(),
 probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
 log_level: DEFAULT_LOG_LEVEL,
 anchor_channels_config: Some(AnchorChannelsConfig::default()),
 sending_parameters: None,
 node_alias: None,
 }
	}
}

/// Configuration options for logging.
#[derive(Debug, Clone)]
pub enum LoggingConfig {
	/// An opinionated filesystem logger.
	///
	/// This logger will always write at `{log_dir}/ldk_node_latest.log`, which is a symlink to the
	/// most recent log file, which is created and timestamped at initialization.
	Filesystem {
 /// The absolute path where logs are stored.
 log_dir: String,
 /// The level at which we log messages.
 ///
 /// Any messages below this level will be excluded from the logs.
 log_level: LogLevel,
	},
	/// A custom logger.
	Custom(std::sync::Arc<LdkNodeLogger>),
}

impl Default for LoggingConfig {
	fn default() -> Self {
 Self::Filesystem {
 log_dir: format!("{}/{}", DEFAULT_STORAGE_DIR_PATH, "logs"),
 log_level: DEFAULT_LOG_LEVEL,
 }
	}
}

/// Configuration options pertaining to 'Anchor' channels, i.e., channels for which the
/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
///
Expand Down

8 changes: 4 additions & 4 deletions
src/gossip.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
// accordance with one or both of these licenses.

use crate::config::RGS_SYNC_TIMEOUT_SECS;
use crate::logger::{log_trace, FilesystemLogger, Logger};
use crate::logger::{log_trace, LdkNodeLogger, Logger};
use crate::types::{GossipSync, Graph, P2PGossipSync, RapidGossipSync};
use crate::Error;

Expand All@@ -24,12 +24,12 @@ pub(crate) enum GossipSource {
 gossip_sync: Arc<RapidGossipSync>,
 server_url: String,
 latest_sync_timestamp: AtomicU32,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	},
}

impl GossipSource {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<FilesystemLogger>) -> Self {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<LdkNodeLogger>) -> Self {
 let gossip_sync = Arc::new(P2PGossipSync::new(
 network_graph,
 None::<Arc<dyn UtxoLookup + Send + Sync>>,
Expand All@@ -40,7 +40,7 @@ impl GossipSource {

	pub fn new_rgs(
 server_url: String, latest_sync_timestamp: u32, network_graph: Arc<Graph>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	) -> Self {
 let gossip_sync = Arc::new(RapidGossipSync::new(network_graph, Arc::clone(&logger)));
 let latest_sync_timestamp = AtomicU32::new(latest_sync_timestamp);
Expand Down

6 changes: 3 additions & 3 deletions
src/io/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::{
	NODE_METRICS_KEY, NODE_METRICS_PRIMARY_NAMESPACE, NODE_METRICS_SECONDARY_NAMESPACE,
};
use crate::logger::{log_error, FilesystemLogger};
use crate::logger::{log_error, LdkNodeLogger};
use crate::peer_store::PeerStore;
use crate::sweep::DeprecatedSpendableOutputInfo;
use crate::types::{Broadcaster, DynStore, KeysManager, Sweeper};
Expand DownExpand Up@@ -226,7 +226,7 @@ where
pub(crate) fn read_output_sweeper(
	broadcaster: Arc<Broadcaster>, fee_estimator: Arc<OnchainFeeEstimator>,
	chain_data_source: Arc<ChainSource>, keys_manager: Arc<KeysManager>, kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<Sweeper, std::io::Error> {
	let mut reader = Cursor::new(kv_store.read(
 OUTPUT_SWEEPER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -600,7 +600,7 @@ impl_read_write_change_set_type!(

// Reads the full BdkWalletChangeSet or returns default fields
pub(crate) fn read_bdk_wallet_change_set(
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>,
) -> Result<Option<BdkWalletChangeSet>, std::io::Error> {
	let mut change_set = BdkWalletChangeSet::default();

Expand Down

14 changes: 7 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,7 @@ use types::{
};
pub use types::{ChannelDetails, PeerDetails, UserChannelId};

use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
use logger::{log_error, log_info, log_trace, LdkNodeLogger, Logger};

use lightning::chain::BestBlock;
use lightning::events::bump_transaction::Wallet as LdkWallet;
Expand DownExpand Up@@ -180,23 +180,23 @@ pub struct Node {
	wallet: Arc<Wallet>,
	chain_source: Arc<ChainSource>,
	tx_broadcaster: Arc<Broadcaster>,
	event_queue: Arc<EventQueue<Arc<FilesystemLogger>>>,
	event_queue: Arc<EventQueue<Arc<LdkNodeLogger>>>,
	channel_manager: Arc<ChannelManager>,
	chain_monitor: Arc<ChainMonitor>,
	output_sweeper: Arc<Sweeper>,
	peer_manager: Arc<PeerManager>,
	onion_messenger: Arc<OnionMessenger>,
	connection_manager: Arc<ConnectionManager<Arc<FilesystemLogger>>>,
	connection_manager: Arc<ConnectionManager<Arc<LdkNodeLogger>>>,
	keys_manager: Arc<KeysManager>,
	network_graph: Arc<Graph>,
	gossip_source: Arc<GossipSource>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<FilesystemLogger>>>>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<LdkNodeLogger>>>>,
	kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
	_router: Arc<Router>,
	scorer: Arc<Mutex<Scorer>>,
	peer_store: Arc<PeerStore<Arc<FilesystemLogger>>>,
	payment_store: Arc<PaymentStore<Arc<FilesystemLogger>>>,
	peer_store: Arc<PeerStore<Arc<LdkNodeLogger>>>,
	payment_store: Arc<PaymentStore<Arc<LdkNodeLogger>>>,
	is_listening: Arc<AtomicBool>,
	node_metrics: Arc<RwLock<NodeMetrics>>,
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add configurable logger by domZippilli · Pull Request #393 · lightningdevkit/ldk-node · GitHub
Skip to content
Add configurable logger#393

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.

 Sign up for GitHub

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

 Closed

domZippilli
wants to merge
3
commits into

from

 Closed


Add configurable logger
#393
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4f82769

Rename FilesystemLogger to LdkNodeLogger.


domZippilli Oct 25, 2024
2c54a18

Make LdkNodeLogger technically customizable, retain default behavior.


domZippilli Oct 28, 2024
b0e7fef

Add customizable logging to configuration.


domZippilli Oct 28, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


54 changes: 26 additions & 28 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
// accordance with one or both of these licenses.

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{default_user_config, Config, EsploraSyncConfig, WALLET_KEYS_SEED_LEN};
use crate::config::{
	default_user_config, Config, EsploraSyncConfig, LoggingConfig, WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
use crate::event::EventQueue;
Expand All@@ -16,7 +18,9 @@ use crate::io::sqlite_store::SqliteStore;
use crate::io::utils::{read_node_metrics, write_node_metrics};
use crate::io::vss_store::VssStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
use crate::logger::{
	default_format, log_error, log_info, FilesystemLogWriter, LdkNodeLogger, Logger,
};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::store::PaymentStore;
use crate::peer_store::PeerStore;
Expand All@@ -27,8 +31,8 @@ use crate::types::{
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
use crate::Node;
use crate::{io, NodeMetrics};
use crate::{LogLevel, Node};

use lightning::chain::{chainmonitor, BestBlock, Watch};
use lightning::io::Cursor;
Expand DownExpand Up@@ -298,12 +302,6 @@ impl NodeBuilder {
 self
	}

	/// Sets the log dir path if logs need to live separate from the storage directory path.
	pub fn set_log_dir_path(&mut self, log_dir_path: String) -> &mut Self {
 self.config.log_dir_path = Some(log_dir_path);
 self
	}

	/// Sets the Bitcoin network used.
	pub fn set_network(&mut self, network: Network) -> &mut Self {
 self.config.network = network;
Expand DownExpand Up@@ -333,12 +331,6 @@ impl NodeBuilder {
 Ok(self)
	}

	/// Sets the level at which [`Node`] will log messages.
	pub fn set_log_level(&mut self, level: LogLevel) -> &mut Self {
 self.config.log_level = level;
 self
	}

	/// Builds a [`Node`] instance with a [`SqliteStore`] backend and according to the options
	/// previously configured.
	pub fn build(&self) -> Result<Node, BuildError> {
Expand DownExpand Up@@ -734,7 +726,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<DynStore>,
	logger: Arc<LdkNodeLogger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	// Initialize the status fields.
	let is_listening = Arc::new(AtomicBool::new(false));
Expand DownExpand Up@@ -1231,21 +1223,27 @@ fn build_with_store_internal(
	})
}

fn setup_logger(config: &Config) -> Result<Arc<FilesystemLogger>, BuildError> {
	let log_dir = match &config.log_dir_path {
 Some(log_dir) => String::from(log_dir),
 None => config.storage_dir_path.clone() + "/logs",
	};

	Ok(Arc::new(
 FilesystemLogger::new(log_dir, config.log_level)
 .map_err(|_| BuildError::LoggerSetupFailed)?,
	))
fn setup_logger(config: &Config) -> Result<Arc<LdkNodeLogger>, BuildError> {
	match config.logging_config {
 LoggingConfig::Custom(ref logger) => Ok(logger.clone()),
 LoggingConfig::Filesystem { ref log_dir, log_level } => {
 let filesystem_log_writer = FilesystemLogWriter::new(log_dir.clone())
 .map_err(|_| BuildError::LoggerSetupFailed)?;
 Ok(Arc::new(
 LdkNodeLogger::new(
 log_level,
 Box::new(default_format),
 Box::new(move |s| filesystem_log_writer.write(s)),
 )
 .map_err(|_| BuildError::LoggerSetupFailed)?,
 ))
 },
	}
}

fn seed_bytes_from_config(
	config: &Config, entropy_source_config: Option<&EntropySourceConfig>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<[u8; 64], BuildError> {
	match entropy_source_config {
 Some(EntropySourceConfig::SeedBytes(bytes)) => Ok(bytes.clone()),
Expand All@@ -1267,7 +1265,7 @@ fn seed_bytes_from_config(
}

fn derive_vss_xprv(
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<FilesystemLogger>,
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<LdkNodeLogger>,
) -> Result<Xpriv, BuildError> {
	use bitcoin::key::Secp256k1;

Expand Down

14 changes: 7 additions & 7 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use crate::fee_estimator::{
	ConfirmationTarget, OnchainFeeEstimator,
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, FilesystemLogger, Logger};
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkNodeLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -112,13 +112,13 @@ pub(crate) enum ChainSource {
 esplora_client: EsploraAsyncClient,
 onchain_wallet: Arc<Wallet>,
 onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
 tx_sync: Arc<EsploraSyncClient<Arc<FilesystemLogger>>>,
 tx_sync: Arc<EsploraSyncClient<Arc<LdkNodeLogger>>>,
 lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
 fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
	BitcoindRpc {
Expand All@@ -131,7 +131,7 @@ pub(crate) enum ChainSource {
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
}
Expand All@@ -140,7 +140,7 @@ impl ChainSource {
	pub(crate) fn new_esplora(
 server_url: String, sync_config: EsploraSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<FilesystemLogger>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let mut client_builder = esplora_client::Builder::new(&server_url);
Expand DownExpand Up@@ -170,7 +170,7 @@ impl ChainSource {
 host: String, port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
 logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let bitcoind_rpc_client =
 Arc::new(BitcoindRpcClient::new(host, port, rpc_user, rpc_password));
Expand DownExpand Up@@ -1118,7 +1118,7 @@ impl Filter for ChainSource {

fn periodically_archive_fully_resolved_monitors(
	channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Result<(), Error> {
	let mut locked_node_metrics = node_metrics.write().unwrap();
	let cur_height = channel_manager.current_best_block().height;
Expand Down

41 changes: 33 additions & 8 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@

//! Objects for configuring the node.

use crate::logger::LdkNodeLogger;
use crate::payment::SendingParameters;

use lightning::ln::msgs::SocketAddress;
Expand DownExpand Up@@ -105,8 +106,9 @@ pub struct Config {
	pub storage_dir_path: String,
	/// The path where logs are stored.
	///
	/// If set to `None`, logs can be found in the `logs` subdirectory in [`Config::storage_dir_path`].
	pub log_dir_path: Option<String>,
	/// In the default configuration logs can be found in the `logs` subdirectory in
	/// [`Config::storage_dir_path`], and the log level is set to [`DEFAULT_LOG_LEVEL`].
	pub logging_config: LoggingConfig,
	/// The used Bitcoin network.
	pub network: Network,
	/// The addresses on which the node will listen for incoming connections.
Expand All@@ -132,10 +134,6 @@ pub struct Config {
	/// Channels with available liquidity less than the required amount times this value won't be
	/// used to send pre-flight probes.
	pub probing_liquidity_limit_multiplier: u64,
	/// The level at which we log messages.
	///
	/// Any messages below this level will be excluded from the logs.
	pub log_level: LogLevel,
	/// Configuration options pertaining to Anchor channels, i.e., channels for which the
	/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
	///
Expand DownExpand Up@@ -167,19 +165,46 @@ impl Default for Config {
	fn default() -> Self {
 Self {
 storage_dir_path: DEFAULT_STORAGE_DIR_PATH.to_string(),
log_dir_path: None,
logging_config: LoggingConfig::default(),
 network: DEFAULT_NETWORK,
 listening_addresses: None,
 trusted_peers_0conf: Vec::new(),
 probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
 log_level: DEFAULT_LOG_LEVEL,
 anchor_channels_config: Some(AnchorChannelsConfig::default()),
 sending_parameters: None,
 node_alias: None,
 }
	}
}

/// Configuration options for logging.
#[derive(Debug, Clone)]
pub enum LoggingConfig {
	/// An opinionated filesystem logger.
	///
	/// This logger will always write at `{log_dir}/ldk_node_latest.log`, which is a symlink to the
	/// most recent log file, which is created and timestamped at initialization.
	Filesystem {
 /// The absolute path where logs are stored.
 log_dir: String,
 /// The level at which we log messages.
 ///
 /// Any messages below this level will be excluded from the logs.
 log_level: LogLevel,
	},
	/// A custom logger.
	Custom(std::sync::Arc<LdkNodeLogger>),
}

impl Default for LoggingConfig {
	fn default() -> Self {
 Self::Filesystem {
 log_dir: format!("{}/{}", DEFAULT_STORAGE_DIR_PATH, "logs"),
 log_level: DEFAULT_LOG_LEVEL,
 }
	}
}

/// Configuration options pertaining to 'Anchor' channels, i.e., channels for which the
/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
///
Expand Down

8 changes: 4 additions & 4 deletions
src/gossip.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
// accordance with one or both of these licenses.

use crate::config::RGS_SYNC_TIMEOUT_SECS;
use crate::logger::{log_trace, FilesystemLogger, Logger};
use crate::logger::{log_trace, LdkNodeLogger, Logger};
use crate::types::{GossipSync, Graph, P2PGossipSync, RapidGossipSync};
use crate::Error;

Expand All@@ -24,12 +24,12 @@ pub(crate) enum GossipSource {
 gossip_sync: Arc<RapidGossipSync>,
 server_url: String,
 latest_sync_timestamp: AtomicU32,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	},
}

impl GossipSource {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<FilesystemLogger>) -> Self {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<LdkNodeLogger>) -> Self {
 let gossip_sync = Arc::new(P2PGossipSync::new(
 network_graph,
 None::<Arc<dyn UtxoLookup + Send + Sync>>,
Expand All@@ -40,7 +40,7 @@ impl GossipSource {

	pub fn new_rgs(
 server_url: String, latest_sync_timestamp: u32, network_graph: Arc<Graph>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	) -> Self {
 let gossip_sync = Arc::new(RapidGossipSync::new(network_graph, Arc::clone(&logger)));
 let latest_sync_timestamp = AtomicU32::new(latest_sync_timestamp);
Expand Down

6 changes: 3 additions & 3 deletions
src/io/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::{
	NODE_METRICS_KEY, NODE_METRICS_PRIMARY_NAMESPACE, NODE_METRICS_SECONDARY_NAMESPACE,
};
use crate::logger::{log_error, FilesystemLogger};
use crate::logger::{log_error, LdkNodeLogger};
use crate::peer_store::PeerStore;
use crate::sweep::DeprecatedSpendableOutputInfo;
use crate::types::{Broadcaster, DynStore, KeysManager, Sweeper};
Expand DownExpand Up@@ -226,7 +226,7 @@ where
pub(crate) fn read_output_sweeper(
	broadcaster: Arc<Broadcaster>, fee_estimator: Arc<OnchainFeeEstimator>,
	chain_data_source: Arc<ChainSource>, keys_manager: Arc<KeysManager>, kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<Sweeper, std::io::Error> {
	let mut reader = Cursor::new(kv_store.read(
 OUTPUT_SWEEPER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -600,7 +600,7 @@ impl_read_write_change_set_type!(

// Reads the full BdkWalletChangeSet or returns default fields
pub(crate) fn read_bdk_wallet_change_set(
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>,
) -> Result<Option<BdkWalletChangeSet>, std::io::Error> {
	let mut change_set = BdkWalletChangeSet::default();

Expand Down

14 changes: 7 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,7 @@ use types::{
};
pub use types::{ChannelDetails, PeerDetails, UserChannelId};

use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
use logger::{log_error, log_info, log_trace, LdkNodeLogger, Logger};

use lightning::chain::BestBlock;
use lightning::events::bump_transaction::Wallet as LdkWallet;
Expand DownExpand Up@@ -180,23 +180,23 @@ pub struct Node {
	wallet: Arc<Wallet>,
	chain_source: Arc<ChainSource>,
	tx_broadcaster: Arc<Broadcaster>,
	event_queue: Arc<EventQueue<Arc<FilesystemLogger>>>,
	event_queue: Arc<EventQueue<Arc<LdkNodeLogger>>>,
	channel_manager: Arc<ChannelManager>,
	chain_monitor: Arc<ChainMonitor>,
	output_sweeper: Arc<Sweeper>,
	peer_manager: Arc<PeerManager>,
	onion_messenger: Arc<OnionMessenger>,
	connection_manager: Arc<ConnectionManager<Arc<FilesystemLogger>>>,
	connection_manager: Arc<ConnectionManager<Arc<LdkNodeLogger>>>,
	keys_manager: Arc<KeysManager>,
	network_graph: Arc<Graph>,
	gossip_source: Arc<GossipSource>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<FilesystemLogger>>>>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<LdkNodeLogger>>>>,
	kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
	_router: Arc<Router>,
	scorer: Arc<Mutex<Scorer>>,
	peer_store: Arc<PeerStore<Arc<FilesystemLogger>>>,
	payment_store: Arc<PaymentStore<Arc<FilesystemLogger>>>,
	peer_store: Arc<PeerStore<Arc<LdkNodeLogger>>>,
	payment_store: Arc<PaymentStore<Arc<LdkNodeLogger>>>,
	is_listening: Arc<AtomicBool>,
	node_metrics: Arc<RwLock<NodeMetrics>>,
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add configurable logger by domZippilli · Pull Request #393 · lightningdevkit/ldk-node · GitHub
Skip to content
Add configurable logger#393

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.

 Sign up for GitHub

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

 Closed

domZippilli
wants to merge
3
commits into

from

 Closed


Add configurable logger
#393
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4f82769

Rename FilesystemLogger to LdkNodeLogger.


domZippilli Oct 25, 2024
2c54a18

Make LdkNodeLogger technically customizable, retain default behavior.


domZippilli Oct 28, 2024
b0e7fef

Add customizable logging to configuration.


domZippilli Oct 28, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


54 changes: 26 additions & 28 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
// accordance with one or both of these licenses.

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{default_user_config, Config, EsploraSyncConfig, WALLET_KEYS_SEED_LEN};
use crate::config::{
	default_user_config, Config, EsploraSyncConfig, LoggingConfig, WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
use crate::event::EventQueue;
Expand All@@ -16,7 +18,9 @@ use crate::io::sqlite_store::SqliteStore;
use crate::io::utils::{read_node_metrics, write_node_metrics};
use crate::io::vss_store::VssStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
use crate::logger::{
	default_format, log_error, log_info, FilesystemLogWriter, LdkNodeLogger, Logger,
};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::store::PaymentStore;
use crate::peer_store::PeerStore;
Expand All@@ -27,8 +31,8 @@ use crate::types::{
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
use crate::Node;
use crate::{io, NodeMetrics};
use crate::{LogLevel, Node};

use lightning::chain::{chainmonitor, BestBlock, Watch};
use lightning::io::Cursor;
Expand DownExpand Up@@ -298,12 +302,6 @@ impl NodeBuilder {
 self
	}

	/// Sets the log dir path if logs need to live separate from the storage directory path.
	pub fn set_log_dir_path(&mut self, log_dir_path: String) -> &mut Self {
 self.config.log_dir_path = Some(log_dir_path);
 self
	}

	/// Sets the Bitcoin network used.
	pub fn set_network(&mut self, network: Network) -> &mut Self {
 self.config.network = network;
Expand DownExpand Up@@ -333,12 +331,6 @@ impl NodeBuilder {
 Ok(self)
	}

	/// Sets the level at which [`Node`] will log messages.
	pub fn set_log_level(&mut self, level: LogLevel) -> &mut Self {
 self.config.log_level = level;
 self
	}

	/// Builds a [`Node`] instance with a [`SqliteStore`] backend and according to the options
	/// previously configured.
	pub fn build(&self) -> Result<Node, BuildError> {
Expand DownExpand Up@@ -734,7 +726,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<DynStore>,
	logger: Arc<LdkNodeLogger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	// Initialize the status fields.
	let is_listening = Arc::new(AtomicBool::new(false));
Expand DownExpand Up@@ -1231,21 +1223,27 @@ fn build_with_store_internal(
	})
}

fn setup_logger(config: &Config) -> Result<Arc<FilesystemLogger>, BuildError> {
	let log_dir = match &config.log_dir_path {
 Some(log_dir) => String::from(log_dir),
 None => config.storage_dir_path.clone() + "/logs",
	};

	Ok(Arc::new(
 FilesystemLogger::new(log_dir, config.log_level)
 .map_err(|_| BuildError::LoggerSetupFailed)?,
	))
fn setup_logger(config: &Config) -> Result<Arc<LdkNodeLogger>, BuildError> {
	match config.logging_config {
 LoggingConfig::Custom(ref logger) => Ok(logger.clone()),
 LoggingConfig::Filesystem { ref log_dir, log_level } => {
 let filesystem_log_writer = FilesystemLogWriter::new(log_dir.clone())
 .map_err(|_| BuildError::LoggerSetupFailed)?;
 Ok(Arc::new(
 LdkNodeLogger::new(
 log_level,
 Box::new(default_format),
 Box::new(move |s| filesystem_log_writer.write(s)),
 )
 .map_err(|_| BuildError::LoggerSetupFailed)?,
 ))
 },
	}
}

fn seed_bytes_from_config(
	config: &Config, entropy_source_config: Option<&EntropySourceConfig>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<[u8; 64], BuildError> {
	match entropy_source_config {
 Some(EntropySourceConfig::SeedBytes(bytes)) => Ok(bytes.clone()),
Expand All@@ -1267,7 +1265,7 @@ fn seed_bytes_from_config(
}

fn derive_vss_xprv(
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<FilesystemLogger>,
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<LdkNodeLogger>,
) -> Result<Xpriv, BuildError> {
	use bitcoin::key::Secp256k1;

Expand Down

14 changes: 7 additions & 7 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use crate::fee_estimator::{
	ConfirmationTarget, OnchainFeeEstimator,
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, FilesystemLogger, Logger};
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkNodeLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -112,13 +112,13 @@ pub(crate) enum ChainSource {
 esplora_client: EsploraAsyncClient,
 onchain_wallet: Arc<Wallet>,
 onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
 tx_sync: Arc<EsploraSyncClient<Arc<FilesystemLogger>>>,
 tx_sync: Arc<EsploraSyncClient<Arc<LdkNodeLogger>>>,
 lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
 fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
	BitcoindRpc {
Expand All@@ -131,7 +131,7 @@ pub(crate) enum ChainSource {
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
}
Expand All@@ -140,7 +140,7 @@ impl ChainSource {
	pub(crate) fn new_esplora(
 server_url: String, sync_config: EsploraSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<FilesystemLogger>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let mut client_builder = esplora_client::Builder::new(&server_url);
Expand DownExpand Up@@ -170,7 +170,7 @@ impl ChainSource {
 host: String, port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
 logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let bitcoind_rpc_client =
 Arc::new(BitcoindRpcClient::new(host, port, rpc_user, rpc_password));
Expand DownExpand Up@@ -1118,7 +1118,7 @@ impl Filter for ChainSource {

fn periodically_archive_fully_resolved_monitors(
	channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Result<(), Error> {
	let mut locked_node_metrics = node_metrics.write().unwrap();
	let cur_height = channel_manager.current_best_block().height;
Expand Down

41 changes: 33 additions & 8 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@

//! Objects for configuring the node.

use crate::logger::LdkNodeLogger;
use crate::payment::SendingParameters;

use lightning::ln::msgs::SocketAddress;
Expand DownExpand Up@@ -105,8 +106,9 @@ pub struct Config {
	pub storage_dir_path: String,
	/// The path where logs are stored.
	///
	/// If set to `None`, logs can be found in the `logs` subdirectory in [`Config::storage_dir_path`].
	pub log_dir_path: Option<String>,
	/// In the default configuration logs can be found in the `logs` subdirectory in
	/// [`Config::storage_dir_path`], and the log level is set to [`DEFAULT_LOG_LEVEL`].
	pub logging_config: LoggingConfig,
	/// The used Bitcoin network.
	pub network: Network,
	/// The addresses on which the node will listen for incoming connections.
Expand All@@ -132,10 +134,6 @@ pub struct Config {
	/// Channels with available liquidity less than the required amount times this value won't be
	/// used to send pre-flight probes.
	pub probing_liquidity_limit_multiplier: u64,
	/// The level at which we log messages.
	///
	/// Any messages below this level will be excluded from the logs.
	pub log_level: LogLevel,
	/// Configuration options pertaining to Anchor channels, i.e., channels for which the
	/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
	///
Expand DownExpand Up@@ -167,19 +165,46 @@ impl Default for Config {
	fn default() -> Self {
 Self {
 storage_dir_path: DEFAULT_STORAGE_DIR_PATH.to_string(),
log_dir_path: None,
logging_config: LoggingConfig::default(),
 network: DEFAULT_NETWORK,
 listening_addresses: None,
 trusted_peers_0conf: Vec::new(),
 probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
 log_level: DEFAULT_LOG_LEVEL,
 anchor_channels_config: Some(AnchorChannelsConfig::default()),
 sending_parameters: None,
 node_alias: None,
 }
	}
}

/// Configuration options for logging.
#[derive(Debug, Clone)]
pub enum LoggingConfig {
	/// An opinionated filesystem logger.
	///
	/// This logger will always write at `{log_dir}/ldk_node_latest.log`, which is a symlink to the
	/// most recent log file, which is created and timestamped at initialization.
	Filesystem {
 /// The absolute path where logs are stored.
 log_dir: String,
 /// The level at which we log messages.
 ///
 /// Any messages below this level will be excluded from the logs.
 log_level: LogLevel,
	},
	/// A custom logger.
	Custom(std::sync::Arc<LdkNodeLogger>),
}

impl Default for LoggingConfig {
	fn default() -> Self {
 Self::Filesystem {
 log_dir: format!("{}/{}", DEFAULT_STORAGE_DIR_PATH, "logs"),
 log_level: DEFAULT_LOG_LEVEL,
 }
	}
}

/// Configuration options pertaining to 'Anchor' channels, i.e., channels for which the
/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
///
Expand Down

8 changes: 4 additions & 4 deletions
src/gossip.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
// accordance with one or both of these licenses.

use crate::config::RGS_SYNC_TIMEOUT_SECS;
use crate::logger::{log_trace, FilesystemLogger, Logger};
use crate::logger::{log_trace, LdkNodeLogger, Logger};
use crate::types::{GossipSync, Graph, P2PGossipSync, RapidGossipSync};
use crate::Error;

Expand All@@ -24,12 +24,12 @@ pub(crate) enum GossipSource {
 gossip_sync: Arc<RapidGossipSync>,
 server_url: String,
 latest_sync_timestamp: AtomicU32,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	},
}

impl GossipSource {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<FilesystemLogger>) -> Self {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<LdkNodeLogger>) -> Self {
 let gossip_sync = Arc::new(P2PGossipSync::new(
 network_graph,
 None::<Arc<dyn UtxoLookup + Send + Sync>>,
Expand All@@ -40,7 +40,7 @@ impl GossipSource {

	pub fn new_rgs(
 server_url: String, latest_sync_timestamp: u32, network_graph: Arc<Graph>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	) -> Self {
 let gossip_sync = Arc::new(RapidGossipSync::new(network_graph, Arc::clone(&logger)));
 let latest_sync_timestamp = AtomicU32::new(latest_sync_timestamp);
Expand Down

6 changes: 3 additions & 3 deletions
src/io/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::{
	NODE_METRICS_KEY, NODE_METRICS_PRIMARY_NAMESPACE, NODE_METRICS_SECONDARY_NAMESPACE,
};
use crate::logger::{log_error, FilesystemLogger};
use crate::logger::{log_error, LdkNodeLogger};
use crate::peer_store::PeerStore;
use crate::sweep::DeprecatedSpendableOutputInfo;
use crate::types::{Broadcaster, DynStore, KeysManager, Sweeper};
Expand DownExpand Up@@ -226,7 +226,7 @@ where
pub(crate) fn read_output_sweeper(
	broadcaster: Arc<Broadcaster>, fee_estimator: Arc<OnchainFeeEstimator>,
	chain_data_source: Arc<ChainSource>, keys_manager: Arc<KeysManager>, kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<Sweeper, std::io::Error> {
	let mut reader = Cursor::new(kv_store.read(
 OUTPUT_SWEEPER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -600,7 +600,7 @@ impl_read_write_change_set_type!(

// Reads the full BdkWalletChangeSet or returns default fields
pub(crate) fn read_bdk_wallet_change_set(
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>,
) -> Result<Option<BdkWalletChangeSet>, std::io::Error> {
	let mut change_set = BdkWalletChangeSet::default();

Expand Down

14 changes: 7 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,7 @@ use types::{
};
pub use types::{ChannelDetails, PeerDetails, UserChannelId};

use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
use logger::{log_error, log_info, log_trace, LdkNodeLogger, Logger};

use lightning::chain::BestBlock;
use lightning::events::bump_transaction::Wallet as LdkWallet;
Expand DownExpand Up@@ -180,23 +180,23 @@ pub struct Node {
	wallet: Arc<Wallet>,
	chain_source: Arc<ChainSource>,
	tx_broadcaster: Arc<Broadcaster>,
	event_queue: Arc<EventQueue<Arc<FilesystemLogger>>>,
	event_queue: Arc<EventQueue<Arc<LdkNodeLogger>>>,
	channel_manager: Arc<ChannelManager>,
	chain_monitor: Arc<ChainMonitor>,
	output_sweeper: Arc<Sweeper>,
	peer_manager: Arc<PeerManager>,
	onion_messenger: Arc<OnionMessenger>,
	connection_manager: Arc<ConnectionManager<Arc<FilesystemLogger>>>,
	connection_manager: Arc<ConnectionManager<Arc<LdkNodeLogger>>>,
	keys_manager: Arc<KeysManager>,
	network_graph: Arc<Graph>,
	gossip_source: Arc<GossipSource>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<FilesystemLogger>>>>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<LdkNodeLogger>>>>,
	kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
	_router: Arc<Router>,
	scorer: Arc<Mutex<Scorer>>,
	peer_store: Arc<PeerStore<Arc<FilesystemLogger>>>,
	payment_store: Arc<PaymentStore<Arc<FilesystemLogger>>>,
	peer_store: Arc<PeerStore<Arc<LdkNodeLogger>>>,
	payment_store: Arc<PaymentStore<Arc<LdkNodeLogger>>>,
	is_listening: Arc<AtomicBool>,
	node_metrics: Arc<RwLock<NodeMetrics>>,
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add configurable logger by domZippilli · Pull Request #393 · lightningdevkit/ldk-node · GitHub
Skip to content
Add configurable logger#393

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.

 Sign up for GitHub

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

 Closed

domZippilli
wants to merge
3
commits into

from

 Closed


Add configurable logger
#393
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4f82769

Rename FilesystemLogger to LdkNodeLogger.


domZippilli Oct 25, 2024
2c54a18

Make LdkNodeLogger technically customizable, retain default behavior.


domZippilli Oct 28, 2024
b0e7fef

Add customizable logging to configuration.


domZippilli Oct 28, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


54 changes: 26 additions & 28 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
// accordance with one or both of these licenses.

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{default_user_config, Config, EsploraSyncConfig, WALLET_KEYS_SEED_LEN};
use crate::config::{
	default_user_config, Config, EsploraSyncConfig, LoggingConfig, WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
use crate::event::EventQueue;
Expand All@@ -16,7 +18,9 @@ use crate::io::sqlite_store::SqliteStore;
use crate::io::utils::{read_node_metrics, write_node_metrics};
use crate::io::vss_store::VssStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
use crate::logger::{
	default_format, log_error, log_info, FilesystemLogWriter, LdkNodeLogger, Logger,
};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::store::PaymentStore;
use crate::peer_store::PeerStore;
Expand All@@ -27,8 +31,8 @@ use crate::types::{
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
use crate::Node;
use crate::{io, NodeMetrics};
use crate::{LogLevel, Node};

use lightning::chain::{chainmonitor, BestBlock, Watch};
use lightning::io::Cursor;
Expand DownExpand Up@@ -298,12 +302,6 @@ impl NodeBuilder {
 self
	}

	/// Sets the log dir path if logs need to live separate from the storage directory path.
	pub fn set_log_dir_path(&mut self, log_dir_path: String) -> &mut Self {
 self.config.log_dir_path = Some(log_dir_path);
 self
	}

	/// Sets the Bitcoin network used.
	pub fn set_network(&mut self, network: Network) -> &mut Self {
 self.config.network = network;
Expand DownExpand Up@@ -333,12 +331,6 @@ impl NodeBuilder {
 Ok(self)
	}

	/// Sets the level at which [`Node`] will log messages.
	pub fn set_log_level(&mut self, level: LogLevel) -> &mut Self {
 self.config.log_level = level;
 self
	}

	/// Builds a [`Node`] instance with a [`SqliteStore`] backend and according to the options
	/// previously configured.
	pub fn build(&self) -> Result<Node, BuildError> {
Expand DownExpand Up@@ -734,7 +726,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<DynStore>,
	logger: Arc<LdkNodeLogger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	// Initialize the status fields.
	let is_listening = Arc::new(AtomicBool::new(false));
Expand DownExpand Up@@ -1231,21 +1223,27 @@ fn build_with_store_internal(
	})
}

fn setup_logger(config: &Config) -> Result<Arc<FilesystemLogger>, BuildError> {
	let log_dir = match &config.log_dir_path {
 Some(log_dir) => String::from(log_dir),
 None => config.storage_dir_path.clone() + "/logs",
	};

	Ok(Arc::new(
 FilesystemLogger::new(log_dir, config.log_level)
 .map_err(|_| BuildError::LoggerSetupFailed)?,
	))
fn setup_logger(config: &Config) -> Result<Arc<LdkNodeLogger>, BuildError> {
	match config.logging_config {
 LoggingConfig::Custom(ref logger) => Ok(logger.clone()),
 LoggingConfig::Filesystem { ref log_dir, log_level } => {
 let filesystem_log_writer = FilesystemLogWriter::new(log_dir.clone())
 .map_err(|_| BuildError::LoggerSetupFailed)?;
 Ok(Arc::new(
 LdkNodeLogger::new(
 log_level,
 Box::new(default_format),
 Box::new(move |s| filesystem_log_writer.write(s)),
 )
 .map_err(|_| BuildError::LoggerSetupFailed)?,
 ))
 },
	}
}

fn seed_bytes_from_config(
	config: &Config, entropy_source_config: Option<&EntropySourceConfig>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<[u8; 64], BuildError> {
	match entropy_source_config {
 Some(EntropySourceConfig::SeedBytes(bytes)) => Ok(bytes.clone()),
Expand All@@ -1267,7 +1265,7 @@ fn seed_bytes_from_config(
}

fn derive_vss_xprv(
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<FilesystemLogger>,
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<LdkNodeLogger>,
) -> Result<Xpriv, BuildError> {
	use bitcoin::key::Secp256k1;

Expand Down

14 changes: 7 additions & 7 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use crate::fee_estimator::{
	ConfirmationTarget, OnchainFeeEstimator,
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, FilesystemLogger, Logger};
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkNodeLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -112,13 +112,13 @@ pub(crate) enum ChainSource {
 esplora_client: EsploraAsyncClient,
 onchain_wallet: Arc<Wallet>,
 onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
 tx_sync: Arc<EsploraSyncClient<Arc<FilesystemLogger>>>,
 tx_sync: Arc<EsploraSyncClient<Arc<LdkNodeLogger>>>,
 lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
 fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
	BitcoindRpc {
Expand All@@ -131,7 +131,7 @@ pub(crate) enum ChainSource {
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
}
Expand All@@ -140,7 +140,7 @@ impl ChainSource {
	pub(crate) fn new_esplora(
 server_url: String, sync_config: EsploraSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<FilesystemLogger>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let mut client_builder = esplora_client::Builder::new(&server_url);
Expand DownExpand Up@@ -170,7 +170,7 @@ impl ChainSource {
 host: String, port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
 logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let bitcoind_rpc_client =
 Arc::new(BitcoindRpcClient::new(host, port, rpc_user, rpc_password));
Expand DownExpand Up@@ -1118,7 +1118,7 @@ impl Filter for ChainSource {

fn periodically_archive_fully_resolved_monitors(
	channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Result<(), Error> {
	let mut locked_node_metrics = node_metrics.write().unwrap();
	let cur_height = channel_manager.current_best_block().height;
Expand Down

41 changes: 33 additions & 8 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@

//! Objects for configuring the node.

use crate::logger::LdkNodeLogger;
use crate::payment::SendingParameters;

use lightning::ln::msgs::SocketAddress;
Expand DownExpand Up@@ -105,8 +106,9 @@ pub struct Config {
	pub storage_dir_path: String,
	/// The path where logs are stored.
	///
	/// If set to `None`, logs can be found in the `logs` subdirectory in [`Config::storage_dir_path`].
	pub log_dir_path: Option<String>,
	/// In the default configuration logs can be found in the `logs` subdirectory in
	/// [`Config::storage_dir_path`], and the log level is set to [`DEFAULT_LOG_LEVEL`].
	pub logging_config: LoggingConfig,
	/// The used Bitcoin network.
	pub network: Network,
	/// The addresses on which the node will listen for incoming connections.
Expand All@@ -132,10 +134,6 @@ pub struct Config {
	/// Channels with available liquidity less than the required amount times this value won't be
	/// used to send pre-flight probes.
	pub probing_liquidity_limit_multiplier: u64,
	/// The level at which we log messages.
	///
	/// Any messages below this level will be excluded from the logs.
	pub log_level: LogLevel,
	/// Configuration options pertaining to Anchor channels, i.e., channels for which the
	/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
	///
Expand DownExpand Up@@ -167,19 +165,46 @@ impl Default for Config {
	fn default() -> Self {
 Self {
 storage_dir_path: DEFAULT_STORAGE_DIR_PATH.to_string(),
log_dir_path: None,
logging_config: LoggingConfig::default(),
 network: DEFAULT_NETWORK,
 listening_addresses: None,
 trusted_peers_0conf: Vec::new(),
 probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
 log_level: DEFAULT_LOG_LEVEL,
 anchor_channels_config: Some(AnchorChannelsConfig::default()),
 sending_parameters: None,
 node_alias: None,
 }
	}
}

/// Configuration options for logging.
#[derive(Debug, Clone)]
pub enum LoggingConfig {
	/// An opinionated filesystem logger.
	///
	/// This logger will always write at `{log_dir}/ldk_node_latest.log`, which is a symlink to the
	/// most recent log file, which is created and timestamped at initialization.
	Filesystem {
 /// The absolute path where logs are stored.
 log_dir: String,
 /// The level at which we log messages.
 ///
 /// Any messages below this level will be excluded from the logs.
 log_level: LogLevel,
	},
	/// A custom logger.
	Custom(std::sync::Arc<LdkNodeLogger>),
}

impl Default for LoggingConfig {
	fn default() -> Self {
 Self::Filesystem {
 log_dir: format!("{}/{}", DEFAULT_STORAGE_DIR_PATH, "logs"),
 log_level: DEFAULT_LOG_LEVEL,
 }
	}
}

/// Configuration options pertaining to 'Anchor' channels, i.e., channels for which the
/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
///
Expand Down

8 changes: 4 additions & 4 deletions
src/gossip.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
// accordance with one or both of these licenses.

use crate::config::RGS_SYNC_TIMEOUT_SECS;
use crate::logger::{log_trace, FilesystemLogger, Logger};
use crate::logger::{log_trace, LdkNodeLogger, Logger};
use crate::types::{GossipSync, Graph, P2PGossipSync, RapidGossipSync};
use crate::Error;

Expand All@@ -24,12 +24,12 @@ pub(crate) enum GossipSource {
 gossip_sync: Arc<RapidGossipSync>,
 server_url: String,
 latest_sync_timestamp: AtomicU32,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	},
}

impl GossipSource {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<FilesystemLogger>) -> Self {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<LdkNodeLogger>) -> Self {
 let gossip_sync = Arc::new(P2PGossipSync::new(
 network_graph,
 None::<Arc<dyn UtxoLookup + Send + Sync>>,
Expand All@@ -40,7 +40,7 @@ impl GossipSource {

	pub fn new_rgs(
 server_url: String, latest_sync_timestamp: u32, network_graph: Arc<Graph>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	) -> Self {
 let gossip_sync = Arc::new(RapidGossipSync::new(network_graph, Arc::clone(&logger)));
 let latest_sync_timestamp = AtomicU32::new(latest_sync_timestamp);
Expand Down

6 changes: 3 additions & 3 deletions
src/io/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::{
	NODE_METRICS_KEY, NODE_METRICS_PRIMARY_NAMESPACE, NODE_METRICS_SECONDARY_NAMESPACE,
};
use crate::logger::{log_error, FilesystemLogger};
use crate::logger::{log_error, LdkNodeLogger};
use crate::peer_store::PeerStore;
use crate::sweep::DeprecatedSpendableOutputInfo;
use crate::types::{Broadcaster, DynStore, KeysManager, Sweeper};
Expand DownExpand Up@@ -226,7 +226,7 @@ where
pub(crate) fn read_output_sweeper(
	broadcaster: Arc<Broadcaster>, fee_estimator: Arc<OnchainFeeEstimator>,
	chain_data_source: Arc<ChainSource>, keys_manager: Arc<KeysManager>, kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<Sweeper, std::io::Error> {
	let mut reader = Cursor::new(kv_store.read(
 OUTPUT_SWEEPER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -600,7 +600,7 @@ impl_read_write_change_set_type!(

// Reads the full BdkWalletChangeSet or returns default fields
pub(crate) fn read_bdk_wallet_change_set(
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>,
) -> Result<Option<BdkWalletChangeSet>, std::io::Error> {
	let mut change_set = BdkWalletChangeSet::default();

Expand Down

14 changes: 7 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,7 @@ use types::{
};
pub use types::{ChannelDetails, PeerDetails, UserChannelId};

use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
use logger::{log_error, log_info, log_trace, LdkNodeLogger, Logger};

use lightning::chain::BestBlock;
use lightning::events::bump_transaction::Wallet as LdkWallet;
Expand DownExpand Up@@ -180,23 +180,23 @@ pub struct Node {
	wallet: Arc<Wallet>,
	chain_source: Arc<ChainSource>,
	tx_broadcaster: Arc<Broadcaster>,
	event_queue: Arc<EventQueue<Arc<FilesystemLogger>>>,
	event_queue: Arc<EventQueue<Arc<LdkNodeLogger>>>,
	channel_manager: Arc<ChannelManager>,
	chain_monitor: Arc<ChainMonitor>,
	output_sweeper: Arc<Sweeper>,
	peer_manager: Arc<PeerManager>,
	onion_messenger: Arc<OnionMessenger>,
	connection_manager: Arc<ConnectionManager<Arc<FilesystemLogger>>>,
	connection_manager: Arc<ConnectionManager<Arc<LdkNodeLogger>>>,
	keys_manager: Arc<KeysManager>,
	network_graph: Arc<Graph>,
	gossip_source: Arc<GossipSource>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<FilesystemLogger>>>>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<LdkNodeLogger>>>>,
	kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
	_router: Arc<Router>,
	scorer: Arc<Mutex<Scorer>>,
	peer_store: Arc<PeerStore<Arc<FilesystemLogger>>>,
	payment_store: Arc<PaymentStore<Arc<FilesystemLogger>>>,
	peer_store: Arc<PeerStore<Arc<LdkNodeLogger>>>,
	payment_store: Arc<PaymentStore<Arc<LdkNodeLogger>>>,
	is_listening: Arc<AtomicBool>,
	node_metrics: Arc<RwLock<NodeMetrics>>,
}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add configurable logger by domZippilli · Pull Request #393 · lightningdevkit/ldk-node · GitHub
Skip to content
Add configurable logger#393

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.

 Sign up for GitHub

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

 Closed

domZippilli
wants to merge
3
commits into

from

 Closed


Add configurable logger
#393
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4f82769

Rename FilesystemLogger to LdkNodeLogger.


domZippilli Oct 25, 2024
2c54a18

Make LdkNodeLogger technically customizable, retain default behavior.


domZippilli Oct 28, 2024
b0e7fef

Add customizable logging to configuration.


domZippilli Oct 28, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


54 changes: 26 additions & 28 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,9 @@
// accordance with one or both of these licenses.

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{default_user_config, Config, EsploraSyncConfig, WALLET_KEYS_SEED_LEN};
use crate::config::{
	default_user_config, Config, EsploraSyncConfig, LoggingConfig, WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
use crate::event::EventQueue;
Expand All@@ -16,7 +18,9 @@ use crate::io::sqlite_store::SqliteStore;
use crate::io::utils::{read_node_metrics, write_node_metrics};
use crate::io::vss_store::VssStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
use crate::logger::{
	default_format, log_error, log_info, FilesystemLogWriter, LdkNodeLogger, Logger,
};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment::store::PaymentStore;
use crate::peer_store::PeerStore;
Expand All@@ -27,8 +31,8 @@ use crate::types::{
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
use crate::Node;
use crate::{io, NodeMetrics};
use crate::{LogLevel, Node};

use lightning::chain::{chainmonitor, BestBlock, Watch};
use lightning::io::Cursor;
Expand DownExpand Up@@ -298,12 +302,6 @@ impl NodeBuilder {
 self
	}

	/// Sets the log dir path if logs need to live separate from the storage directory path.
	pub fn set_log_dir_path(&mut self, log_dir_path: String) -> &mut Self {
 self.config.log_dir_path = Some(log_dir_path);
 self
	}

	/// Sets the Bitcoin network used.
	pub fn set_network(&mut self, network: Network) -> &mut Self {
 self.config.network = network;
Expand DownExpand Up@@ -333,12 +331,6 @@ impl NodeBuilder {
 Ok(self)
	}

	/// Sets the level at which [`Node`] will log messages.
	pub fn set_log_level(&mut self, level: LogLevel) -> &mut Self {
 self.config.log_level = level;
 self
	}

	/// Builds a [`Node`] instance with a [`SqliteStore`] backend and according to the options
	/// previously configured.
	pub fn build(&self) -> Result<Node, BuildError> {
Expand DownExpand Up@@ -734,7 +726,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<DynStore>,
	logger: Arc<LdkNodeLogger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	// Initialize the status fields.
	let is_listening = Arc::new(AtomicBool::new(false));
Expand DownExpand Up@@ -1231,21 +1223,27 @@ fn build_with_store_internal(
	})
}

fn setup_logger(config: &Config) -> Result<Arc<FilesystemLogger>, BuildError> {
	let log_dir = match &config.log_dir_path {
 Some(log_dir) => String::from(log_dir),
 None => config.storage_dir_path.clone() + "/logs",
	};

	Ok(Arc::new(
 FilesystemLogger::new(log_dir, config.log_level)
 .map_err(|_| BuildError::LoggerSetupFailed)?,
	))
fn setup_logger(config: &Config) -> Result<Arc<LdkNodeLogger>, BuildError> {
	match config.logging_config {
 LoggingConfig::Custom(ref logger) => Ok(logger.clone()),
 LoggingConfig::Filesystem { ref log_dir, log_level } => {
 let filesystem_log_writer = FilesystemLogWriter::new(log_dir.clone())
 .map_err(|_| BuildError::LoggerSetupFailed)?;
 Ok(Arc::new(
 LdkNodeLogger::new(
 log_level,
 Box::new(default_format),
 Box::new(move |s| filesystem_log_writer.write(s)),
 )
 .map_err(|_| BuildError::LoggerSetupFailed)?,
 ))
 },
	}
}

fn seed_bytes_from_config(
	config: &Config, entropy_source_config: Option<&EntropySourceConfig>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<[u8; 64], BuildError> {
	match entropy_source_config {
 Some(EntropySourceConfig::SeedBytes(bytes)) => Ok(bytes.clone()),
Expand All@@ -1267,7 +1265,7 @@ fn seed_bytes_from_config(
}

fn derive_vss_xprv(
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<FilesystemLogger>,
	config: Arc<Config>, seed_bytes: &[u8; 64], logger: Arc<LdkNodeLogger>,
) -> Result<Xpriv, BuildError> {
	use bitcoin::key::Secp256k1;

Expand Down

14 changes: 7 additions & 7 deletions
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ use crate::fee_estimator::{
	ConfirmationTarget, OnchainFeeEstimator,
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, FilesystemLogger, Logger};
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkNodeLogger, Logger};
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -112,13 +112,13 @@ pub(crate) enum ChainSource {
 esplora_client: EsploraAsyncClient,
 onchain_wallet: Arc<Wallet>,
 onchain_wallet_sync_status: Mutex<WalletSyncStatus>,
 tx_sync: Arc<EsploraSyncClient<Arc<FilesystemLogger>>>,
 tx_sync: Arc<EsploraSyncClient<Arc<LdkNodeLogger>>>,
 lightning_wallet_sync_status: Mutex<WalletSyncStatus>,
 fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
	BitcoindRpc {
Expand All@@ -131,7 +131,7 @@ pub(crate) enum ChainSource {
 tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>,
 config: Arc<Config>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	},
}
Expand All@@ -140,7 +140,7 @@ impl ChainSource {
	pub(crate) fn new_esplora(
 server_url: String, sync_config: EsploraSyncConfig, onchain_wallet: Arc<Wallet>,
 fee_estimator: Arc<OnchainFeeEstimator>, tx_broadcaster: Arc<Broadcaster>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<FilesystemLogger>,
 kv_store: Arc<DynStore>, config: Arc<Config>, logger: Arc<LdkNodeLogger>,
 node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let mut client_builder = esplora_client::Builder::new(&server_url);
Expand DownExpand Up@@ -170,7 +170,7 @@ impl ChainSource {
 host: String, port: u16, rpc_user: String, rpc_password: String,
 onchain_wallet: Arc<Wallet>, fee_estimator: Arc<OnchainFeeEstimator>,
 tx_broadcaster: Arc<Broadcaster>, kv_store: Arc<DynStore>, config: Arc<Config>,
 logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
 logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	) -> Self {
 let bitcoind_rpc_client =
 Arc::new(BitcoindRpcClient::new(host, port, rpc_user, rpc_password));
Expand DownExpand Up@@ -1118,7 +1118,7 @@ impl Filter for ChainSource {

fn periodically_archive_fully_resolved_monitors(
	channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>, node_metrics: Arc<RwLock<NodeMetrics>>,
) -> Result<(), Error> {
	let mut locked_node_metrics = node_metrics.write().unwrap();
	let cur_height = channel_manager.current_best_block().height;
Expand Down

41 changes: 33 additions & 8 deletions
src/config.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@

//! Objects for configuring the node.

use crate::logger::LdkNodeLogger;
use crate::payment::SendingParameters;

use lightning::ln::msgs::SocketAddress;
Expand DownExpand Up@@ -105,8 +106,9 @@ pub struct Config {
	pub storage_dir_path: String,
	/// The path where logs are stored.
	///
	/// If set to `None`, logs can be found in the `logs` subdirectory in [`Config::storage_dir_path`].
	pub log_dir_path: Option<String>,
	/// In the default configuration logs can be found in the `logs` subdirectory in
	/// [`Config::storage_dir_path`], and the log level is set to [`DEFAULT_LOG_LEVEL`].
	pub logging_config: LoggingConfig,
	/// The used Bitcoin network.
	pub network: Network,
	/// The addresses on which the node will listen for incoming connections.
Expand All@@ -132,10 +134,6 @@ pub struct Config {
	/// Channels with available liquidity less than the required amount times this value won't be
	/// used to send pre-flight probes.
	pub probing_liquidity_limit_multiplier: u64,
	/// The level at which we log messages.
	///
	/// Any messages below this level will be excluded from the logs.
	pub log_level: LogLevel,
	/// Configuration options pertaining to Anchor channels, i.e., channels for which the
	/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
	///
Expand DownExpand Up@@ -167,19 +165,46 @@ impl Default for Config {
	fn default() -> Self {
 Self {
 storage_dir_path: DEFAULT_STORAGE_DIR_PATH.to_string(),
log_dir_path: None,
logging_config: LoggingConfig::default(),
 network: DEFAULT_NETWORK,
 listening_addresses: None,
 trusted_peers_0conf: Vec::new(),
 probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
 log_level: DEFAULT_LOG_LEVEL,
 anchor_channels_config: Some(AnchorChannelsConfig::default()),
 sending_parameters: None,
 node_alias: None,
 }
	}
}

/// Configuration options for logging.
#[derive(Debug, Clone)]
pub enum LoggingConfig {
	/// An opinionated filesystem logger.
	///
	/// This logger will always write at `{log_dir}/ldk_node_latest.log`, which is a symlink to the
	/// most recent log file, which is created and timestamped at initialization.
	Filesystem {
 /// The absolute path where logs are stored.
 log_dir: String,
 /// The level at which we log messages.
 ///
 /// Any messages below this level will be excluded from the logs.
 log_level: LogLevel,
	},
	/// A custom logger.
	Custom(std::sync::Arc<LdkNodeLogger>),
}

impl Default for LoggingConfig {
	fn default() -> Self {
 Self::Filesystem {
 log_dir: format!("{}/{}", DEFAULT_STORAGE_DIR_PATH, "logs"),
 log_level: DEFAULT_LOG_LEVEL,
 }
	}
}

/// Configuration options pertaining to 'Anchor' channels, i.e., channels for which the
/// `option_anchors_zero_fee_htlc_tx` channel type is negotiated.
///
Expand Down

8 changes: 4 additions & 4 deletions
src/gossip.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
// accordance with one or both of these licenses.

use crate::config::RGS_SYNC_TIMEOUT_SECS;
use crate::logger::{log_trace, FilesystemLogger, Logger};
use crate::logger::{log_trace, LdkNodeLogger, Logger};
use crate::types::{GossipSync, Graph, P2PGossipSync, RapidGossipSync};
use crate::Error;

Expand All@@ -24,12 +24,12 @@ pub(crate) enum GossipSource {
 gossip_sync: Arc<RapidGossipSync>,
 server_url: String,
 latest_sync_timestamp: AtomicU32,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	},
}

impl GossipSource {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<FilesystemLogger>) -> Self {
	pub fn new_p2p(network_graph: Arc<Graph>, logger: Arc<LdkNodeLogger>) -> Self {
 let gossip_sync = Arc::new(P2PGossipSync::new(
 network_graph,
 None::<Arc<dyn UtxoLookup + Send + Sync>>,
Expand All@@ -40,7 +40,7 @@ impl GossipSource {

	pub fn new_rgs(
 server_url: String, latest_sync_timestamp: u32, network_graph: Arc<Graph>,
 logger: Arc<FilesystemLogger>,
 logger: Arc<LdkNodeLogger>,
	) -> Self {
 let gossip_sync = Arc::new(RapidGossipSync::new(network_graph, Arc::clone(&logger)));
 let latest_sync_timestamp = AtomicU32::new(latest_sync_timestamp);
Expand Down

6 changes: 3 additions & 3 deletions
src/io/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::{
	NODE_METRICS_KEY, NODE_METRICS_PRIMARY_NAMESPACE, NODE_METRICS_SECONDARY_NAMESPACE,
};
use crate::logger::{log_error, FilesystemLogger};
use crate::logger::{log_error, LdkNodeLogger};
use crate::peer_store::PeerStore;
use crate::sweep::DeprecatedSpendableOutputInfo;
use crate::types::{Broadcaster, DynStore, KeysManager, Sweeper};
Expand DownExpand Up@@ -226,7 +226,7 @@ where
pub(crate) fn read_output_sweeper(
	broadcaster: Arc<Broadcaster>, fee_estimator: Arc<OnchainFeeEstimator>,
	chain_data_source: Arc<ChainSource>, keys_manager: Arc<KeysManager>, kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
) -> Result<Sweeper, std::io::Error> {
	let mut reader = Cursor::new(kv_store.read(
 OUTPUT_SWEEPER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -600,7 +600,7 @@ impl_read_write_change_set_type!(

// Reads the full BdkWalletChangeSet or returns default fields
pub(crate) fn read_bdk_wallet_change_set(
	kv_store: Arc<DynStore>, logger: Arc<FilesystemLogger>,
	kv_store: Arc<DynStore>, logger: Arc<LdkNodeLogger>,
) -> Result<Option<BdkWalletChangeSet>, std::io::Error> {
	let mut change_set = BdkWalletChangeSet::default();

Expand Down

14 changes: 7 additions & 7 deletions
src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -142,7 +142,7 @@ use types::{
};
pub use types::{ChannelDetails, PeerDetails, UserChannelId};

use logger::{log_error, log_info, log_trace, FilesystemLogger, Logger};
use logger::{log_error, log_info, log_trace, LdkNodeLogger, Logger};

use lightning::chain::BestBlock;
use lightning::events::bump_transaction::Wallet as LdkWallet;
Expand DownExpand Up@@ -180,23 +180,23 @@ pub struct Node {
	wallet: Arc<Wallet>,
	chain_source: Arc<ChainSource>,
	tx_broadcaster: Arc<Broadcaster>,
	event_queue: Arc<EventQueue<Arc<FilesystemLogger>>>,
	event_queue: Arc<EventQueue<Arc<LdkNodeLogger>>>,
	channel_manager: Arc<ChannelManager>,
	chain_monitor: Arc<ChainMonitor>,
	output_sweeper: Arc<Sweeper>,
	peer_manager: Arc<PeerManager>,
	onion_messenger: Arc<OnionMessenger>,
	connection_manager: Arc<ConnectionManager<Arc<FilesystemLogger>>>,
	connection_manager: Arc<ConnectionManager<Arc<LdkNodeLogger>>>,
	keys_manager: Arc<KeysManager>,
	network_graph: Arc<Graph>,
	gossip_source: Arc<GossipSource>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<FilesystemLogger>>>>,
	liquidity_source: Option<Arc<LiquiditySource<Arc<LdkNodeLogger>>>>,
	kv_store: Arc<DynStore>,
	logger: Arc<FilesystemLogger>,
	logger: Arc<LdkNodeLogger>,
	_router: Arc<Router>,
	scorer: Arc<Mutex<Scorer>>,
	peer_store: Arc<PeerStore<Arc<FilesystemLogger>>>,
	payment_store: Arc<PaymentStore<Arc<FilesystemLogger>>>,
	peer_store: Arc<PeerStore<Arc<LdkNodeLogger>>>,
	payment_store: Arc<PaymentStore<Arc<LdkNodeLogger>>>,
	is_listening: Arc<AtomicBool>,
	node_metrics: Arc<RwLock<NodeMetrics>>,
}
Expand Down
Loading