Skip to content

buffer: document evacuate_limit_size - #715

Merged
Watson1978 merged 2 commits into
fluent:1.0from
Watson1978:buffer-evacuate-limit-size
Oct 23, 2026
Merged

Watson1978 merged 2 commits into
fluent:1.0from
Watson1978:buffer-evacuate-limit-size

Conversation

@Watson1978

Copy link
Copy Markdown
Contributor

fluent/fluentd#5473 adds evacuate_limit_size to limit the total size of the evacuated chunk files, and the docs assume that it is released in v1.20.0. This describes the parameter in "Handling Successive Failures" and the buffer section, including that it is an approximate limit, that newer chunks are not evacuated once the directory is full, and that @id is needed. It also notes for buffer plugin authors where the base class counts the evacuated files.

This should be merged after fluent/fluentd#5473.

🤖 Generated with Claude Code

fluent/fluentd#5473 adds evacuate_limit_size to limit the total size of
the evacuated chunk files. Describe how chunks are chosen, why the total
can exceed the limit, and why @id is needed.

Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@netlify

netlify Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for fluentd-docs ready!

Name Link
🔨 Latest commit d18d8c4
🔍 Latest deploy log https://app.netlify.com/projects/fluentd-docs/deploys/6ad71bd67994dfa29d176abc
😎 Deploy Preview https://deploy-preview-715--fluentd-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Watson1978
Watson1978 requested a review from kenhys October 20, 2026 03:26
Watson1978 added a commit to fluent/fluentd that referenced this pull request Oct 20, 2026
… the disk (#5473)

**Which issue(s) this PR fixes**:
Fixes #5352

**What this PR does / why we need it**:
When the retry limit is reached, all queued chunks are evacuated to
`${root_dir}/buffer/${plugin_id}/`, and a long outage repeats this until
the disk is full (#5352). This PR adds `evacuate_limit_size`, which
limits the total size of the files in that directory, including the ones
evacuated before. Chunks that do not fit are purged without being
evacuated, `0` disables evacuation, and the default `nil` keeps the
current behavior.

**Docs Changes**:
Describe `evacuate_limit_size` in "Handling Successive Failures" of
buffer/README.md. It is an approximate limit. The total can exceed it by
the `.meta` files of the evacuated chunks, or when multiple workers of
the same plugin evacuate chunks at the same time. Chunks are evacuated
from the oldest, so once the directory reaches the limit, newer chunks
are not evacuated until the evacuated files are moved or removed. `@id`
is recommended, and the parameter is ignored by the memory buffer. I
will open a PR on fluentd-docs-gitbook.
fluent/fluentd-docs-gitbook#715

**Release Note**:
buffer: add `evacuate_limit_size` to limit the total size of the
evacuated chunk files. Set `0` to disable evacuation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Signed-off-by: Chris (ChrisJr404) <11917633+ChrisJr404@users.noreply.github.com>
Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
Co-authored-by: Chris (ChrisJr404) <11917633+ChrisJr404@users.noreply.github.com>
Co-authored-by: Shizuo Fujita <fujita@clear-code.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread buffer/README.md Outdated
"disable the evacuation" did not say what happens to the queued chunks.

Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
Co-authored-by: Kentaro Hayashi <kenhys@gmail.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Watson1978
Watson1978 requested a review from kenhys October 20, 2026 07:45
@kenhys kenhys added the pending To be done in the future label Oct 20, 2026
@kenhys kenhys added this to the fluentd-v1.20 milestone Oct 20, 2026
@Watson1978

Copy link
Copy Markdown
Contributor Author

Thanks

@Watson1978 Watson1978 removed the pending To be done in the future label Oct 23, 2026
@Watson1978
Watson1978 merged commit 5f09a1b into fluent:1.0 Oct 23, 2026
6 checks passed
@Watson1978
Watson1978 deleted the buffer-evacuate-limit-size branch October 23, 2026 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants