| 1 |
# Change Log |
| 2 |
|
| 3 |
## [Unreleased] |
| 4 |
|
| 5 |
## [0.4.21] - 2024-02-27 |
| 6 |
|
| 7 |
## What's Changed |
| 8 |
* Minor clippy nits by @nyurik in https://github.com/rust-lang/log/pull/578 |
| 9 |
* Simplify Display impl by @nyurik in https://github.com/rust-lang/log/pull/579 |
| 10 |
* Set all crates to 2021 edition by @nyurik in https://github.com/rust-lang/log/pull/580 |
| 11 |
* Various changes based on review by @Thomasdezeeuw in https://github.com/rust-lang/log/pull/583 |
| 12 |
* Fix typo in file_static() method doc by @dimo414 in https://github.com/rust-lang/log/pull/590 |
| 13 |
* Specialize empty key value pairs by @EFanZh in https://github.com/rust-lang/log/pull/576 |
| 14 |
* Fix incorrect lifetime in Value::to_str() by @peterjoel in https://github.com/rust-lang/log/pull/587 |
| 15 |
* Remove some API of the key-value feature by @Thomasdezeeuw in https://github.com/rust-lang/log/pull/585 |
| 16 |
* Add logcontrol-log and log-reload by @swsnr in https://github.com/rust-lang/log/pull/595 |
| 17 |
* Add Serialization section to kv::Value docs by @Thomasdezeeuw in https://github.com/rust-lang/log/pull/593 |
| 18 |
* Rename Value::to_str to to_cow_str by @Thomasdezeeuw in https://github.com/rust-lang/log/pull/592 |
| 19 |
* Clarify documentation and simplify initialization of `STATIC_MAX_LEVEL` by @ptosi in https://github.com/rust-lang/log/pull/594 |
| 20 |
* Update docs to 2021 edition, test by @nyurik in https://github.com/rust-lang/log/pull/577 |
| 21 |
* Add "alterable_logger" link to README.md by @brummer-simon in https://github.com/rust-lang/log/pull/589 |
| 22 |
* Normalize line ending by @EFanZh in https://github.com/rust-lang/log/pull/602 |
| 23 |
* Remove `ok_or` in favor of `Option::ok_or` by @AngelicosPhosphoros in https://github.com/rust-lang/log/pull/607 |
| 24 |
* Use `Acquire` ordering for initialization check by @AngelicosPhosphoros in https://github.com/rust-lang/log/pull/610 |
| 25 |
* Get structured logging API ready for stabilization by @KodrAus in https://github.com/rust-lang/log/pull/613 |
| 26 |
|
| 27 |
## New Contributors |
| 28 |
* @nyurik made their first contribution in https://github.com/rust-lang/log/pull/578 |
| 29 |
* @dimo414 made their first contribution in https://github.com/rust-lang/log/pull/590 |
| 30 |
* @peterjoel made their first contribution in https://github.com/rust-lang/log/pull/587 |
| 31 |
* @ptosi made their first contribution in https://github.com/rust-lang/log/pull/594 |
| 32 |
* @brummer-simon made their first contribution in https://github.com/rust-lang/log/pull/589 |
| 33 |
* @AngelicosPhosphoros made their first contribution in https://github.com/rust-lang/log/pull/607 |
| 34 |
|
| 35 |
## [0.4.20] - 2023-07-11 |
| 36 |
|
| 37 |
* Remove rustversion dev-dependency by @Thomasdezeeuw in https://github.com/rust-lang/log/pull/568 |
| 38 |
* Remove `local_inner_macros` usage by @EFanZh in https://github.com/rust-lang/log/pull/570 |
| 39 |
|
| 40 |
## [0.4.19] - 2023-06-10 |
| 41 |
|
| 42 |
* Use target_has_atomic instead of the old atomic_cas cfg by @GuillaumeGomez in https://github.com/rust-lang/log/pull/555 |
| 43 |
* Put MSRV into Cargo.toml by @est31 in https://github.com/rust-lang/log/pull/557 |
| 44 |
|
| 45 |
## [0.4.18] - 2023-05-28 |
| 46 |
|
| 47 |
* fix markdown links (again) by @hellow554 in https://github.com/rust-lang/log/pull/513 |
| 48 |
* add cargo doc to workflow by @hellow554 in https://github.com/rust-lang/log/pull/515 |
| 49 |
* Apply Clippy lints by @hellow554 in https://github.com/rust-lang/log/pull/516 |
| 50 |
* Replace ad-hoc eq_ignore_ascii_case with slice::eq_ignore_ascii_case by @glandium in https://github.com/rust-lang/log/pull/519 |
| 51 |
* fix up windows targets by @KodrAus in https://github.com/rust-lang/log/pull/528 |
| 52 |
* typo fix by @jiangying000 in https://github.com/rust-lang/log/pull/529 |
| 53 |
* Remove dependency on cfg_if by @EriKWDev in https://github.com/rust-lang/log/pull/536 |
| 54 |
* GitHub Workflows security hardening by @sashashura in https://github.com/rust-lang/log/pull/538 |
| 55 |
* Fix build status badge by @atouchet in https://github.com/rust-lang/log/pull/539 |
| 56 |
* Add call_logger to the documentation by @a1ecbr0wn in https://github.com/rust-lang/log/pull/547 |
| 57 |
* Use stable internals for key-value API by @KodrAus in https://github.com/rust-lang/log/pull/550 |
| 58 |
* Change wording of list of implementations by @Thomasdezeeuw in https://github.com/rust-lang/log/pull/553 |
| 59 |
* Add std-logger to list of implementations by @Thomasdezeeuw in https://github.com/rust-lang/log/pull/554 |
| 60 |
* Add `set_max_level_racy` and gate `set_max_level` by @djkoloski in https://github.com/rust-lang/log/pull/544 |
| 61 |
* [doc] src/lib.rs : prefix an unused variable with an underscore by @OccupyMars2025 in https://github.com/rust-lang/log/pull/561 |
| 62 |
* [doc] src/macros.rs : correct grammar errors of an example in lib documentation by @OccupyMars2025 in https://github.com/rust-lang/log/pull/562 |
| 63 |
|
| 64 |
## [0.4.17] - 2022-04-29 |
| 65 |
|
| 66 |
* Update `kv_unstable` internal dependencies. |
| 67 |
|
| 68 |
## [0.4.16] - 2022-03-22 |
| 69 |
|
| 70 |
* Fix a conflict with unqualified `Option` use in macros. |
| 71 |
|
| 72 |
## [0.4.15] - 2022-02-23 |
| 73 |
|
| 74 |
* Silence a warning about the deprecated `spin_loop_hint`. |
| 75 |
* Relax ordering in the atomic `set_max_level` call. |
| 76 |
* Add thumbv4t-none-eabi to targets that don't support atomics |
| 77 |
* Allow levels to be iterated over. |
| 78 |
* Implement `Log` on some common wrapper types. |
| 79 |
* Improvements to test coverage. |
| 80 |
* Improvements to documentation. |
| 81 |
* Add key-value support to the `log!` macros. |
| 82 |
* Tighten `kv_unstable` internal dependencies so they don't bump past their current alpha. |
| 83 |
* Add a simple visit API to `kv_unstable`. |
| 84 |
* Support `NonZero*` integers as values in structured logging |
| 85 |
* Support static strings as keys in structured logging |
| 86 |
|
| 87 |
## [0.4.14] - 2021-01-27 |
| 88 |
|
| 89 |
* Remove the `__private_api_log_lit` special case. |
| 90 |
* Fixed incorrect combination of `kv_unstable` and `std` features causing compile failures. |
| 91 |
* Remove unstable `Value::to_*` conversions that were incorrectly using `as`. |
| 92 |
* Rename unstable `Value::to_error` to `Value::to_borrowed_error`. |
| 93 |
|
| 94 |
## [0.4.13] - 2021-01-11 |
| 95 |
|
| 96 |
* This is the same as `0.4.11`, except with a `kv_unstable_std` feature added to aid migrating current dependents to `0.4.14` (which was originally going to be `0.4.13` until it was decided to create a patch from `0.4.11` to minimize disruption). |
| 97 |
|
| 98 |
## [0.4.12] - 2020-12-24 |
| 99 |
|
| 100 |
### New |
| 101 |
|
| 102 |
* Support platforms without atomics by racing instead of failing to compile |
| 103 |
* Implement `Log` for `Box<T: Log>` |
| 104 |
* Update `cfg-if` to `1.0` |
| 105 |
* Internal reworks of the structured logging API. Removed the `Fill` API |
| 106 |
and added `source::as_map` and `source::as_list` to easily serialize a `Source` |
| 107 |
as either a map of `{key: value, ..}` or as a list of `[(key, value), ..]`. |
| 108 |
|
| 109 |
### Fixed |
| 110 |
|
| 111 |
* Fixed deserialization of `LevelFilter` to use their `u64` index variants |
| 112 |
|
| 113 |
## [0.4.11] - 2020-07-09 |
| 114 |
|
| 115 |
### New |
| 116 |
|
| 117 |
* Support coercing structured values into concrete types. |
| 118 |
* Reference the `win_dbg_logger` in the readme. |
| 119 |
|
| 120 |
### Fixed |
| 121 |
|
| 122 |
* Updates a few deprecated items used internally. |
| 123 |
* Fixed issues in docs and expands sections. |
| 124 |
* Show the correct build badge in the readme. |
| 125 |
* Fix up a possible inference breakage with structured value errors. |
| 126 |
* Respect formatting flags in structured value formatting. |
| 127 |
|
| 128 |
## [0.4.10] - 2019-12-16 (yanked) |
| 129 |
|
| 130 |
### Fixed |
| 131 |
|
| 132 |
* Fixed the `log!` macros so they work in expression context (this regressed in `0.4.9`, which has been yanked). |
| 133 |
|
| 134 |
## [0.4.9] - 2019-12-12 (yanked) |
| 135 |
|
| 136 |
### Minimum Supported Rust Version |
| 137 |
|
| 138 |
This release bumps the minimum compiler version to `1.31.0`. This was mainly needed for `cfg-if`, |
| 139 |
but between `1.16.0` and `1.31.0` there are a lot of language and library improvements we now |
| 140 |
take advantage of. |
| 141 |
|
| 142 |
### New |
| 143 |
|
| 144 |
* Unstable support for capturing key-value pairs in a record using the `log!` macros |
| 145 |
|
| 146 |
### Improved |
| 147 |
|
| 148 |
* Better documentation for max level filters. |
| 149 |
* Internal updates to line up with bumped MSRV |
| 150 |
|
| 151 |
## [0.4.8] - 2019-07-28 |
| 152 |
|
| 153 |
### New |
| 154 |
|
| 155 |
* Support attempting to get `Record` fields as static strings. |
| 156 |
|
| 157 |
## [0.4.7] - 2019-07-06 |
| 158 |
|
| 159 |
### New |
| 160 |
|
| 161 |
* Support for embedded environments with thread-unsafe initialization. |
| 162 |
* Initial unstable support for capturing structured data under the `kv_unstable` |
| 163 |
feature gate. This new API doesn't affect existing users and may change in future |
| 164 |
patches (so those changes may not appear in the changelog until it stabilizes). |
| 165 |
|
| 166 |
### Improved |
| 167 |
|
| 168 |
* Docs for using `log` with the 2018 edition. |
| 169 |
* Error messages for macros missing arguments. |
| 170 |
|
| 171 |
## [0.4.6] - 2018-10-27 |
| 172 |
|
| 173 |
### Improved |
| 174 |
|
| 175 |
* Support 2018-style macro import for the `log_enabled!` macro. |
| 176 |
|
| 177 |
## [0.4.5] - 2018-09-03 |
| 178 |
|
| 179 |
### Improved |
| 180 |
|
| 181 |
* Make `log`'s internal helper macros less likely to conflict with user-defined |
| 182 |
macros. |
| 183 |
|
| 184 |
## [0.4.4] - 2018-08-17 |
| 185 |
|
| 186 |
### Improved |
| 187 |
|
| 188 |
* Support 2018-style imports of the log macros. |
| 189 |
|
| 190 |
## [0.4.3] - 2018-06-29 |
| 191 |
|
| 192 |
### Improved |
| 193 |
|
| 194 |
* More code generation improvements. |
| 195 |
|
| 196 |
## [0.4.2] - 2018-06-05 |
| 197 |
|
| 198 |
### Improved |
| 199 |
|
| 200 |
* Log invocations now generate less code. |
| 201 |
|
| 202 |
### Fixed |
| 203 |
|
| 204 |
* Example Logger implementations now properly set the max log level. |
| 205 |
|
| 206 |
## [0.4.1] - 2017-12-30 |
| 207 |
|
| 208 |
### Fixed |
| 209 |
|
| 210 |
* Some doc links were fixed. |
| 211 |
|
| 212 |
## [0.4.0] - 2017-12-24 |
| 213 |
|
| 214 |
The changes in this release include cleanup of some obscure functionality and a more robust public |
| 215 |
API designed to support bridges to other logging systems, and provide more flexibility to new |
| 216 |
features in the future. |
| 217 |
|
| 218 |
### Compatibility |
| 219 |
|
| 220 |
Vast portions of the Rust ecosystem use the 0.3.x release series of log, and we don't want to force |
| 221 |
the community to go through the pain of upgrading every crate to 0.4.x at the exact same time. Along |
| 222 |
with 0.4.0, we've published a new 0.3.9 release which acts as a "shim" over 0.4.0. This will allow |
| 223 |
crates using either version to coexist without losing messages from one side or the other. |
| 224 |
|
| 225 |
There is one caveat - a log message generated by a crate using 0.4.x but consumed by a logging |
| 226 |
implementation using 0.3.x will not have a file name or module path. Applications affected by this |
| 227 |
can upgrade their logging implementations to one using 0.4.x to avoid losing this information. The |
| 228 |
other direction does not lose any information, fortunately! |
| 229 |
|
| 230 |
**TL;DR** Libraries should feel comfortable upgrading to 0.4.0 without treating that as a breaking |
| 231 |
change. Applications may need to update their logging implementation (e.g. env-logger) to a newer |
| 232 |
version using log 0.4.x to avoid losing module and file information. |
| 233 |
|
| 234 |
### New |
| 235 |
|
| 236 |
* The crate is now `no_std` by default. |
| 237 |
* `Level` and `LevelFilter` now implement `Serialize` and `Deserialize` when the `serde` feature is |
| 238 |
enabled. |
| 239 |
* The `Record` and `Metadata` types can now be constructed by third-party code via a builder API. |
| 240 |
* The `logger` free function returns a reference to the logger implementation. This, along with the |
| 241 |
ability to construct `Record`s, makes it possible to bridge from another logging framework to |
| 242 |
this one without digging into the private internals of the crate. The standard `error!` `warn!`, |
| 243 |
etc, macros now exclusively use the public API of the crate rather than "secret" internal APIs. |
| 244 |
* `Log::flush` has been added to allow crates to tell the logging implementation to ensure that all |
| 245 |
"in flight" log events have been persisted. This can be used, for example, just before an |
| 246 |
application exits to ensure that asynchronous log sinks finish their work. |
| 247 |
|
| 248 |
### Removed |
| 249 |
|
| 250 |
* The `shutdown` and `shutdown_raw` functions have been removed. Supporting shutdown significantly |
| 251 |
complicated the implementation and imposed a performance cost on each logging operation. |
| 252 |
* The `log_panics` function and its associated `nightly` Cargo feature have been removed. Use the |
| 253 |
[log-panics](https://crates.io/crates/log-panics) instead. |
| 254 |
|
| 255 |
### Changed |
| 256 |
|
| 257 |
* The `Log` prefix has been removed from type names. For example, `LogLevelFilter` is now |
| 258 |
`LevelFilter`, and `LogRecord` is now `Record`. |
| 259 |
* The `MaxLogLevelFilter` object has been removed in favor of a `set_max_level` free function. |
| 260 |
* The `set_logger` free functions have been restructured. The logger is now directly passed to the |
| 261 |
functions rather than a closure which returns the logger. `set_logger` now takes a `&'static |
| 262 |
Log` and is usable in `no_std` contexts in place of the old `set_logger_raw`. `set_boxed_logger` |
| 263 |
is a convenience function which takes a `Box<Log>` but otherwise acts like `set_logger`. It |
| 264 |
requires the `std` feature. |
| 265 |
* The `file` and `module_path` values in `Record` no longer have the `'static` lifetime to support |
| 266 |
integration with other logging frameworks that don't provide a `'static` lifetime for the |
| 267 |
equivalent values. |
| 268 |
* The `file`, `line`, and `module_path` values in `Record` are now `Option`s to support integration |
| 269 |
with other logging frameworks that don't provide those values. |
| 270 |
|
| 271 |
### In the Future |
| 272 |
|
| 273 |
* We're looking to add support for *structured* logging - the inclusion of extra key-value pairs of |
| 274 |
information in a log event in addition to the normal string message. This should be able to be |
| 275 |
added in a backwards compatible manner to the 0.4.x series when the design is worked out. |
| 276 |
|
| 277 |
## Older |
| 278 |
|
| 279 |
Look at the [release tags] for information about older releases. |
| 280 |
|
| 281 |
[Unreleased]: https://github.com/rust-lang-nursery/log/compare/0.4.21...HEAD |
| 282 |
[0.4.21]: https://github.com/rust-lang/log/compare/0.4.20...0.4.21 |
| 283 |
[0.4.20]: https://github.com/rust-lang-nursery/log/compare/0.4.19...0.4.20 |
| 284 |
[0.4.19]: https://github.com/rust-lang-nursery/log/compare/0.4.18...0.4.19 |
| 285 |
[0.4.18]: https://github.com/rust-lang-nursery/log/compare/0.4.17...0.4.18 |
| 286 |
[0.4.17]: https://github.com/rust-lang-nursery/log/compare/0.4.16...0.4.17 |
| 287 |
[0.4.16]: https://github.com/rust-lang-nursery/log/compare/0.4.15...0.4.16 |
| 288 |
[0.4.15]: https://github.com/rust-lang-nursery/log/compare/0.4.13...0.4.15 |
| 289 |
[0.4.14]: https://github.com/rust-lang-nursery/log/compare/0.4.13...0.4.14 |
| 290 |
[0.4.13]: https://github.com/rust-lang-nursery/log/compare/0.4.11...0.4.13 |
| 291 |
[0.4.12]: https://github.com/rust-lang-nursery/log/compare/0.4.11...0.4.12 |
| 292 |
[0.4.11]: https://github.com/rust-lang-nursery/log/compare/0.4.10...0.4.11 |
| 293 |
[0.4.10]: https://github.com/rust-lang-nursery/log/compare/0.4.9...0.4.10 |
| 294 |
[0.4.9]: https://github.com/rust-lang-nursery/log/compare/0.4.8...0.4.9 |
| 295 |
[0.4.8]: https://github.com/rust-lang-nursery/log/compare/0.4.7...0.4.8 |
| 296 |
[0.4.7]: https://github.com/rust-lang-nursery/log/compare/0.4.6...0.4.7 |
| 297 |
[0.4.6]: https://github.com/rust-lang-nursery/log/compare/0.4.5...0.4.6 |
| 298 |
[0.4.5]: https://github.com/rust-lang-nursery/log/compare/0.4.4...0.4.5 |
| 299 |
[0.4.4]: https://github.com/rust-lang-nursery/log/compare/0.4.3...0.4.4 |
| 300 |
[0.4.3]: https://github.com/rust-lang-nursery/log/compare/0.4.2...0.4.3 |
| 301 |
[0.4.2]: https://github.com/rust-lang-nursery/log/compare/0.4.1...0.4.2 |
| 302 |
[0.4.1]: https://github.com/rust-lang-nursery/log/compare/0.4.0...0.4.1 |
| 303 |
[0.4.0]: https://github.com/rust-lang-nursery/log/compare/0.3.8...0.4.0 |
| 304 |
[release tags]: https://github.com/rust-lang-nursery/log/releases |