Skip to content

Commit 659d629

Browse files
eschabelleschabell
authored
Fixes for new documentation of Blob input plugin configuration options and updated code examples. (#2201)
* Updated to include new input plugin doc for Windows System Statistics. Applies to #2139. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Updated to include new input plugin doc for Windows System Statistics. Applies to #2139. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Lint fix for winstat input plugin doc fix. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Fixes for new documentation of Blob input plugin configuration options and updated code examples. Signed-off-by: Eric D. Schabell <eric@schabell.org> --------- Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent ab2ed93 commit 659d629

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

‎pipeline/inputs/blob.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ The plugin supports the following configuration parameters:
2323
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). When enabled, the plugin runs in a separate thread, which can improve performance for I/O-bound operations. | `false` |
2424
| `threaded.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. This determines how many records can be buffered in the ring buffer before blocking. | `1024` |
2525
| `threaded.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. This controls when the ring buffer is considered "full" and triggers backpressure handling. | `5` |
26-
| `upload_success_action` | Action to perform on the file after successful processing. Supported values: `delete` (delete the file), `move` (move the file), `none` (no action). When set to `move`, use `upload_success_suffix` to specify the destination. | _none_ |
27-
| `upload_success_suffix` | Suffix to append to the filename when moving a file after successful processing. Only used when `upload_success_action` is set to `move`. For example, if set to `.processed`, a file named `data.bin` will be moved to `data.bin.processed`. | _none_ |
28-
| `upload_success_message` | Custom message to include in the log when a file is successfully processed. This can be used for debugging or monitoring purposes. | _none_ |
29-
| `upload_failure_action` | Action to perform on the file after processing failure. Supported values: `delete` (delete the file), `move` (move the file), `none` (no action). When set to `move`, use `upload_failure_suffix` to specify the destination. | _none_ |
30-
| `upload_failure_suffix` | Suffix to append to the filename when moving a file after processing failure. Only used when `upload_failure_action` is set to `move`. For example, if set to `.failed`, a file named `data.bin` will be moved to `data.bin.failed` if processing fails. | _none_ |
31-
| `upload_failure_message` | Custom message to include in the log when file processing fails. This can be used for debugging or monitoring purposes. | _none_ |
26+
| `upload_success_action` | Action to perform on the file after successful upload. Supported values: `delete` (delete the file), `add_suffix` (rename file by appending a suffix), `emit_log` (emit a log record with a custom message). When set to `add_suffix`, use `upload_success_suffix` to specify the suffix. When set to `emit_log`, use `upload_success_message` to specify the message. | _none_ |
27+
| `upload_success_suffix` | Suffix to append to the filename after successful upload. Only used when `upload_success_action` is set to `add_suffix`. For example, if set to `.processed`, a file named `data.bin` will be renamed to `data.bin.processed`. | _none_ |
28+
| `upload_success_message` | Message to emit as a log record after successful upload. Only used when `upload_success_action` is set to `emit_log`. This can be used for debugging or monitoring purposes. | _none_ |
29+
| `upload_failure_action` | Action to perform on the file after upload failure. Supported values: `delete` (delete the file), `add_suffix` (rename file by appending a suffix), `emit_log` (emit a log record with a custom message). When set to `add_suffix`, use `upload_failure_suffix` to specify the suffix. When set to `emit_log`, use `upload_failure_message` to specify the message. | _none_ |
30+
| `upload_failure_suffix` | Suffix to append to the filename after upload failure. Only used when `upload_failure_action` is set to `add_suffix`. For example, if set to `.failed`, a file named `data.bin` will be renamed to `data.bin.failed`. | _none_ |
31+
| `upload_failure_message` | Message to emit as a log record after upload failure. Only used when `upload_failure_action` is set to `emit_log`. This can be used for debugging or monitoring purposes. | _none_ |
3232

3333
## How it works
3434

@@ -206,9 +206,9 @@ pipeline:
206206
{% endtab %}
207207
{% endtabs %}
208208

209-
### Configuration with file actions after processing
209+
### Configuration with file actions after upload
210210

211-
This example moves files after successful processing and handles failures:
211+
This example renames files after successful upload and handles failures:
212212

213213
{% tabs %}
214214
{% tab title="fluent-bit.yaml" %}
@@ -219,9 +219,9 @@ pipeline:
219219
- name: blob
220220
path: /var/log/binaries/*.bin
221221
database_file: /var/lib/fluent-bit/blob.db
222-
upload_success_action: move
222+
upload_success_action: add_suffix
223223
upload_success_suffix: .processed
224-
upload_failure_action: move
224+
upload_failure_action: add_suffix
225225
upload_failure_suffix: .failed
226226
tag: blob.data
227227

@@ -238,9 +238,9 @@ pipeline:
238238
Name blob
239239
Path /var/log/binaries/*.bin
240240
Database_File /var/lib/fluent-bit/blob.db
241-
Upload_Success_Action move
241+
Upload_Success_Action add_suffix
242242
Upload_Success_Suffix .processed
243-
Upload_Failure_Action move
243+
Upload_Failure_Action add_suffix
244244
Upload_Failure_Suffix .failed
245245
Tag blob.data
246246

0 commit comments

Comments
 (0)