Skip to content

Commit d391514

Browse files
committed
docs: add release note for optional migration
1 parent ac6e1a8 commit d391514

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

docs/release-notes/release-notes-0.15.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,4 +454,4 @@ gRPC performance metrics (latency to process `GetInfo`, etc)](https://github.com
454454
* Torkel Rogstad
455455
* Vsevolod Kaganovych
456456
* Yong Yu
457-
* Ziggie
457+
* Ziggie

docs/release-notes/release-notes-0.15.1.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,23 @@
3030
* [Delete failed payment attempts](https://github.com/lightningnetwork/lnd/pull/6438)
3131
once payments are settled, unless specified with `keep-failed-payment-attempts` flag.
3232

33+
* [A new db configuration flag
34+
`db.prune-revocation`](https://github.com/lightningnetwork/lnd/pull/6469) is
35+
introduced to take the advantage enabled by [a recent space
36+
optimization](https://github.com/lightningnetwork/lnd/pull/6347). Users can
37+
set this flag to `true` to run an optional db migration during `lnd`'s
38+
startup. This flag will prune the old revocation logs and save them using the
39+
new format that can save large amount of disk space.
40+
For a busy channel with millions of updates, this migration can take quite
41+
some time. The benchmark shows it takes roughly 70 seconds to finish a
42+
migration with 1 million logs. Of course the actual time taken can vary from
43+
machine to machine. Users can run the following benchmark test to get an
44+
accurate time it'll take for a channel with 1 millions updates to plan ahead,
45+
```sh
46+
cd ./channeldb/migration30
47+
go test -bench=. -run=TestMigrateRevocationLogMemCap -benchtime=1000000x -timeout=10m -benchmem
48+
```
49+
3350
## Documentation
3451

3552
* [Add minor comment](https://github.com/lightningnetwork/lnd/pull/6559) on

0 commit comments

Comments
 (0)