Skip to content

Added blob input plugin doc and added to summary file to list in docs site. Fixes #2135. #2146

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

Merged
merged 3 commits into from
Nov 6, 2025
+75 −0
Merged

Added blob input plugin doc and added to summary file to list in docs site. Fixes #2135. #2146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d5f5f7
Added blog input plugin doc and added to summary file to list in docs…
eschabell Nov 5, 2025
dc0ef52
Fixed lint issues. Part of issue #2135.
eschabell Nov 5, 2025
a01900b
Fixed lint issues. Part of issue #2135.
eschabell Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
## Data pipeline

* [Inputs](pipeline/inputs.md)
* [Blob](pipeline/inputs/blob.md)
* [Collectd](pipeline/inputs/collectd.md)
* [CPU metrics](pipeline/inputs/cpu-metrics.md)
* [Disk I/O metrics](pipeline/inputs/disk-io-metrics.md)
Expand Down
74 changes: 74 additions & 0 deletions pipeline/inputs/blob.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Blob

The _Blob_ input plugin accepts blob (binary) files.

## Configuration parameters

The plugin supports the following configuration parameters:

| Key | Description | Default |
|:------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------|
| `alias` | Sets an alias for multiple instances of the same output plugin. | _none_ |
| `database_file` | Database file. | _none_ |
| `exclude_pattern` | Pattern to exclude. | _none_ |
| `log_level` | Specifies the log level for output plugin. If not set here, plugin uses global log level in `service` section. | `info` |
| `log_supress_interval` | Suppresses log messages from output plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
| `mem_buf_limit` | Set a memory buffer limit for the input plugin instance in bytes. If the limit is reached, the plugin will pause until the buffer is drained. If set to 0, the buffer limit is disabled. If the plugin has enabled filesystem buffering, this limit won't apply. | `0` |
| `path` | Path to scan for blob (binary) files. | _none_ |
| `routable` | If `true`, the data generated by the plugin can be forwarded to other plugins or outputs. If `false`, the data will be discarded. | `true` |
| `scan_refresh_interval` | Set the interval time to scan for new files. | `2s` |
| `storage.pause_on_chunks_overlimit` | Enable pausing on an input when they reach their chunks limit. | `false` |
| `storage.type` | Sets the storage type for this input, one of `filesystem`, `memory` or `memrb`. | `memory` |
| `tag` | Set a tag for the events generated by this input plugin. | _none_ |
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
| | | |
| `threaded.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. | `1024` |
| `threaded.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. | `5` |
| `upload_success_action` | Field is string for action on success. | _none_ |
| `upload_success_suffix` | Field is string for suffix on success. | _none_ |
| `upload_success_message` | Field is string for message on success. | _none_ |
| `upload_failure_action` | Field is string for action on failure. | _none_ |
| `upload_failure_suffix` | Field is string for suffix on failure. | _none_ |
| `upload_failure_message` | Field is string for message on failure. | _none_ |

## Get started

You can run the plugin from the command line or through the configuration file:

### Command line

Run the plugin from the command line using the following command:

```shell
fluent-bit -i blob --prop "path=[SOME_PATH_TO_BINARY_FILES]" -o stdout
```

which returns results like the following:

```text
...
[2025/11/05 17:39:32.818356000] [ info] [input:blob:blob.0] initializing
[2025/11/05 17:39:32.818362000] [ info] [input:blob:blob.0] storage_strategy='memory' (memory only)
...
```

### Configuration file

In your main configuration file append the following:

{% tabs %}
{% tab title="fluent-bit.yaml" %}

```yaml
pipeline:
inputs:
- name: blob
path: '[PATH_TO_BINARY_FILES]'

outputs:
- name: stdout
match: '*'
```

{% endtab %}
{% endtabs %}