Skip to content

Commit c2b7961

Browse files
committed
docs(buffers): note known restart bugs in disk buffer docs
1 parent 24bd060 commit c2b7961

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

website/content/en/docs/architecture/buffering-model.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,10 @@ detected, to give as accurate of a view into the number of events that were lost
122122

123123
{{< warning >}}
124124
Disk buffers have some unique monitoring requirements compared to in-memory buffers,
125-
specifically around free storage space.
125+
specifically around free storage space. There are also [known bugs][disk_buffer_bugs] that can
126+
cause disk buffers to become unreadable after a restart, resulting in data loss.
127+
128+
[disk_buffer_bugs]: https://github.com/vectordotdev/vector/issues?q=sort%3Aupdated-desc+is%3Aissue+state%3Aopen+label%3A%22domain%3A+buffers%22+type%3ABug
126129
{{< /warning >}}
127130

128131
I/O errors are notoriously hard to recover from, as it can be difficult to know what data made it to
@@ -248,7 +251,8 @@ handle higher event processing rates.
248251

249252
**Durability is the most important factor.**
250253

251-
You should use disk buffers.
254+
You should use disk buffers, but be aware of the [known bugs][disk_buffer_bugs] before committing
255+
to them in production.
252256

253257
Depending on your sources, you may be fine to keep the default blocking behavior, or you may wish to
254258
also drop events when the buffer is full. As mentioned above, some sources are receiving data from

0 commit comments

Comments
 (0)