Skip to content

Commit 9dec436

Browse files
elenacbcelenacbc
authoredSep 29, 2022
Typo correction (fluent#912)
* concepts: buffering: typo corrected Signed-off-by: elenacbc <[email protected]> * administration: configuring-fluent-bit: classic-mode: configuration-file.md: grammar correction Signed-off-by: elenacbc <[email protected]> * administration: configuring-fluent-bit: yaml: configuration-file.md: grammar correction Signed-off-by: elenacbc <[email protected]> * administration: configuring-fluent-bit: multiline-parsing: grammar correction Signed-off-by: elenacbc <[email protected]> * administration: monitoring.md: grammar correction Signed-off-by: elenacbc <[email protected]> * concepts: buffering.md: grammar correction Signed-off-by: elenacbc <[email protected]> * administration: scheduling-and-retries.md: grammar correction Signed-off-by: elenacbc <[email protected]> * installation: getting-started-with-fluent-bit.md: grammar correction Signed-off-by: elenacbc <[email protected]> * installation: macos.md: grammar correction Signed-off-by: elenacbc <[email protected]> * installation: sources: build-and-install: grammar correction Signed-off-by: elenacbc <[email protected]> * pipeline: inputs: cpu-metrics.md: grammar correction Signed-off-by: elenacbc <[email protected]> * pipeline: inputs: prometheus-scrape-metrics.md: grammar correction Signed-off-by: elenacbc <[email protected]> * pipeline: inputs: windows-event-log-winevtlog.md: grammar correction Signed-off-by: elenacbc <[email protected]> * pipeline: outputs: observe.md: grammar correction Signed-off-by: elenacbc <[email protected]> * pipeline: outputs: websocket.md: grammar correction Signed-off-by: elenacbc <[email protected]> Signed-off-by: elenacbc <[email protected]>
1 parent abc27ed commit 9dec436

14 files changed

+15
-15
lines changed
 

‎administration/configuring-fluent-bit/classic-mode/configuration-file.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The _Service_ section defines global properties of the service, the keys availab
2626
| flush | Set the flush time in `seconds.nanoseconds`. The engine loop uses a Flush timeout to define when is required to flush the records ingested by input plugins through the defined output plugins. | 5 |
2727
| grace | Set the grace time in `seconds` as Integer value. The engine loop uses a Grace timeout to define wait time on exit | 5 |
2828
| daemon | Boolean value to set if Fluent Bit should run as a Daemon (background) or not. Allowed values are: yes, no, on and off. note: If you are using a Systemd based unit as the one we provide in our packages, do not turn on this option. | Off |
29-
| dns.mode | Set the primary transport layer protocol used by the asynchronous DNS resolver which can be overriden on a per plugin basis | UDP |
29+
| dns.mode | Set the primary transport layer protocol used by the asynchronous DNS resolver which can be overridden on a per plugin basis | UDP |
3030
| log_file | Absolute path for an optional log file. By default all logs are redirected to the standard error interface (stderr). | |
3131
| log_level | Set the logging verbosity level. Allowed values are: off, error, warn, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, warning, info and debug. Note that _trace_ mode is only available if Fluent Bit was built with the _WITH\_TRACE_ option enabled. | info |
3232
| parsers_file | Path for a `parsers` configuration file. Multiple Parsers_File entries can be defined within the section. | |

‎administration/configuring-fluent-bit/multiline-parsing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ rule "start_state" "/(Dec \d+ \d+\:\d+\:\d+)(.*)/" "cont"
6868
rule "cont" "/^\s+at.*/" "cont"
6969
```
7070

71-
In the example above, we have defined two rules, each one has its own state name, regex paterns, and the next state name. Every field that composes a rule **must be** inside double quotes.
71+
In the example above, we have defined two rules, each one has its own state name, regex patterns, and the next state name. Every field that composes a rule **must be** inside double quotes.
7272

7373
The first rule of state name **must always** be **start_state**, and the regex pattern **must** match the first line of a multiline message, also a next state must be set to specify how the possible continuation lines would look like.
7474

‎administration/configuring-fluent-bit/yaml/configuration-file.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The _service_ section defines global properties of the service, the keys availab
4242
| flush | Set the flush time in `seconds.nanoseconds`. The engine loop uses a Flush timeout to define when is required to flush the records ingested by input plugins through the defined output plugins. | 5 |
4343
| grace | Set the grace time in `seconds` as Integer value. The engine loop uses a Grace timeout to define wait time on exit | 5 |
4444
| daemon | Boolean value to set if Fluent Bit should run as a Daemon (background) or not. Allowed values are: yes, no, on and off. note: If you are using a Systemd based unit as the one we provide in our packages, do not turn on this option. | Off |
45-
| dns.mode | Set the primary transport layer protocol used by the asynchronous DNS resolver which can be overriden on a per plugin basis | UDP |
45+
| dns.mode | Set the primary transport layer protocol used by the asynchronous DNS resolver which can be overridden on a per plugin basis | UDP |
4646
| log_file | Absolute path for an optional log file. By default all logs are redirected to the standard error interface (stderr). | |
4747
| log_level | Set the logging verbosity level. Allowed values are: off, error, warn, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, warning, info and debug. Note that _trace_ mode is only available if Fluent Bit was built with the _WITH\_TRACE_ option enabled. | info |
4848
| parsers_file | Path for a `parsers` configuration file. Multiple Parsers_File entries can be defined within the section. | |

‎administration/monitoring.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,11 @@ The following definitions are key to understand:
108108
| fluentbit_output_dropped_records_total | name: the name or alias for the output instance | The number of log records that have been dropped by the output. This means they met an unrecoverable error or retries expired for their chunk. | counter | records |
109109
| fluentbit_output_errors_total | name: the name or alias for the output instance | The number of chunks that have faced an error (either unrecoverable or retriable). This is the number of times a chunk has failed, and does not correspond with the number of error messages you see in the Fluent Bit log output. | counter | chunks |
110110
| fluentbit_output_proc_bytes_total | name: the name or alias for the output instance | The number of bytes of log records that this output instance has *successfully* sent. This is the total byte size of all unique chunks sent by this output. If a record is not sent due to some error, then it will not count towards this metric. | counter | bytes |
111-
| fluentbit_output_proc_records_total | name: the name or alias for the output instance | The number of log records that this output instance has *successfully* sent. This is the total record count of all unique chunks sent by this output. If a record is not succesfully sent, it does not count towards this metric. | counter | records |
111+
| fluentbit_output_proc_records_total | name: the name or alias for the output instance | The number of log records that this output instance has *successfully* sent. This is the total record count of all unique chunks sent by this output. If a record is not successfully sent, it does not count towards this metric. | counter | records |
112112
| fluentbit_output_retried_records_total | name: the name or alias for the output instance | The number of log records that experienced a retry. Note that this is calculated at the chunk level, the count increased when an entire chunk is marked for retry. An output plugin may or may not perform multiple actions that generate many error messages when uploading a single chunk. | counter | records |
113113
| fluentbit_output_retries_failed_total | name: the name or alias for the output instance | The number of times that retries expired for a chunk. Each plugin configures a Retry_Limit which applies to chunks. Once the Retry_Limit has been reached for a chunk it is discarded and this metric is incremented. | counter | chunks |
114114
| fluentbit_output_retries_total | name: the name or alias for the output instance | The number of times this output instance requested a retry for a chunk. | counter | chunks |
115-
| fluentbit_uptime | | The number of seconds that Fluent Bit has been runnning. | counter | seconds |
115+
| fluentbit_uptime | | The number of seconds that Fluent Bit has been running. | counter | seconds |
116116
| process_start_time_seconds | | The Unix Epoch time stamp for when Fluent Bit started.. | guage | seconds |
117117

118118

‎administration/scheduling-and-retries.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The Scheduler provides a simple configuration option called **Retry\_Limit** whi
1818
| :--- | :--- | :--- |
1919
| Retry\_Limit | N | Integer value to set the maximum number of retries allowed. N must be &gt;= 1 \(default: 1\) |
2020
| Retry\_Limit | `no_limits` or `False` | When Retry\_Limit is set to `no_limits` or`False`, means that there is not limit for the number of retries that the Scheduler can do. |
21-
| Retry\_Limit | no\_retries | When Retry\_Limit is set to no\_retries, means that reries are disabled and Scheduler would not try to send data to the destination if it failed the first time. |
21+
| Retry\_Limit | no\_retries | When Retry\_Limit is set to no\_retries, means that retries are disabled and Scheduler would not try to send data to the destination if it failed the first time. |
2222

2323
### Example
2424

‎concepts/buffering.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Network failures or latency on third party service is pretty common, and on scen
1414
Our buffering strategies are designed to solve problems associated with backpressure and general delivery failures.
1515
{% endhint %}
1616

17-
Fluent Bit as buffering strategies go, offers a primary buffering mechanism in **memory** and an optional secondary one using the **file system**. With this hybrid solution you can accomodate any use case safely and keep a high performance while processing your data.
17+
Fluent Bit as buffering strategies go, offers a primary buffering mechanism in **memory** and an optional secondary one using the **file system**. With this hybrid solution you can accommodate any use case safely and keep a high performance while processing your data.
1818

1919
Both mechanisms are not mutually exclusive and when the data is ready to be processed or delivered it will always be **in memory**, while other data in the queue might be in the file system until is ready to be processed and moved up to memory.
2020

‎installation/getting-started-with-fluent-bit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ description: The following serves as a guide on how to install/deploy/upgrade Fl
2020
| Ubuntu | [Ubuntu 16.04 LTS](linux/ubuntu.md#ubuntu-16-04-lts-xenial-xerus), [Ubuntu 18.04 LTS](linux/ubuntu.md#ubuntu-18-04-lts-bionic-beaver), [Ubuntu 20.04 LTS](linux/ubuntu.md#ubuntu-20-04-lts-focal-fossa) |
2121
| Debian | [Debian 9](linux/debian.md#debian-9-stretch), [Debian 10](linux/debian.md#debian-10-buster) |
2222
| Amazon Linux | [Amazon Linux 2](linux/amazon-linux.md#install-on-amazon-linux-2) |
23-
| Raspbian / Rasberry Pi | [Raspbian 10](linux/raspbian-raspberry-pi.md#raspbian-10-buster) |
23+
| Raspbian / Raspberry Pi | [Raspbian 10](linux/raspbian-raspberry-pi.md#raspbian-10-buster) |
2424
| Yocto / Embedded Linux | [Yocto / Embedded Linux](yocto-embedded-linux.md#fluent-bit-and-other-architectures) |
2525

2626
## Install on Windows (Packages)

‎installation/macos.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ export OPENSSL_ROOT_DIR=`brew --prefix openssl`
8383
export PATH=`brew --prefix bison`/bin:$PATH
8484
```
8585

86-
And then, creating the specific macOS SDK target (For example, sepcifying macOS Big Sur (11.3) SDK environment):
86+
And then, creating the specific macOS SDK target (For example, specifying macOS Big Sur (11.3) SDK environment):
8787

8888
```bash
8989
export MACOSX_DEPLOYMENT_TARGET=11.3

‎installation/sources/build-and-install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Build and Install
22

3-
[Fluent Bit](http://fluentbit.io) uses [CMake](http://cmake.org) as it build system. The suggested procedure to prepare the build system consists of the following steps:
3+
[Fluent Bit](http://fluentbit.io) uses [CMake](http://cmake.org) as its build system. The suggested procedure to prepare the build system consists of the following steps:
44

55
## Requirements
66

‎pipeline/inputs/cpu-metrics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The CPU metrics plugin creates metrics that are log-based \(I.e. JSON payload\).
88

99
| key | description |
1010
| :--- | :--- |
11-
| cpu\_p | CPU usage of the overall system, this value is the summatory of time spent on user and kernel space. The result takes in consideration the numbers of CPU cores in the system. |
11+
| cpu\_p | CPU usage of the overall system, this value is the summation of time spent on user and kernel space. The result takes in consideration the numbers of CPU cores in the system. |
1212
| user\_p | CPU usage in User mode, for short it means the CPU usage by user space programs. The result of this value takes in consideration the numbers of CPU cores in the system. |
1313
| system\_p | CPU usage in Kernel mode, for short it means the CPU usage by the Kernel. The result of this value takes in consideration the numbers of CPU cores in the system. |
1414

‎pipeline/inputs/prometheus-scrape-metrics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The initial release of the Prometheus Scrape metric allows you to collect metric
99
| Key | Description | Default |
1010
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
1111
| host | The host of the prometheus metric endpoint that you want to scrape | |
12-
| port | The port of the promethes metric endpoint that you want to scrape | |
12+
| port | The port of the prometheus metric endpoint that you want to scrape | |
1313
| scrape\_interval | The interval to scrape metrics | 10s |
1414
| metrics\_path | <p>The metrics URI endpoint, that must start with a forward slash.<br><br>Note: Parameters can also be added to the path by using <code>?</code></p> | /metrics |
1515

‎pipeline/inputs/windows-event-log-winevtlog.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ If you want to do a quick test, you can run this plugin from the command line.
4747
$ fluent-bit -i winevtlog -p 'channels=Setup' -p 'Read_Existing_Events=true' -o stdout
4848
```
4949

50-
Note that `winevtlog` plugin will tail channles on each startup.
50+
Note that `winevtlog` plugin will tail channels on each startup.
5151
If you want to confirm whether this plugin is working or not, you should specify `-p 'Read_Existing_Events=true'` parameter.

‎pipeline/outputs/observe.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Observe employs the **http** output plugin, allowing you to flush your records [
44

55
For now the functionality is pretty basic and it issues a POST request with the data records in [MessagePack](http://msgpack.org) (or JSON) format.
66

7-
The following are the specfic HTTP parameters to employ:
7+
The following are the specific HTTP parameters to employ:
88

99
## Configuration Parameters
1010

‎pipeline/outputs/websocket.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ In your main configuration file, append the following _Input_ & _Output_ section
4949
Format json
5050
```
5151

52-
Websocket plugin is working with tcp keepalive mode, please refer to [networking](https://docs.fluentbit.io/manual/v/master/administration/networking#configuration-options) section for details. Since websocket is a stateful plugin, it will decide when to send out handshake to server side, for example when plugin just begins to work or after connection with server has been dropped. In general, the interval to init a new websocket handshake would be less than the keepalive interval. With that stratgy, it could detect and resume websocket connetions.
52+
Websocket plugin is working with tcp keepalive mode, please refer to [networking](https://docs.fluentbit.io/manual/v/master/administration/networking#configuration-options) section for details. Since websocket is a stateful plugin, it will decide when to send out handshake to server side, for example when plugin just begins to work or after connection with server has been dropped. In general, the interval to init a new websocket handshake would be less than the keepalive interval. With that strategy, it could detect and resume websocket connections.
5353

5454

5555
## Testing

0 commit comments

Comments
 (0)
Please sign in to comment.