[0.28] Introduce new features kv and json, and config option panic_if…

…_error_channel_is_broken

.markdownlint.json

@@ -4,7 +4,8 @@
     },
     "MD013": {
         "line_length": 100,
-        "heading_line_length": 300
+        "heading_line_length": 300,
+        "code_block_line_length": 180
     },
     "MD033": {
         "allowed_elements": [

CHANGELOG.md

@@ -5,10 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this
 project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.27.5-unpublished] - 2024-xx-xx
+## [0.28.0] - 2024-03-16
 
 Detach from `lazy_static`, use `std::sync::OnceLock` instead.
 
+Bump minimal supported rust version to 1.70.
+
+If `flexi_logger` runs into issues itself, it will try to write error messages into the configured
+error output channel. By default, `flexi_logger` panics if writing to the error output channel fails.
+It is now possible to gracefully "swallow" the error messages and continue
+(see [panic_if_error_channel_is_broken](https://docs.rs/flexi_logger/latest/flexi_logger/struct.Logger.html#method.panic_if_error_channel_is_broken)).
+
+The new feature `kv` allows making use of the `kv` feature of `log` together with `flexi_logger`s
+format functions, and adds a dependency to `log/kv_serde`.
+
+The new feature `json` adds a format function `json_format` and dependencies to `serde_json`,
+`serde` and `serde_derive`.
+
 ## [0.27.4] - 2024-01-20
 
 Add ability to omit the basename cleanly, without leading underscore

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "flexi_logger"
-version = "0.27.5-unpublished"
+version = "0.28.0"
 authors = ["emabee <meinolf.block@sap.com>"]
 categories = ["development-tools::debugging"]
 description = """
@@ -33,6 +33,8 @@ async = ["dep:crossbeam-channel", "dep:crossbeam-queue"]
 colors = ["dep:nu-ansi-term", "is-terminal"]
 compress = ["dep:flate2"]
 dont_minimize_extra_stacks = []
+json = ["dep:serde_json", "dep:serde", "dep:serde_derive"]
+kv = ["log/kv_serde"]
 specfile = ["specfile_without_notification", "dep:notify-debouncer-mini"]
 specfile_without_notification = ["dep:serde", "dep:toml", "dep:serde_derive"]
 syslog_writer = ["dep:libc", "dep:hostname"]
@@ -53,6 +55,7 @@ notify-debouncer-mini = { version = "0.3", optional = true, default-features = f
 regex = { version = "1.1", optional = true }
 serde = { version = "1.0", optional = true }
 serde_derive = { version = "1.0", optional = true }
+serde_json = { version = "1.0", optional = true }
 thiserror = "1.0"
 toml = { version = "0.8", optional = true }
 tracing = { version = "0.1.36", optional = true }

README.md

@@ -17,7 +17,7 @@ and you use the ```log``` macros to write log lines from your code):
 
 ```toml
 [dependencies]
-flexi_logger = "0.27"
+flexi_logger = "0.28"
 log = "0.4"
 ```
 
@@ -68,15 +68,15 @@ Make use of the non-default features by specifying them in your `Cargo.toml`, e.
 
 ```toml
 [dependencies]
-flexi_logger = { version = "0.27", features = ["async", "specfile", "compress"] }
+flexi_logger = { version = "0.28", features = ["async", "specfile", "compress"] }
 log = "0.4"
 ```
 
 or, to get the smallest footprint (and no colors), switch off even the default features:
 
 ```toml
 [dependencies]
-flexi_logger = { version = "0.27", default_features = false }
+flexi_logger = { version = "0.28", default_features = false }
 log = "0.4"
 ```
 
@@ -127,6 +127,24 @@ For usecases where this is not desirable
 (see [here](https://github.com/emabee/flexi_logger/issues/95) for some motivation),
 you can activate this feature.
 
+### **`json`**
+
+Adds an additional format function `json_format` that prints the whole log line in json format,
+like this:
+
+```text
+{"level":"WARN","timestamp":"2024-03-14 10:04:57.299908 +01:00","thread":"XY","module_path":"test_json","file":"src/test_json.rs","line":32,"text":"More foo than bar."}
+```
+
+Also adds a dependency to crate `json`.
+
+### **`kv`**
+
+If you use the `kv` feature of the `log` crate to enrich the log-macro calls with key-value pairs,
+then you should also use the `kv` feature of `flexi_logger`
+so that these key-value pairs are also written by the
+provided [format functions](https://docs.rs/flexi_logger/latest/flexi_logger/#functions).
+
 ### **`specfile`**
 
 Adds a method `Logger::start_with_specfile(specfile)`.

scripts/qualify.rs

@@ -31,7 +31,7 @@ macro_rules! command {
 }
 
 fn run_script(s: &str) {
-    let mut path = std::path::PathBuf::from(std::env::var("CARGO_SCRIPT_BASE_PATH").unwrap());
+    let mut path = std::path::PathBuf::from("./scripts");
     path.push(s);
     let command = format!(
         "cargo script {}",