Skip to content

buf_file, buf_file_single: document file_permission and dir_permission #664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenhys merged 1 commit into from
Aug 4, 2026
Merged

buf_file, buf_file_single: document file_permission and dir_permission #664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions buffer/file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,48 @@ Changes the suffix of the buffer file.

This parameter is useful when `.log` is not fit for your environment. See also [this issue's comment](https://github.com/fluent/fluentd/issues/2236#issuecomment-514733974).

### `file_permission`

| type | default | version |
| :--- | :--- | :--- |
| string | nil | 0.14.0 |

The permission of the buffer chunk files, in the octal format. The same permission is applied to the `.meta` files.

```text
<match pattern>
...
<buffer>
@type file
path /var/log/fluent/buf
file_permission 0600
</buffer>
</match>
```

If this parameter is not set, [`file_permission`](../deployment/system-config.md#file_permission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0644` is used.

### `dir_permission`

| type | default | version |
| :--- | :--- | :--- |
| string | nil | 0.14.0 |

The permission of the directory created to store the buffer chunk files, in the octal format.

```text
<match pattern>
...
<buffer>
@type file
path /var/log/fluent/buf
dir_permission 0700
</buffer>
</match>
```

If this parameter is not set, [`dir_permission`](../deployment/system-config.md#dir_permission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0755` is used.

## Tips

### Customize a filename of the buffer chunk
Expand Down
44 changes: 44 additions & 0 deletions buffer/file_single.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,50 @@ Specifies the chunk format for `calc_num_records`.

With `auto`, the plugin decides the chunk format by `formatted_to_msgpack_binary?`. This option is useful when the output plugin does not implement `formatted_to_msgpack_binary?` correctly.

### `file_permission`

| type | required | default | version |
| :--- | :---: | :--- | :--- |
| string | | nil | 1.7.0 |

The permission of the buffer chunk files, in the octal format.

```text
<match pattern>
@type forward
# forward parameters
<buffer>
@type file_single
path /var/log/fluent/out_fwd
file_permission 0600
</buffer>
</match>
```

If this parameter is not set, [`file_permission`](../deployment/system-config.md#file_permission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0644` is used.

### `dir_permission`

| type | required | default | version |
| :--- | :---: | :--- | :--- |
| string | | nil | 1.7.0 |

The permission of the directory created to store the buffer chunk files, in the octal format.

```text
<match pattern>
@type forward
# forward parameters
<buffer>
@type file_single
path /var/log/fluent/out_fwd
dir_permission 0700
</buffer>
</match>
```

If this parameter is not set, [`dir_permission`](../deployment/system-config.md#dir_permission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0755` is used.

## Limitation

### chunk keys
Expand Down