From 1bfb8b806493f7ce0a21d8d58ba591d1be1ee50f Mon Sep 17 00:00:00 2001 From: Jerry Jones <28451941+stratusjerry@users.noreply.github.com> Date: Wed, 21 Feb 2024 23:56:06 +0000 Subject: [PATCH 1/2] typo fix Signed-off-by: Jerry Jones <28451941+stratusjerry@users.noreply.github.com> --- administration/backpressure.md | 2 +- administration/monitoring.md | 20 ++++++++++---------- development/wasm-filter-plugins.md | 4 ++-- installation/linux/README.md | 2 +- pipeline/outputs/splunk.md | 2 +- pipeline/outputs/stackdriver.md | 2 +- pipeline/outputs/websocket.md | 4 ++-- 7 files changed, 18 insertions(+), 18 deletions(-) diff --git a/administration/backpressure.md b/administration/backpressure.md index 14759f256..68dc5a803 100644 --- a/administration/backpressure.md +++ b/administration/backpressure.md @@ -44,7 +44,7 @@ The setting behaves similarly to the above scenario with `Mem_Buf_Limit` when th When (default) `storage.pause_on_chunks_overlimit` is disabled, the input will not pause when the memory limit is reached. Instead, it will switch to only buffering logs in the filesystem. The disk spaced used for filesystem buffering can be limited with `storage.total_limit_size`. -Please consule the [Buffering & Storage](buffering-and-storage.md) docs for more information. +Please consult the [Buffering & Storage](buffering-and-storage.md) docs for more information. ## About pause and resume Callbacks diff --git a/administration/monitoring.md b/administration/monitoring.md index 59ea80531..0d6fae6dc 100644 --- a/administration/monitoring.md +++ b/administration/monitoring.md @@ -78,7 +78,7 @@ $ curl -s http://127.0.0.1:2020 | jq } ``` -Note that we are sending the _curl_ command output to the _jq_ program which helps to make the JSON data easy to read from the terminal. Fluent Bit don't aim to do JSON pretty-printing. +Note that we are sending the _curl_ command output to the _jq_ program which helps to make the JSON data easy to read from the terminal. Fluent Bit doesn't aim to do JSON pretty-printing. ### REST API Interface @@ -110,15 +110,15 @@ The following definitions are key to understand: |----------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---------| | fluentbit_input_bytes_total | name: the name or alias for the input instance | The number of bytes of log records that this input instance has successfully ingested | counter | bytes | | fluentbit_input_records_total | name: the name or alias for the input instance | The number of log records this input has successfully ingested | counter | records | -| 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 | -| 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 | -| 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 | -| 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 | -| 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 | -| 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 | -| 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 | -| fluentbit_uptime | | The number of seconds that Fluent Bit has been running. | counter | seconds | -| process_start_time_seconds | | The Unix Epoch time stamp for when Fluent Bit started.. | guage | seconds | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| fluentbit_uptime | | The number of seconds that Fluent Bit has been running. | counter | seconds | +| process_start_time_seconds | | The Unix Epoch time stamp for when Fluent Bit started. | gauge | seconds | The following are detailed descriptions for the metrics outputted in JSON format by `/api/v1/storage`. diff --git a/development/wasm-filter-plugins.md b/development/wasm-filter-plugins.md index b47207a1d..e8cfb376e 100644 --- a/development/wasm-filter-plugins.md +++ b/development/wasm-filter-plugins.md @@ -170,8 +170,8 @@ These examples can be applied in our demo and can serve as an ideal starting poi ### Optimize execution of WASM programs To optimize WASM program execution, there is the option of using `flb-wamrc`. -`flb-wamrc` will reduce runtime footprint and to be best perforemance for filtering operations. -This tool will be built when `-DFLB_WAMRC=On` cmake option is specififed and llvm infrastructure is installed on the building box. +`flb-wamrc` will reduce runtime footprint and to be best performance for filtering operations. +This tool will be built when `-DFLB_WAMRC=On` cmake option is specified and llvm infrastructure is installed on the building box. ```shell $ flb-wamrc -o /path/to/built_wasm.aot /path/to/built_wasm.wasm diff --git a/installation/linux/README.md b/installation/linux/README.md index cb006ff0a..d84f58865 100644 --- a/installation/linux/README.md +++ b/installation/linux/README.md @@ -1,6 +1,6 @@ # Linux Packages -The most secure option is to create the repositories acccording to the instructions for your specific OS. +The most secure option is to create the repositories according to the instructions for your specific OS. A simple installation script is provided to be used for most Linux targets. This will by default install the most recent version released. diff --git a/pipeline/outputs/splunk.md b/pipeline/outputs/splunk.md index 6b18babec..f038909fc 100644 --- a/pipeline/outputs/splunk.md +++ b/pipeline/outputs/splunk.md @@ -125,7 +125,7 @@ This will create a payload that looks like: } ``` -For more information on the Splunk HEC payload format and all event meatadata Splunk accepts, see here: [http://docs.splunk.com/Documentation/Splunk/latest/Data/AboutHEC](http://docs.splunk.com/Documentation/Splunk/latest/Data/AboutHEC) +For more information on the Splunk HEC payload format and all event metadata Splunk accepts, see here: [http://docs.splunk.com/Documentation/Splunk/latest/Data/AboutHEC](http://docs.splunk.com/Documentation/Splunk/latest/Data/AboutHEC) ### Sending Raw Events diff --git a/pipeline/outputs/stackdriver.md b/pipeline/outputs/stackdriver.md index 8c32256f5..1ab85dd6f 100644 --- a/pipeline/outputs/stackdriver.md +++ b/pipeline/outputs/stackdriver.md @@ -188,7 +188,7 @@ Do following check: > Github reference: [#7552](https://github.com/fluent/fluent-bit/issues/7552) -When the number of Workers is greater than 1, Fluent Bit may interimittently crash. +When the number of Workers is greater than 1, Fluent Bit may intermittently crash. ## Other implementations diff --git a/pipeline/outputs/websocket.md b/pipeline/outputs/websocket.md index 8aa28916c..d4c17003f 100644 --- a/pipeline/outputs/websocket.md +++ b/pipeline/outputs/websocket.md @@ -6,8 +6,8 @@ The **websocket** output plugin allows to flush your records into a WebSocket en | Key | Description | default | | :--- | :--- | :--- | -| Host | IP address or hostname of the target WebScoket Server | 127.0.0.1 | -| Port | TCP port of the target WebScoket Server | 80 | +| Host | IP address or hostname of the target WebSocket Server | 127.0.0.1 | +| Port | TCP port of the target WebSocket Server | 80 | | URI | Specify an optional HTTP URI for the target websocket server, e.g: /something | / | | Format | Specify the data format to be used in the HTTP request body, by default it uses _msgpack_. Other supported formats are _json_, _json\_stream_ and _json\_lines_ and _gelf_. | msgpack | | json\_date\_key | Specify the name of the date field in output | date | From 326015d358068b7755eeeeb8dc455f6d86279f28 Mon Sep 17 00:00:00 2001 From: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> Date: Thu, 23 May 2024 11:41:20 -0400 Subject: [PATCH 2/2] Update administration/backpressure.md Signed-off-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> --- administration/backpressure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/administration/backpressure.md b/administration/backpressure.md index 68dc5a803..e8f3f9b5c 100644 --- a/administration/backpressure.md +++ b/administration/backpressure.md @@ -44,7 +44,7 @@ The setting behaves similarly to the above scenario with `Mem_Buf_Limit` when th When (default) `storage.pause_on_chunks_overlimit` is disabled, the input will not pause when the memory limit is reached. Instead, it will switch to only buffering logs in the filesystem. The disk spaced used for filesystem buffering can be limited with `storage.total_limit_size`. -Please consult the [Buffering & Storage](buffering-and-storage.md) docs for more information. +See the [Buffering & Storage](buffering-and-storage.md) docs for more information. ## About pause and resume Callbacks