From 7e4a54530b90656b8350d433042a66d4224210fa Mon Sep 17 00:00:00 2001 From: MrCroxx Date: Sat, 14 Sep 2024 06:18:29 +0000 Subject: [PATCH] doc: remove details tag in change log for better searching Signed-off-by: MrCroxx --- CHANGELOG.md | 243 ++++++++++++++++++--------------------------------- 1 file changed, 84 insertions(+), 159 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 17b3fa6b..af62fc78 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,7 @@ ## 2024-09-12 +### Releases + | crate | version | | - | - | | foyer | 0.11.2 | @@ -9,8 +11,6 @@ | foyer-storage | 0.10.2 | | foyer-bench | 0.3.2 | -
- ### Changes - Support windows (for `foyer` only). @@ -20,10 +20,10 @@ - Use bytes size for `foyer-bench`. - Fix install deps script. -
- ## 2024-08-31 +### Releases + | crate | version | | - | - | | foyer | 0.11.1 | @@ -33,8 +33,6 @@ | foyer-storage | 0.10.1 | | foyer-bench | 0.3.1 | -
- ### Changes - Add metrics for serde. @@ -43,10 +41,10 @@ - Implement `Default` for `TokioRuntimeConfig`. - Fix typos and format code with unstable features. -
- ## 2024-08-21 +### Releases + | crate | version | | - | - | | foyer | 0.11.0 | @@ -56,8 +54,6 @@ | foyer-storage | 0.10.0 | | foyer-bench | 0.3.0 | -
- ### Changes - Support disk cache on raw block device. @@ -69,42 +65,38 @@ - Update `foyer-bench` with more fine-grained configurations. - Fix panics with `None` recover mode. -
- ## 2024-08-15 +### Releases + | crate | version | | - | - | | foyer | 0.10.4 | | foyer-storage | 0.9.3 | | foyer-bench | 0.2.3 | -
- ### Changes - Support serde for recover mode configuration. -
- ## 2024-08-14 +### Releases + | crate | version | | - | - | | foyer | 0.10.2 | | foyer-storage | 0.9.2 | | foyer-bench | 0.2.2 | -
- ### Changes - Fix panic with "none" recovery mode. -
- ## 2024-07-08 +### Releases + | crate | version | | - | - | | foyer | 0.10.1 | @@ -114,16 +106,14 @@ | foyer-storage | 0.9.1 | | foyer-bench | 0.2.1 | -
- ### Changes - Refine write model, make flush buffer threshold configurable to mitigate memory usage spike and OOM. -
- ## 2024-07-02 +### Releases + | crate | version | | - | - | | foyer | 0.10.0 | @@ -133,37 +123,33 @@ | foyer-storage | 0.9.0 | | foyer-bench | 0.2.0 | -
- ### Changes - Introduce tail-based tracing framework with [minitrace](https://github.com/tikv/minitrace-rust). [Tail-based Tracing Example](https://github.com/foyer-rs/foyer/tree/main/examples/tail_based_tracing.rs). - Fix `fetch()` disk cache refill on in-memory cache miss. - Publish *foyer* logo! - - -
+ ## 2024-06-14 +### Releases + | crate | version | | - | - | | foyer | 0.9.4 | | foyer-storage | 0.8.5 | | foyer-bench | 0.1.4 | -
- ### Changes - Fix phantom entries after foyer storage recovery. [#560](https://github.com/foyer-rs/foyer/pull/560) - Fix hybrid cache hit metrics with `fetch()` interface. [#563](https://github.com/foyer-rs/foyer/pull/563) -
- ## 2024-06-05 +### Releases + | crate | version | | - | - | | foyer | 0.9.3 | @@ -173,31 +159,27 @@ | foyer-storage | 0.8.4 | | foyer-bench | 0.1.3 | -
- ### Changes - Hybrid cache `fetch()` use the dedicated runtime by default if enabled. - Separate `fetch()` and `fetch_with_runtime()` interface for in-memory cache. -
- ## 2024-06-04 +### Releases + | crate | version | | - | - | | foyer-storage | 0.8.3 | -
- ### Changes - Fix "invalid argument (code: 22)" on target aarch64. -
- ## 2024-06-03 +### Releases + | crate | version | | - | - | | foyer | 0.9.2 | @@ -207,16 +189,14 @@ | foyer-storage | 0.8.2 | | foyer-bench | 0.1.2 | -
- ### Changes - Support customized cache event listener. -
- ## 2024-05-31 +### Releases + | crate | version | | - | - | | foyer | 0.9.1 | @@ -226,8 +206,6 @@ | foyer-storage | 0.8.1 | | foyer-bench | 0.1.1 | -
- ### Changes - Fix "attempt to subtract with overflow" panic after cloning cache entry. [#543](https://github.com/foyer-rs/foyer/issues/543). @@ -240,10 +218,10 @@ - Remove `pop()` related interface from the in-memory cache. - Refine intrusive data structure implementation. -
- ## 2024-05-27 +### Releases + | crate | version | | - | - | | foyer | 0.9.0 | @@ -253,8 +231,6 @@ | foyer-storage | 0.8.0 | | foyer-bench | 0.1.0 | -
- ### Changes - Refine the storage engine to reduce the overhead and boost the performance. @@ -267,10 +243,10 @@ - Reduce unnecessary dependencies. - More details: [foyer - Development Roadmap](https://github.com/orgs/foyer-rs/projects/2). -
- ## 2024-04-28 +### Releases + | crate | version | | - | - | | foyer | 0.8.9 | @@ -279,17 +255,15 @@ | foyer-storage | 0.7.6 | | foyer-storage-bench | 0.7.5 | -
- ### Changes - feat: Add config to control the recover mode. - feat: Add config to enable/disable direct i/o. (Enabled by default for large entries optimization.) -
- ## 2024-04-28 +### Releases + | crate | version | | - | - | | foyer | 0.8.8 | @@ -297,60 +271,52 @@ | foyer-storage | 0.7.5 | | foyer-storage-bench | 0.7.4 | -
- ### Changes - feat: Impl `Debug` for `HybridCache`. - feat: Impl `serde`, `Default` for eviction configs. - refactor: Add internal trait `EvictionConfig` to bound eviction algorithm configs. -
- ## 2024-04-27 +### Releases + | crate | version | | - | - | | foyer | 0.8.7 | -
- ### Changes - Make `HybridCache` clonable. -
- ## 2024-04-27 +### Releases + | crate | version | | - | - | | foyer-memory | 0.3.4 | -
- ### Changes - Fix S3FIFO ghost queue. -
- ## 2024-04-26 +### Releases + | crate | version | | - | - | | foyer-storage | 0.7.4 | -
- ### Changes - Fix `FsDeviceBuilder` on a non-exist directory without capacity given. -
- ## 2024-04-26 +### Releases + | crate | version | | - | - | | foyer | 0.8.6 | @@ -360,23 +326,19 @@ | foyer-storage | 0.7.3 | | foyer-storage-bench | 0.7.3 | -
- ### Changes - Remove unused dependencies. - Remove hakari workspace hack. -
- ## 2024-04-26 +### Releases + | crate | version | | - | - | | foyer | 0.8.5 | -
- ### Changes - Expose `EntryState`, `HybridEntry`. @@ -385,38 +347,34 @@ - Re-export `ahash::RandomState`. - Loose `entry()` args trait bounds. -
- ## 2024-04-25 +### Releases + | crate | version | | - | - | | foyer | 0.8.4 | -
- ### Changes - Expose `HybridCacheEntry`. -
- ## 2024-04-25 +### Releases + | crate | version | | - | - | | foyer | 0.8.3 | -
- ### Changes - Expose `Key`, `Value`, `StorageKey`, `StorageValue` traits. -
- ## 2024-04-24 +### Releases + | crate | version | | - | - | | foyer | 0.8.2 | @@ -427,16 +385,14 @@ | foyer-storage-bench | 0.7.2 | | foyer-workspace-hack | 0.5.2 | -
- ### Changes - Add `nightly` feature to make it compatible with night toolchain. -
- ## 2024-04-24 +### Releases + | crate | version | | - | - | | foyer | 0.8.1 | @@ -447,18 +403,16 @@ | foyer-storage-bench | 0.7.1 | | foyer-workspace-hack | 0.5.1 | -
- ### Changes - Add `with_flush` to enable flush for each io. - Loose MSRV to 1.76 . - Flush the device on store close. -
- ## 2024-04-23 +### Releases + | crate | version | | - | - | | foyer | 0.8.0 | @@ -469,8 +423,6 @@ | foyer-storage-bench | 0.7.0 | | foyer-workspace-hack | 0.5.0 | -
- ### Changes - Combine in-memory cache and disk cache into `HybridCache`. @@ -482,10 +434,10 @@ - Fix S3FIFO eviction bugs. - Add more examples. -
- ## 2024-04-11 +### Releases + | crate | version | | - | - | | foyer | 0.7.0 | @@ -496,90 +448,78 @@ | foyer-storage-bench | 0.6.0 | | foyer-workspace-hack | 0.4.0 | -
- ### Changes - Make `foyer` compatible with rust stable toolchain (MSRV = 1.77.2). 🎉 -
- ## 2024-04-09 +### Releases + | crate | version | | - | - | | foyer-storage | 0.5.1 | | foyer-memory | 0.1.4 | -
- ### Changes - fix: Fix panics on `state()` for s3fifo entry. - fix: Enable `offset_of` feature for `foyer-storage`. -
- ## 2024-04-08 +### Releases + | crate | version | | - | - | | foyer-intrusive | 0.3.1 | | foyer-memory | 0.1.3 | -
- ### Changes - feat: Introduce s3fifo to `foyer-memory`. - fix: Fix doctest for `foyer-intrusive`. -
- ## 2024-03-21 +### Releases + | crate | version | | - | - | | foyer-memory | 0.1.2 | -
- ### Changes - fix: `foyer-memory` export `DefaultCacheEventListener`. -
- ## 2024-03-14 +### Releases + | crate | version | | - | - | | foyer-memory | 0.1.1 | -
- ### Changes - Make eviction config clonable. -
- ## 2024-03-13 +### Releases + | crate | version | | - | - | | foyer-storage-bench | 0.5.1 | -
- ### Changes - Fix `foyer-storage-bench` build with `trace` feature. -
- ## 2024-03-12 +### Releases + | crate | version | | - | - | | foyer | 0.6.0 | @@ -590,17 +530,15 @@ | foyer-storage-bench | 0.5.0 | | foyer-workspace-hack | 0.3.0 | -
- ### Changes - Release foyer in-memory cache as crate `foyer-memory`. - Bump other components with changes. -
- ## 2023-12-28 +### Releases + | crate | version | | - | - | | foyer | 0.5.0 | @@ -610,21 +548,16 @@ | foyer-storage-bench | 0.4.0 | | foyer-workspace-hack | 0.2.0 | -
- ### Changes - Bump rust-toolchain to "nightly-2023-12-26". - Introduce time-series distribution args to bench tool. [#253](https://github.com/foyer-rs/foyer/pull/253) - -### Fixes - - Fix duplicated insert drop metrics. -
- ## 2023-12-22 +### Releases + | crate | version | | - | - | | foyer | 0.4.0 | @@ -632,45 +565,40 @@ | foyer-storage-bench | 0.3.0 | | foyer-workspace-hack | 0.1.1 | -
- ### Changes - Remove config `flusher_buffer_capacity`. - -### Fixes - - Fix benchmark tool cache miss ratio. -
- ## 2023-12-20 +### Releases + | crate | version | | - | - | | foyer-storage | 0.2.2 | -
+### Changes - Fix metrics for writer dropping. - Add interface `insert_async_with_callback` and `insert_if_not_exists_async_with_callback` for callers to get the insert result. -
- ## 2023-12-18 +### Releases + | crate | version | | - | - | | foyer-storage | 0.2.1 | -
+### Changes - Introduce the entry size histogram, update metrics. -
- ## 2023-12-18 +### Releases + | crate | version | | - | - | | foyer | 0.3.0 | @@ -678,16 +606,16 @@ | foyer-storage | 0.2.0 | | foyer-storage-bench | 0.2.0 | -
+### Changes - Introduce the associated type `Cursor` for trait `Key` and `Value` to reduce unnecessary buffer copy if possible. - Remove the ring buffer and continuum tracker for they are no longer needed. - Update the configuration of the storage engine and the benchmark tool. -
- ## 2023-11-29 +### Releases + | crate | version | | - | - | | foyer | 0.2.0 | @@ -697,7 +625,7 @@ | foyer-storage-bench | 0.1.0 | | foyer-workspace-hack | 0.1.0 | -
+### Changes The first version that can be used as file cache. @@ -715,17 +643,14 @@ Brief description about the subcrates: - foyer-storage-bench: Runnable benchmark tool for the file cache storage engine. - foyer-workspace-hack: Generated by [hakari](https://crates.io/crates/hakari) to prevent building each crate from triggering building from scratch. -
- - ## 2023-05-12 +### Releases + | crate | version | | - | - | | foyer | 0.1.0 | -
+### Changes Initial version with just basic interfaces. - -