Skip to content

Commit 44a2b56

Browse files
committed
file: add limitation about path parameter
fluent/fluentd#4407 Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
1 parent 200d6f5 commit 44a2b56

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

buffer/file.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,5 +164,12 @@ This config outputs the buffer chunk files as follows. In this case, `path_suffi
164164
Caution: `file` buffer implementation depends on the characteristics of the local file system. Don't use `file` buffer on remote file systems e.g. NFS, GlusterFS, HDFS, etc. We observed major data loss by using the remote file system.
165165
{% endhint %}
166166

167+
{% hint style='warning' %}
168+
`path` is implicitly used as file buffer path if file buffer path is not explicitly configured in `<buffer>` section.
169+
In such a case, it must not contain `[` or `]` in the actually evaluated `path`.
170+
If such a character was included in the path, it might be trouble (ignored) after restarting of Fluentd during resuming buffer handling process.
171+
As a workaround, override `path` parameter in `<buffer>` section which does not contain such a character.
172+
{% endhint %}
173+
167174
If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](http://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License.
168175

output/file.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,12 @@ If you want to specific `time`, `tag` or any `record` fields - placeholders in t
7171
(Thus, blank chunk keys `<buffer>` or empty keys `<buffer []>` is not allowed. It causes configuration error.)
7272
{% endhint %}
7373

74+
{% hint style='warning' %}
75+
`path` is implicitly used as file buffer path if file buffer path is not explicitly configured in `<buffer>` section.
76+
In such a case, it must not contain `[` or `]` in the actually evaluated `path`. See [`<buffer>` limitation](../buffer/file.md#limitation) about detail.
77+
78+
{% endhint %}
79+
7480
### `append`
7581

7682
| type | default | version |

0 commit comments

Comments
 (0)