Skip to content

Commit a17048a

Browse files
authored
Apply suggestions from code review
This should correct the severe vale errors and most of the suggestions, as well as matching current style. Signed-off-by: Lynette Miles <[email protected]>
1 parent 8872d54 commit a17048a

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

pipeline/inputs/tail.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Additionally, the `auto` setting for `Unicode.Encoding` isn't supported in all c
8686
{% endhint %}
8787

8888
{% hint style="info" %}
89-
The `Unicode.Encoding` parameter is dependent on the simdutf library, which is itself dependent on C++ version 11 or later. In environments that use earlier versions of C++, the `Unicode.Encoding` parameter will fail.
89+
The `Unicode.Encoding` parameter is dependent on the `simdutf` library, which is itself dependent on C++ version 11 or later. In environments that use earlier versions of C++, the `Unicode.Encoding` parameter will fail.
9090

9191
Additionally, the `auto` setting for `Unicode.Encoding` isn't supported in all cases, and can make mistakes when it tries to guess the correct encoding. For best results, use either the `UTF-16LE` or `UTF-16BE` setting if you know the encoding type of the target file.
9292
{% endhint %}
@@ -473,40 +473,40 @@ While file rotation is handled, there are risks of potential log loss when using
473473

474474
{% endhint %}
475475

476-
## Character Encoding Conversion
476+
## Character encoding conversion
477477

478478
This feature allows Fluent Bit to convert logs from various character encodings into the standard UTF-8 format.
479479
This is crucial for processing logs from systems, especially Windows, that use legacy or non-UTF-8 encodings.
480480
Proper conversion ensures that your log data is correctly parsed, indexed, and searchable.
481481

482-
### When to Use This Feature
482+
### When to use this feature
483483

484-
You should use this feature if your log files or messages are not in UTF-8 and you are seeing garbled or incorrectly rendered characters.
484+
You should use this feature if your log files or messages aren't in UTF-8 and you are seeing garbled or incorrectly rendered characters.
485485
This is common in environments that use:
486486

487487
- Modern Windows applications that log in UTF-16.
488488

489-
- Legacy Windows systems with applications that use traditional code pages (e.g., ShiftJIS, GBK, Win1252).
489+
- Legacy Windows systems with applications that use traditional code pages (for example, ShiftJIS, GBK, Win1252).
490490

491-
### Configuration Parameters
491+
### Configuration parameters
492492

493493
To enable encoding conversion, you will use one of the following two parameters within an input plugin configuration.
494494

495495
1. `Unicode.Encoding`
496496

497-
Use this parameter for high-performance conversion of UTF-16 encoded logs to UTF-8. This method utilizes modern processor features (SIMD instructions) to accelerate the conversion process, making it highly efficient.
497+
Use this parameter for high-performance conversion of UTF-16 encoded logs to UTF-8. This method utilizes modern processor features (SIMD instructions) to accelerate the conversion process, making it highly efficient.
498498

499-
- Use Case: Ideal for logs coming from modern Windows environments that default to UTF-16.
500-
- Supported Values:
501-
- UTF-16LE (Little-Endian)
502-
- UTF-16BE (Big-Endian)
499+
- Use Case: Ideal for logs coming from modern Windows environments that default to UTF-16.
500+
- Supported Values:
501+
- UTF-16LE (Little-Endian)
502+
- UTF-16BE (Big-Endian)
503503

504504
1. `Generic.Encoding`
505505

506-
Use this parameter to convert from a wide variety of other character encodings, particularly legacy Windows code pages.
506+
Use this parameter to convert from a wide variety of other character encodings, particularly legacy Windows code pages.
507507

508-
- Use Case: Essential for logs from older systems or applications configured for specific regions, common in East Asia and Eastern Europe.
509-
- Supported Values: You can use any of the names or aliases listed below.
508+
- Use Case: Essential for logs from older systems or applications configured for specific regions, common in East Asia and Eastern Europe.
509+
- Supported Values: You can use any of the names or aliases listed below.
510510

511511
### East Asian Encodings
512512

@@ -516,7 +516,7 @@ Use this parameter to convert from a wide variety of other character encodings,
516516
- `UHC` (Unified Hangul Code): (Aliases: `CP949` and `Windows-949`)
517517
- `Big5`: (Alias: `CP950`)
518518

519-
### Windows (ANSI) Encodings
519+
### Windows (ANSI) encodings
520520

521521
- `Win1250` (Central European): (Alias: `CP1250`)
522522
- `Win1251` (Cyrillic): (Alias: `CP1251`)
@@ -526,12 +526,12 @@ Use this parameter to convert from a wide variety of other character encodings,
526526
- `Win1255` (Hebrew): (Alias: `CP1255`)
527527
- `Win1256` (Arabic): (Alias: `CP1256`)
528528

529-
### DOS (OEM) Encodings
529+
### DOS (OEM) encodings
530530

531531
- `Win866` (Cyrillic - DOS): (Alias: `CP866`)
532532
- `Win874` (Thai): (Alias: `CP874`)
533533

534-
### Configuration Example
534+
### Configuration example
535535

536536
Here is an example of how to use `Generic.Encoding` with the Tail input plugin to read a log file encoded in ShiftJIS.
537537

0 commit comments

Comments
 (0)