Update example.

Author: zensh

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "structured-logger"
-version = "1.0.1"
+version = "1.0.2"
 edition = "2018"
 description = """
 A logging implementation for the log crate that logs structured values either synchronous or asynchronous, as JSON, CBOR, or any other format, into a file, stderr, stdout, or any other destination.

README.md

@@ -17,30 +17,15 @@ See examples and the [API documentation] for more.
 
 ## Example
 
-* Log panics example: https://github.com/iorust/structured-logger/blob/main/examples/panic_log.rs
-* Async log example: https://github.com/iorust/structured-logger/blob/main/examples/async_log.rs
-
-Muilti writers example:
+Simple example:
 ```rust
 use serde::Serialize;
-use std::{fs::File, io::stdout};
 use structured_logger::{json::new_writer, unix_ms, Builder};
 
 fn main() {
     // Initialize the logger.
-    // Optional: create a file to write logs to.
-    let log_file = File::options()
-        .create(true)
-        .append(true)
-        .open("app.log")
-        .unwrap();
-
-    // or Builder::with_level("debug")
-    Builder::new()
-        // Optional: set a specific writer (format to JSON, write to stdout) for target starts with "api"..
-        .with_target_writer("api*", new_writer(stdout()))
-        // Optional: set a specific writer (format to JSON, write to app.log file) for target "file" and "db".
-        .with_target_writer("file,db", new_writer(log_file))
+    Builder::with_level("info")
+        .with_target_writer("*", new_writer(std::io::stdout()))
         .init();
 
     let kv = ContextLog {
@@ -49,7 +34,7 @@ fn main() {
     };
 
     log::info!("hello world");
-    // This log will be written to stderr (default writer):
+    // This log will be written to stdout:
     // {"level":"INFO","message":"hello world","target":"simple","timestamp":1679745592127}
 
     log::info!(target: "api",
@@ -63,18 +48,6 @@ fn main() {
     );
     // This log will be written to stdout:
     // {"elapsed":10,"kv":{"uid":"user123","action":"upate_book"},"level":"INFO","message":"","method":"GET","path":"/hello","start":1679745592127,"status":200,"target":"api","timestamp":1679745592127}
-
-    log::info!(target: "file",
-        method = "GET",
-        path = "/hello",
-        status = 200_u16,
-        start = unix_ms(),
-        elapsed = 10_u64,
-        kv = log::as_serde!(kv);
-        "",
-    );
-    // This log will be written to file "app.log":
-    // {"elapsed":10,"kv":{"uid":"user123","action":"upate_book"},"level":"INFO","message":"","method":"GET","path":"/hello","start":1679745592127,"status":200,"target":"file","timestamp":1679745592127}
 }
 
 #[derive(Serialize)]
@@ -84,6 +57,10 @@ struct ContextLog {
 }
 ```
 
+* Log panics example: https://github.com/iorust/structured-logger/blob/main/examples/panic_log.rs
+* Async log example: https://github.com/iorust/structured-logger/blob/main/examples/async_log.rs
+* Custom writers example: https://github.com/iorust/structured-logger/blob/main/examples/custom.rs
+
 [API documentation]: https://docs.rs/structured-logger
 
 ## License

examples/custom.rs

@@ -0,0 +1,60 @@
+use serde::Serialize;
+use std::{fs::File, io::stdout};
+use structured_logger::{json::new_writer, unix_ms, Builder};
+
+fn main() {
+    // Initialize the logger.
+    // Optional: create a file to write logs to.
+    let log_file = File::options()
+        .create(true)
+        .append(true)
+        .open("app.log")
+        .unwrap();
+
+    // or Builder::with_level("debug")
+    Builder::new()
+        // Optional: set a specific writer (format to JSON, write to stdout) for target starts with "api"..
+        .with_target_writer("api*", new_writer(stdout()))
+        // Optional: set a specific writer (format to JSON, write to app.log file) for target "file" and "db".
+        .with_target_writer("file,db", new_writer(log_file))
+        .init();
+
+    let kv = ContextLog {
+        uid: "user123".to_string(),
+        action: "upate_book".to_string(),
+    };
+
+    log::info!("hello world");
+    // This log will be written to stderr (default writer):
+    // {"level":"INFO","message":"hello world","target":"simple","timestamp":1679745592127}
+
+    log::info!(target: "api",
+        method = "GET",
+        path = "/hello",
+        status = 200_u16,
+        start = unix_ms(),
+        elapsed = 10_u64,
+        kv = log::as_serde!(kv);
+        "",
+    );
+    // This log will be written to stdout:
+    // {"elapsed":10,"kv":{"uid":"user123","action":"upate_book"},"level":"INFO","message":"","method":"GET","path":"/hello","start":1679745592127,"status":200,"target":"api","timestamp":1679745592127}
+
+    log::info!(target: "file",
+        method = "GET",
+        path = "/hello",
+        status = 200_u16,
+        start = unix_ms(),
+        elapsed = 10_u64,
+        kv = log::as_serde!(kv);
+        "",
+    );
+    // This log will be written to file "app.log":
+    // {"elapsed":10,"kv":{"uid":"user123","action":"upate_book"},"level":"INFO","message":"","method":"GET","path":"/hello","start":1679745592127,"status":200,"target":"file","timestamp":1679745592127}
+}
+
+#[derive(Serialize)]
+struct ContextLog {
+    uid: String,
+    action: String,
+}

examples/panic_log.rs

@@ -1,7 +1,7 @@
-fn main() {
-    use log::info;
-    use structured_logger::Builder;
+use log::info;
+use structured_logger::Builder;
 
+fn main() {
     // Initialize the logger.
     Builder::new().init();
 

examples/simple.rs

@@ -1,22 +1,10 @@
 use serde::Serialize;
-use std::{fs::File, io::stdout};
 use structured_logger::{json::new_writer, unix_ms, Builder};
 
 fn main() {
     // Initialize the logger.
-    // Optional: create a file to write logs to.
-    let log_file = File::options()
-        .create(true)
-        .append(true)
-        .open("app.log")
-        .unwrap();
-
-    // or Builder::with_level("debug")
-    Builder::new()
-        // Optional: set a specific writer (format to JSON, write to stdout) for target starts with "api"..
-        .with_target_writer("api*", new_writer(stdout()))
-        // Optional: set a specific writer (format to JSON, write to app.log file) for target "file" and "db".
-        .with_target_writer("file,db", new_writer(log_file))
+    Builder::with_level("info")
+        .with_target_writer("*", new_writer(std::io::stdout()))
         .init();
 
     let kv = ContextLog {
@@ -25,7 +13,7 @@ fn main() {
     };
 
     log::info!("hello world");
-    // This log will be written to stderr (default writer):
+    // This log will be written to stdout:
     // {"level":"INFO","message":"hello world","target":"simple","timestamp":1679745592127}
 
     log::info!(target: "api",
@@ -39,18 +27,6 @@ fn main() {
     );
     // This log will be written to stdout:
     // {"elapsed":10,"kv":{"uid":"user123","action":"upate_book"},"level":"INFO","message":"","method":"GET","path":"/hello","start":1679745592127,"status":200,"target":"api","timestamp":1679745592127}
-
-    log::info!(target: "file",
-        method = "GET",
-        path = "/hello",
-        status = 200_u16,
-        start = unix_ms(),
-        elapsed = 10_u64,
-        kv = log::as_serde!(kv);
-        "",
-    );
-    // This log will be written to file "app.log":
-    // {"elapsed":10,"kv":{"uid":"user123","action":"upate_book"},"level":"INFO","message":"","method":"GET","path":"/hello","start":1679745592127,"status":200,"target":"file","timestamp":1679745592127}
 }
 
 #[derive(Serialize)]