add log4rs support (paritytech#124)

Author: atenjin

.gitignore

@@ -20,4 +20,5 @@ chainx/
 !rpc/src/chainx
 bak/
 .chainx/
-.sub/
+.sub/
+log/

Cargo.lock

@@ -10,6 +10,7 @@ jsonrpc-core = "14.2.0"
 log = "0.4.8"
 parking_lot = "0.10.0"
 structopt = "0.3.8"
+log4rs = { version = "0.12", features = ["rolling_file_appender", "compound_policy", "size_trigger", "fixed_window_roller"] }
 
 # Substrate client
 sc-basic-authorship = { git = "https://github.com/paritytech/substrate.git", tag = "v2.0.0-rc3" }

cli/Cargo.toml

@@ -8,4 +8,28 @@ pub struct Cli {
 
     #[structopt(flatten)]
     pub run: RunCmd,
+
+    #[structopt(long = "log4rs")]
+    /// Use `env_logger`, not `log4rs`. notice `env_logger` can't print into file directly
+    pub log4rs: bool,
+
+    #[structopt(long = "log-dir", default_value = "./log")]
+    /// When use `log4rs`, assign the path of log dir, notice this would create the dir directly. Default dir is `./log`
+    pub log_dir: String,
+    #[structopt(long = "log-name", default_value = "chainx.log")]
+    /// When use `log4rs`, assign the log file name. Default dir is `chainx.log`, thus when use default config, the log would create in ./log/chainx.log
+    pub log_name: String,
+    #[structopt(long = "log-size", default_value = "300")]
+    /// When use `log4rs`, the default log size in log rotation. The unit is MB, default is 300 MB
+    pub log_size: u64,
+    #[structopt(long = "log-roll-count", default_value = "10")]
+    /// When use `log4rs`, the max log rotation. Default is 10. If the log is more then the number, would delete old file.
+    /// The log would like `chainx.log.0`, `chainx.log.1` ... `chainx.log.10`
+    pub log_roll_count: u32,
+    #[structopt(long = "log-console")]
+    /// When use `log4rs`, print log into console. Default is false
+    pub log_console: bool,
+    #[structopt(long = "log-compression")]
+    /// When use `log4rs`, compress the old log to save space. the log would like `chainx.log.gz.0`
+    pub log_compression: bool,
 }

cli/src/cli.rs

@@ -18,7 +18,7 @@
 use crate::chain_spec;
 use crate::cli::Cli;
 use crate::service;
-use sc_cli::SubstrateCli;
+use sc_cli::{CliConfiguration, SubstrateCli};
 
 impl SubstrateCli for Cli {
     fn impl_name() -> &'static str {
@@ -63,17 +63,24 @@ fn load_spec(id: &str) -> Result<Box<dyn sc_service::ChainSpec>, String> {
             let p = std::path::PathBuf::from(path);
             if !p.exists() {
                 // TODO more better hint
-                return Err(format!("not a valid path or just allow [\"dev\", \"local\"]"))
+                return Err(format!(
+                    "not a valid path or just allow [\"dev\", \"local\"]"
+                ));
             }
             Box::new(chain_spec::ChainSpec::from_json_file(p)?)
-        },
+        }
     })
 }
 
 /// Parse and run command line arguments
 pub fn run() -> sc_cli::Result<()> {
     let cli = Cli::from_args();
 
+    if cli.log4rs {
+        let s = cli.run.log_filters()?;
+        crate::logger::init_logger_log4rs(&s, &cli)?;
+    }
+
     match &cli.subcommand {
         Some(subcommand) => {
             let runner = cli.create_runner(subcommand)?;

cli/src/command.rs

@@ -8,6 +8,7 @@ mod chain_spec;
 mod service;
 mod cli;
 mod command;
+mod logger;
 
 pub use command::*;
 pub use sc_cli::Result;