Skip to content

Commit aeaf178

Browse files
committed
in_tail: Add a description and note for Unicode.Encoding parameter
Signed-off-by: Hiroshi Hatake <[email protected]>
1 parent 90d1846 commit aeaf178

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

pipeline/inputs/tail.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,18 @@ The plugin supports the following configuration parameters:
3737
| Static\_Batch\_Size | Set the maximum number of bytes to process per iteration for the monitored static files (files that already exists upon Fluent Bit start). | 50M |
3838
| File\_Cache\_Advise | Set the posix_fadvise in POSIX_FADV_DONTNEED mode. This will reduce the usage of the kernel file cache. This option is ignored if not running on Linux. | On |
3939
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
40+
| Unicode.Encoding | Set the encoding which the origin of character encoding. Currently, UTF-16LE, UTF-16BE, and auto is supported. | |
4041

4142
Note that if the database parameter `DB` is **not** specified, by default the plugin will start reading each target file from the beginning. This also might cause some unwanted behavior, for example when a line is bigger that `Buffer_Chunk_Size` and `Skip_Long_Lines` is not turned on, the file will be read from the beginning of each `Refresh_Interval` until the file is rotated.
4243

44+
Note that `Unicode.Encoding` depends on simdutf library which is written in C++11 or above.
45+
So, the older platforms are not supported for this feature.
46+
In addition, `Unicode.Encoding auto` is not covered for the all of the usages.
47+
This is because sometimes this auto-detecting for character encodings makes a mistake to guess the correct encoding.
48+
We recommend to use `UTF-16LE` or `UTF-16BE` if the target file encoding is pre-determined or known beforehand.
49+
In details, this parameter requests to use 2-bytes aligned chunk and buffer sizes.
50+
If they are not aligned for 2 bytes, Fluent Bit will use 2-bytes alignments automatically to avoid character breakages on consuming boundaries.
51+
4352
## Multiline Support
4453

4554
Starting from Fluent Bit v1.8 we have introduced a new Multiline core functionality. For Tail input plugin, it means that now it supports the **old** configuration mechanism but also the **new** one. In order to avoid breaking changes, we will keep both but encourage our users to use the latest one. We will call the two mechanisms as:

0 commit comments

Comments
 (0)