You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-5Lines changed: 3 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ description: Next generation Log and Stream processor
8
8
9
9
[Fluent Bit](http://fluentbit.io) is a Fast and Lightweight Log Processor, Stream Processor and Forwarder for Linux, OSX, Windows and BSD family operating systems. It has been made with a strong focus on performance to allow the collection of events from different sources without complexity.
10
10
11
-
###Features
11
+
## Features
12
12
13
13
* High Performance
14
14
* Data Parsing
@@ -25,17 +25,15 @@ description: Next generation Log and Stream processor
25
25
* Write any input, filter or output plugin in C language
26
26
* Bonus: write [Filters in Lua](pipeline/filters/lua.md) or [Output plugins in Golang](development/golang-output-plugins.md)
27
27
*[Monitoring](administration/monitoring.md): expose internal metrics over HTTP in JSON and [Prometheus](https://prometheus.io/) format
28
-
*[Stream Processing](stream-processing/untitled.md): Perform data selection and transformation using simple SQL queries
28
+
*[Stream Processing](): Perform data selection and transformation using simple SQL queries
29
29
* Create new streams of data using query results
30
30
* Aggregation Windows
31
31
* Data analysis and prediction: Timeseries forecasting
32
32
* Portable: runs on Linux, MacOS, Windows and BSD systems
33
33
34
-
###Fluent Bit, Fluentd and CNCF
34
+
## Fluent Bit, Fluentd and CNCF
35
35
36
36
[Fluent Bit](http://fluentbit.io) is a sub-component of the [Fluentd](http://fluentd.org) project ecosystem, it's licensed under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0). This project was created by [Treasure Data](https://www.treasuredata.com) and is its current primary sponsor.
37
37
38
38
Nowadays Fluent Bit get contributions from several companies and individuals and same as [Fluentd](https://www.fluentd.org), it's hosted as a [CNCF](https://cncf.io) subproject.
Copy file name to clipboardExpand all lines: about/history.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Every project has a story
4
4
5
5
# A Brief History of Fluent Bit
6
6
7
-
On 2014, the [Fluentd](https://fluentd.org) team at [Treasure Data](https://www.treasuredata.com) forecasted the need of a lightweight log processor for constraint environments like Embedded Linux and Gateways, the project aimed to be part of the Fluentd Ecosystem and we called it [Fluent Bit](https://fluentbit.io), fully open source and available under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
7
+
On 2014, the [Fluentd](https://fluentd.org) team at [Treasure Data](https://www.treasuredata.com) forecasted the need of a lightweight log processor for constraint environments like Embedded Linux and Gateways, the project aimed to be part of the Fluentd Ecosystem and we called it [Fluent Bit](https://fluentbit.io), fully open source and available under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
8
8
9
9
After the project was around for some time, it got some traction in the Embedded market but we also started getting requests for several features from the Cloud community like more inputs, filters, and outputs. Not so long after that, Fluent Bit becomes one of the preferred solutions to solve the logging challenges in Cloud environments.
[Fluent Bit](http://fluentbit.io/) is an open source and multi-platform log processor tool which aims to be a generic Swiss knife for log processing and distribution.
3
+
[Fluent Bit](http://fluentbit.io/) is an open source and multi-platform log processor tool which aims to be a generic Swiss knife for log processing and distribution.
4
4
5
5
Nowadays the number of sources of information in our environments is ever increasing. Handling data collection at scale is complex, and collecting and aggregating diverse data requires a specialized tool that can deal with:
6
6
@@ -10,7 +10,5 @@ Nowadays the number of sources of information in our environments is ever increa
10
10
* Security
11
11
* Multiple destinations
12
12
13
-
[Fluent Bit](https://fluentbit.io) has been designed with performance and low resources consumption in mind.
14
-
15
-
13
+
[Fluent Bit](https://fluentbit.io) has been designed with performance and low resources consumption in mind.
Copy file name to clipboardExpand all lines: administration/backpressure.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -34,5 +34,5 @@ After some seconds if the scheduler was able to flush the initial 700KB of data
34
34
35
35
Each plugin is independent and not all of them implements the **pause** and **resume** callbacks. As said, these callbacks are just a notification mechanism for the plugin.
36
36
37
-
The plugin who implements and keep a good state is the [Tail Input](../input/tail.md) plugin. When the **pause** callback is triggered, it stop their collectors and stop appending data. Upon **resume**, it re-enable the collectors.
37
+
The plugin who implements and keep a good state is the [Tail Input](https://github.com/fluent/fluent-bit-docs/tree/b78cfe98123e74e165f2b6669229da009258f34e/input/tail.md) plugin. When the **pause** callback is triggered, it stop their collectors and stop appending data. Upon **resume**, it re-enable the collectors.
Copy file name to clipboardExpand all lines: administration/buffering-and-storage.md
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -1,32 +1,32 @@
1
-
# Fluent Bit and Buffering
1
+
# Buffering & Storage
2
2
3
3
The end-goal of [Fluent Bit](https://fluentbit.io) is to collect, parse, filter and ship logs to a central place. In this workflow there are many phases and one of the critical pieces is the ability to do _buffering_ : a mechanism to place processed data into a temporal location until is ready to be shipped.
4
4
5
-
By default when Fluent Bit process data, it uses Memory as a primary and temporal place to store the record logs, but there are certain scenarios where would be ideal to have a persistent buffering mechanism based in the filesystem to provide aggregation and data safety capabilities.
5
+
By default when Fluent Bit process data, it uses Memory as a primary and temporal place to store the record logs, but there are certain scenarios where would be ideal to have a persistent buffering mechanism based in the filesystem to provide aggregation and data safety capabilities.
6
6
7
7
Starting with Fluent Bit v1.0, we introduced a new _storage layer_ that can either work in memory or in the file system. Input plugins can be configured to use one or the other upon demand at start time.
8
8
9
9
## Configuration
10
10
11
11
The storage layer configuration takes place in two areas:
12
12
13
-
- Service Section
14
-
- Input Section
13
+
* Service Section
14
+
* Input Section
15
15
16
16
The known Service section configure a global environment for the storage layer, and then in the Input sections defines which mechanism to use.
| storage.path | Set an optional location in the file system to store streams and chunks of data. If this parameter is not set, Input plugins can only use in-memory buffering. ||
23
-
| storage.sync | Configure the synchronization mode used to store the data into the file system. It can take the values _normal_ or _full_. | normal|
24
-
| storage.checksum | Enable the data integrity check when writing and reading data from the filesystem. The storage layer uses the CRC32 algorithm. | Off|
25
-
| storage.backlog.mem_limit| If _storage.path_ is set, Fluent Bit will look for data chunks that were not delivered and are still in the storage layer, these are called _backlog_ data. This option configure a hint of maximum value of memory to use when processing these records. | 5M|
20
+
| Key | Description | Default |
21
+
|:--- |:--- |:--- |
22
+
| storage.path | Set an optional location in the file system to store streams and chunks of data. If this parameter is not set, Input plugins can only use in-memory buffering. ||
23
+
| storage.sync | Configure the synchronization mode used to store the data into the file system. It can take the values _normal_ or _full_. | normal |
24
+
| storage.checksum | Enable the data integrity check when writing and reading data from the filesystem. The storage layer uses the CRC32 algorithm. | Off |
25
+
| storage.backlog.mem\_limit| If _storage.path_ is set, Fluent Bit will look for data chunks that were not delivered and are still in the storage layer, these are called _backlog_ data. This option configure a hint of maximum value of memory to use when processing these records. | 5M |
26
26
27
27
a Service section will look like this:
28
28
29
-
```
29
+
```text
30
30
[SERVICE]
31
31
flush 1
32
32
log_Level info
@@ -36,31 +36,31 @@ a Service section will look like this:
36
36
storage.backlog.mem_limit 5M
37
37
```
38
38
39
-
that configuration configure an optional buffering mechanism where it root for data is _/var/log/flb-storage/_, it will use _normal_ synchronization mode, without checksum and up to a maximum of 5MB of memory when processing backlog data.
39
+
that configuration configure an optional buffering mechanism where it root for data is _/var/log/flb-storage/_, it will use _normal_ synchronization mode, without checksum and up to a maximum of 5MB of memory when processing backlog data.
40
40
41
41
### Input Section Configuration
42
42
43
43
Optionally, any Input plugin can configure their storage preference, the following table describe the options available:
| storage.type | Specify the buffering mechanism to use. It can be _memory_ or _filesystem_. | memory |
45
+
| Key | Description | Default |
46
+
|:--- |:--- |:--- |
47
+
| storage.type | Specify the buffering mechanism to use. It can be _memory_ or _filesystem_. | memory |
48
48
49
-
The following example configure a service that offers filesystem buffering capabilities and two Input plugins being the first based in memory and the second with the filesystem:
49
+
The following example configure a service that offers filesystem buffering capabilities and two Input plugins being the first based in memory and the second with the filesystem:
Copy file name to clipboardExpand all lines: administration/configuring-fluent-bit/commands.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Configuration Commands
1
+
# Commands
2
2
3
3
Configuration files must be flexible enough for any deployment need, but they must keep a clean and readable format.
4
4
@@ -9,7 +9,7 @@ Fluent Bit _Commands_ extends a configuration file with specific built-in featur
9
9
|[@INCLUDE](commands.md#cmd_include)|@INCLUDE FILE | Include a configuration file |
10
10
|[@SET](commands.md#cmd_set)|@SET KEY=VAL | Set a configuration variable |
11
11
12
-
## @INCLUDE Command {#cmd_include}
12
+
## @INCLUDE Command <aid="cmd_include"></a>
13
13
14
14
Configuring a logging pipeline might lead to an extensive configuration file. In order to maintain a human-readable configuration, it's suggested to split the configuration in multiple files.
15
15
@@ -60,7 +60,7 @@ Note that despites the order of inclusion, Fluent Bit will **ALWAYS** respect th
60
60
* Filters
61
61
* Outputs
62
62
63
-
## @SET Command {#cmd_set}
63
+
## @SET Command <aid="cmd_set"></a>
64
64
65
65
Fluent Bit supports [configuration variables](variables.md), one way to expose this variables to Fluent Bit is through setting a Shell environment variable, the other is through the _@SET_ command.
The _Service_ section defines global properties of the service, the keys available as of this version are described in the following table:
21
21
@@ -26,12 +26,12 @@ The _Service_ section defines global properties of the service, the keys availab
26
26
| Log\_File | Absolute path for an optional log file. ||
27
27
| Log\_Level | Set the logging verbosity level. Allowed values are: error, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, info and debug. Note that _trace_ mode is only available if Fluent Bit was built with the _WITH\_TRACE_ option enabled. | info |
28
28
| Parsers\_File | Path for a _parsers_ configuration file. Multiple Parsers\_File entries can be used. ||
29
-
| Plugins\_File | Path for a _plugins_ configuration file. A _plugins_ configuration file allows to define paths for external plugins, for an example [see here](https://github.com/fluent/fluent-bit/blob/master/conf/plugins.conf). ||
30
-
| Streams\_File | Path for the Stream Processor configuration file. For details about the format of SP configuration file [see here](stream_processor.md). ||
29
+
| Plugins\_File | Path for a _plugins_ configuration file. A _plugins_ configuration file allows to define paths for external plugins, for an example [see here](https://github.com/fluent/fluent-bit/blob/master/conf/plugins.conf). ||
30
+
| Streams\_File | Path for the Stream Processor configuration file. For details about the format of SP configuration file [see here](https://github.com/fluent/fluent-bit-docs/tree/5f926fd1330690179b8c1edab90d672699599ec7/administration/configuring-fluent-bit/stream_processor.md). ||
31
31
| HTTP\_Server | Enable built-in HTTP Server | Off |
32
32
| HTTP\_Listen | Set listening interface for HTTP Server when it's enabled | 0.0.0.0 |
33
33
| HTTP\_Port | Set TCP Port for the HTTP Server | 2020 |
34
-
|Coro_Stack_Size| Set the coroutines stack size in bytes. The value must be greater than the page size of the running system. Don't set too small value (say 4096), or coroutine threads can overrun the stack buffer. | 24576 |
34
+
|Coro\_Stack\_Size| Set the coroutines stack size in bytes. The value must be greater than the page size of the running system. Don't set too small value \(say 4096\), or coroutine threads can overrun the stack buffer. | 24576 |
35
35
36
36
### Example
37
37
@@ -44,7 +44,7 @@ The following is an example of a _SERVICE_ section:
44
44
Log_Level debug
45
45
```
46
46
47
-
## Input {#config_input}
47
+
## Input <aid="config_input"></a>
48
48
49
49
An _INPUT_ section defines a source \(related to an input plugin\), here we will describe the base configuration for each _INPUT_ section. Note that each input plugin may add it own configuration keys:
50
50
@@ -65,17 +65,17 @@ The following is an example of an _INPUT_ section:
65
65
Tag my_cpu
66
66
```
67
67
68
-
## Filter {#config_filter}
68
+
## Filter <aid="config_filter"></a>
69
69
70
70
A _FILTER_ section defines a filter \(related to an filter plugin\), here we will describe the base configuration for each _FILTER_ section. Note that each filter plugin may add it own configuration keys:
71
71
72
72
| Key | Description ||
73
73
| :--- | :--- | :--- |
74
74
| Name | Name of the filter plugin. ||
75
75
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star \(\*\) character as a wildcard. ||
76
-
|Match_Regex| A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax. ||
76
+
|Match\_Regex| A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax. ||
77
77
78
-
The _Name_ is mandatory and it let Fluent Bit know which filter plugin should be loaded. The _Match_ or _Match_Regex_ is mandatory for all plugins. If both are specified, _Match_Regex_ takes precedence.
78
+
The _Name_ is mandatory and it let Fluent Bit know which filter plugin should be loaded. The _Match_ or _Match\_Regex_ is mandatory for all plugins. If both are specified, _Match\_Regex_ takes precedence.
79
79
80
80
### Example
81
81
@@ -87,15 +87,15 @@ The following is an example of an _FILTER_ section:
87
87
Match *
88
88
```
89
89
90
-
## Output {#config_output}
90
+
## Output <aid="config_output"></a>
91
91
92
92
The _OUTPUT_ section specify a destination that certain records should follow after a Tag match. The configuration support the following keys:
93
93
94
-
| Key | Description |
95
-
| :--- | :--- |
96
-
| Name | Name of the output plugin. |
94
+
| Key | Description ||
95
+
| :--- | :--- | :--- |
96
+
| Name | Name of the output plugin. ||
97
97
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star \(\*\) character as a wildcard. ||
98
-
|Match_Regex| A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax. ||
98
+
|Match\_Regex| A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax. ||
99
99
100
100
### Example
101
101
@@ -126,7 +126,7 @@ The following configuration file example demonstrates how to collect CPU metrics
126
126
Match my*cpu
127
127
```
128
128
129
-
## Include File {#config_include_file}
129
+
## Include File <aid="config_include_file"></a>
130
130
131
131
To avoid complicated long configuration files is better to split specific parts in different files and call them \(include\) from one main file.
132
132
@@ -149,3 +149,4 @@ Wildcard character \(\*\) is supported to include multiple files, e.g:
0 commit comments