feat: switch to tracing ecosystem (#379)

* feat: switch to tracing ecosystem

Signed-off-by: Alex Chi <iskyzh@gmail.com>

* feat(tracing): switch to tokio-tracing ecosystem

Signed-off-by: Alex Chi <iskyzh@gmail.com>

* remove unused deps

Signed-off-by: Alex Chi <iskyzh@gmail.com>

Author: skyzh

Cargo.lock

@@ -27,14 +27,12 @@ csv = "1"
 dirs = "4"
 downcast-rs = "1"
 enum_dispatch = "0.3"
-env_logger = "0.9"
 erased-serde = "0.3"
 futures = { version = "0.3", default-features = false, features = ["alloc"] }
 futures-async-stream = { git = "https://github.com/taiki-e/futures-async-stream", rev = "944f407" }
 indicatif = { version = "0.16" }
 iter-chunks = "0.1"
 itertools = "0.10"
-log = "0.4"
 moka = { version = "0.6", features = ["future"] }
 num-traits = "0.2"
 parking_lot = "0.11"
@@ -51,9 +49,12 @@ sqlparser = { git = "https://github.com/risinglightdb/sqlparser-rs", rev = "edea
 thiserror = "1"
 tikv-jemallocator = { version = "0.4", optional = true }
 tokio = { version = "1", features = ["full"] }
+tracing = "0.1"
+tracing-subscriber = { version = "0.3", features = ["env-filter", "parking_lot"] }
 
 [dev-dependencies]
 criterion = { version = "0.3", features = ["async_tokio"] }
+env_logger = "0.9"
 tempfile = "3"
 test-case = "1"
 

Cargo.toml

@@ -57,10 +57,10 @@ It is recommended to use VSCode with [rust-analyzer][rust-analyzer] extension to
 `rust-analyzer` extension in VSCode, and everything will be set for you. Note that `rust-analyzer` conflicts with
 the official Rust extension. You will need to uninstall "The Rust Programming Language" extension before proceeding.
 
-To enable logs for RisingLight, export the following environment variable to your shell environment.
+To enable debug logs for RisingLight, export the following environment variable to your shell environment.
 
 ```
-export RUST_LOG=info
+export RUST_LOG=debug
 ```
 
 If you want to contribute to the RisingLight project, refer to [Contributing to RisingLight](../CONTRIBUTING.md) docs

docs/00-develop.md

@@ -4,6 +4,7 @@ use std::sync::Arc;
 
 use futures::TryStreamExt;
 use risinglight_proto::rowset::block_statistics::BlockStatisticsType;
+use tracing::debug;
 
 use crate::array::{ArrayBuilder, ArrayBuilderImpl, DataChunk, I32ArrayBuilder, Utf8ArrayBuilder};
 use crate::binder::{BindError, Binder};

src/db.rs

@@ -12,10 +12,6 @@
 #![feature(generators)]
 #![feature(backtrace)]
 
-// Enable macros for logging.
-#[macro_use]
-extern crate log;
-
 /// Top-level structure of the database.
 pub mod db;
 

src/lib.rs

@@ -7,12 +7,13 @@ use std::sync::Mutex;
 
 use anyhow::{anyhow, Result};
 use clap::Parser;
-use log::{info, warn};
 use risinglight::array::{datachunk_to_sqllogictest_string, DataChunk};
 use risinglight::storage::SecondaryStorageOptions;
 use risinglight::Database;
 use rustyline::error::ReadlineError;
 use rustyline::Editor;
+use tracing::{info, warn, Level};
+use tracing_subscriber::prelude::*;
 
 /// RisingLight: an OLAP database system.
 #[derive(Parser, Debug)]
@@ -149,7 +150,14 @@ async fn run_sqllogictest(db: Database, path: &str) -> Result<()> {
 async fn main() -> Result<()> {
     let args = Args::parse();
 
-    env_logger::init();
+    let fmt_layer = tracing_subscriber::fmt::layer().compact();
+    let filter_layer =
+        tracing_subscriber::EnvFilter::from_default_env().add_directive(Level::INFO.into());
+
+    tracing_subscriber::registry()
+        .with(filter_layer)
+        .with(fmt_layer)
+        .init();
 
     let db = if args.memory {
         info!("using memory engine");

src/main.rs

@@ -5,6 +5,7 @@ use std::sync::Arc;
 
 use async_trait::async_trait;
 use itertools::Itertools;
+use tracing::warn;
 
 use super::table::InMemoryTableInnerRef;
 use super::{InMemoryRowHandler, InMemoryTable, InMemoryTxnIterator};

src/storage/memory/transaction.rs

@@ -5,6 +5,7 @@ use std::time::Duration;
 
 use itertools::Itertools;
 use tokio::sync::oneshot::Receiver;
+use tracing::{info, warn};
 
 use super::{SecondaryStorage, SecondaryTable, Snapshot};
 use crate::catalog::find_sort_key_id;

src/storage/secondary/compactor.rs

@@ -14,6 +14,7 @@ use serde::{Deserialize, Serialize};
 use serde_json::Deserializer;
 use tokio::fs::OpenOptions;
 use tokio::io::{AsyncReadExt, AsyncSeekExt, AsyncWriteExt, BufReader};
+use tracing::warn;
 
 use super::version_manager::EpochOp;
 use super::{SecondaryStorage, SecondaryTable, StorageResult, TracedStorageError};

src/storage/secondary/manifest.rs

@@ -59,6 +59,7 @@ use parking_lot::RwLock;
 use tokio::sync::oneshot::Sender;
 use tokio::sync::Mutex;
 use tokio::task::JoinHandle;
+use tracing::info;
 
 use super::{Storage, StorageResult, TracedStorageError};
 use crate::catalog::{ColumnCatalog, RootCatalogRef, TableRefId};