Skip to content

Commit af8090c

Browse files
Apply suggestions from code review
Co-authored-by: Adam Locke <[email protected]> Signed-off-by: esmerel <[email protected]>
1 parent 36cee9d commit af8090c

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

administration/troubleshooting.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ $ docker run --rm -ti fluent/fluent-bit:latest --help | grep trace
2424
```
2525

2626
If the `--enable-chunk-trace` option is present, your Fluent Bit version supports
27-
Fluent Bit Tap but it's disabled by default. Use this option to enable it.
27+
Fluent Bit Tap, but it's disabled by default. Use this option to enable it.
2828

2929
You can start Fluent Bit with tracing activated from the beginning by using the
3030
`trace-input` and `trace-output` properties:
@@ -127,11 +127,11 @@ All three options can also be defined using the more flexible `--trace` option:
127127
fluent-bit -Z -i dummy -o stdout -f 1 --trace="input=dummy.0 output=stdout output.format=json_lines"
128128
```
129129

130-
This example defines the tap pipeline using this configuration: `input=dummy.0 output=stdout output.format=json_lines` which defines the following:
130+
This example defines the Tap pipeline using this configuration: `input=dummy.0 output=stdout output.format=json_lines` which defines the following:
131131

132-
- `input`: `dummy.0` - listens to the tag or alias `dummy.0`
133-
- `output`: `stdout` - outputs to a stdout plugin
134-
- `output.format`: `json_lines` - sets the stdout format to `json_lines`
132+
- `input`: `dummy.0` listens to the tag or alias `dummy.0`.
133+
- `output`: `stdout` outputs to a stdout plugin.
134+
- `output.format`: `json_lines` sets the stdout format to `json_lines`.
135135

136136
Tap support can also be activated and deactivated using the embedded web server:
137137

@@ -263,8 +263,8 @@ When activating Tap, any plugin parameter can be given. These parameters can be
263263
to modify the output format, the name of the time key, the format of the date, and
264264
other details.
265265

266-
The following example uses the parameter ```"format": "json"``` to demonstrate how
267-
to show `stdout` in `JSON` format.
266+
The following example uses the parameter `"format": "json"` to demonstrate how
267+
to show `stdout` in JSON format.
268268

269269
First, run Fluent Bit enabling Tap:
270270

@@ -338,7 +338,7 @@ This filter record is an example to explain the details of a Tap record:
338338

339339
- `type`: Defines the stage the event is generated:
340340
- `1`: Input record. This is the unadulterated input record.
341-
- `2`: Filtered record. This is a record once it has been filtered. One record is
341+
- `2`: Filtered record. This is a record after it was filtered. One record is
342342
generated per filter.
343343
- `3`: Pre-output record. This is the record right before it's sent for output.
344344

@@ -380,7 +380,7 @@ Run the following `kill` command to signal Fluent Bit:
380380
kill -CONT `pidof fluent-bit`
381381
```
382382

383-
The command `pidof` aims to lookup the Process ID of Fluent Bit.
383+
The command `pidof` aims to identify the Process ID of Fluent Bit.
384384

385385
Fluent Bit will dump the following information to the standard output interface
386386
(`stdout`):
@@ -444,9 +444,9 @@ The Task dump describes the tasks associated to the input plugin:
444444
| Entry | Description |
445445
| :--- | :--- |
446446
| `total_tasks` | Total number of active tasks associated to data generated by the input plugin. |
447-
| `new` | Number of tasks not assigned yet to an output plugin. Tasks are in `new` status for a very short period of time. This value is normally very low or zero. |
447+
| `new` | Number of tasks not yet assigned to an output plugin. Tasks are in `new` status for a very short period of time. This value is normally very low or zero. |
448448
| `running` | Number of active tasks being processed by output plugins. |
449-
| `size` | Amount of memory used by the Chunks being processed (Total chunks size). |
449+
| `size` | Amount of memory used by the Chunks being processed (total chunk size). |
450450

451451
### Chunks
452452

0 commit comments

Comments
 (0)