Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix typos #1311

Merged
merged 2 commits into from
May 23, 2024
Merged

fix typos #1311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1bfb8b8
typo fix
stratusjerry Feb 21, 2024
326015d
Update administration/backpressure.md
cnorris-cs May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion administration/backpressure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
See the [Buffering & Storage](buffering-and-storage.md) docs for more information.

## About pause and resume Callbacks

Expand Down
20 changes: 10 additions & 10 deletions administration/monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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`.
Expand Down
4 changes: 2 additions & 2 deletions development/wasm-filter-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion installation/linux/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion pipeline/outputs/splunk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion pipeline/outputs/stackdriver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions pipeline/outputs/websocket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down