Skip to content

Commit 3d5f5f7

Browse files
eschabelleschabell
committed
Added blog input plugin doc and added to summary file to list in docs site. Fixes #2135.
Signed-off-by: Eric D. Schabell <[email protected]>
1 parent c5bd499 commit 3d5f5f7

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

‎SUMMARY.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@
8484
## Data pipeline
8585

8686
* [Inputs](pipeline/inputs.md)
87+
* [Blob](pipeline/inputs/blob.md)
8788
* [Collectd](pipeline/inputs/collectd.md)
8889
* [CPU metrics](pipeline/inputs/cpu-metrics.md)
8990
* [Disk I/O metrics](pipeline/inputs/disk-io-metrics.md)

‎pipeline/inputs/blob.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Blob
2+
3+
The _Blob_ input plugin accepts blob (binary) files.
4+
5+
## Configuration parameters
6+
7+
The plugin supports the following configuration parameters:
8+
9+
| Key | Description | Default |
10+
|:------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------|
11+
| `alias` | Sets an alias, useful for multiple instances of the same output plugin. | _none_ |
12+
| `database_file` | Database file. | _none_ |
13+
| `exclude_pattern` | Pattern to exclude. | _none_ |
14+
| `log_level` | Specifies the log level for output plugin. If not set here, plugin uses global log level in `service` section. | `info` |
15+
| `log_supress_interval` | Suppresses log messages from output plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
16+
| `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. Note that if the plugin has enabled filesystem buffering, this limit will not apply. | `0` |
17+
| `path` | Path to scan for blob (binary) files. | _none_ |
18+
| `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` |
19+
| `scan_refresh_interval` | Set the interval time to scan for new files. | `2s` |
20+
| `storage.pause_on_chunks_overlimit` | Enable pausing on an input when they reach their chunks limit. | `false` |
21+
| `storage.type` | Sets the storage type for this input, one of `filesystem`, `memory` or `memrb`. | `memory` |
22+
| `tag` | Set a tag for the events generated by this input plugin. | _none_ |
23+
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
24+
| | | |
25+
| `threaded.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. | `1024` |
26+
| `threaded.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. | `5` |
27+
| `upload_success_action` | Field is string for action on success. | _none_ |
28+
| `upload_success_suffix` | Field is string for suffix on success. | _none_ |
29+
| `upload_success_message` | Field is string for message on success. | _none_ |
30+
| `upload_failure_action` | Field is string for action on failure. | _none_ |
31+
| `upload_failure_suffix` | Field is string for suffix on failure. | _none_ |
32+
| `upload_failure_message` | Field is string for message on failure. | _none_ |
33+
34+
## Get started
35+
36+
You can run the plugin from the command line or through the configuration file:
37+
38+
### Command line
39+
40+
Run the plugin from the command line using the following command:
41+
42+
```shell
43+
fluent-bit -i blob --prop "path=[SOME_PATH_TO_BINARY_FILES]" -o stdout
44+
```
45+
46+
which returns results like the following:
47+
48+
```text
49+
...
50+
[2025/11/05 17:39:32.818356000] [ info] [input:blob:blob.0] initializing
51+
[2025/11/05 17:39:32.818362000] [ info] [input:blob:blob.0] storage_strategy='memory' (memory only)
52+
...
53+
```
54+
55+
### Configuration file
56+
57+
In your main configuration file append the following:
58+
59+
{% tabs %}
60+
{% tab title="fluent-bit.yaml" %}
61+
62+
```yaml
63+
pipeline:
64+
inputs:
65+
- name: blob
66+
path: '[PATH_TO_BINARY_FILES]'
67+
68+
outputs:
69+
- name: stdout
70+
match: '*'
71+
```
72+
73+
{% endtab %}
74+
{% endtabs %}

0 commit comments

Comments
 (0)