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
Fluent Bit might optionally use a configuration file to define how the service will behave.
4
4
5
-
Before proceeding we need to understand how the configuration schema works.
6
-
7
5
The schema is defined by three concepts:
8
6
9
-
* Sections
10
-
* Entries: Key/Value
11
-
* Indented Configuration Mode
7
+
- Sections
8
+
- Entries: key/value
9
+
- Indented Configuration Mode
12
10
13
-
A simple example of a configuration file is as follows:
11
+
An example of a configuration file is as follows:
14
12
15
13
```python
16
14
[SERVICE]
@@ -19,30 +17,30 @@ A simple example of a configuration file is as follows:
19
17
log_level debug
20
18
```
21
19
22
-
## Sections <aid="sections"></a>
20
+
## Sections
23
21
24
-
A section is defined by a name or title inside brackets. Looking at the example above, a Service section has been set using **\[SERVICE\]** definition. Section rules:
22
+
A section is defined by a name or title inside brackets. Using the previous example, a Service section has been set using `[SERVICE]` definition. The following rules apply:
25
23
26
-
* All section content must be indented \(4 spaces ideally\).
27
-
* Multiple sections can exist on the same file.
28
-
* A section is expected to have comments and entries, it cannot be empty.
29
-
* Any commented line under a section, must be indented too.
30
-
* End-of-line comments are not supported, only full-line comments.
24
+
- All section content must be indented (four spaces ideally).
25
+
- Multiple sections can exist on the same file.
26
+
- A section must have comments and entries.
27
+
- Any commented line under a section must be indented too.
28
+
- End-of-line comments aren't supported, only full-line comments.
31
29
32
-
## Entries: Key/Value <aid="entries_kv"></a>
30
+
## Entries: key/value
33
31
34
-
A section may contain **Entries**, an entry is defined by a line of text that contains a **Key** and a **Value**, using the above example, the `[SERVICE]` section contains two entries, one is the key **Daemon** with value **off** and the other is the key **Log\_Level** with the value **debug**. Entries rules:
32
+
A section can contain entries. An entry is defined by a line of text that contains a `Key` and a `Value`. Using the previous example, the `[SERVICE]` section contains two entries: one is the key `Daemon` with value `off` and the other is the key `Log_Level` with the value `debug`. The following rules apply:
35
33
36
-
* An entry is defined by a key and a value.
37
-
* A key must be indented.
38
-
* A key must contain a value which ends in the breakline.
39
-
* Multiple keys with the same name can exist.
34
+
- An entry is defined by a key and a value.
35
+
- A key must be indented.
36
+
- A key must contain a value which ends in the breakline.
37
+
- Multiple keys with the same name can exist.
40
38
41
-
Also commented lines are set prefixing the **\#** character, those lines are not processed but they must be indented too.
39
+
Commented lines are set prefixing the `#` character. Commented lines aren't processed but they must be indented.
Fluent Bit configuration files are based in a strict **Indented Mode**, that means that each configuration file must follow the same pattern of alignment from left to right when writing text. By default an indentation level of four spaces from left to right is suggested. Example:
43
+
Fluent Bit configuration files are based in a strict indented mode. Each configuration file must follow the same pattern of alignment from left to right when writing text. By default, an indentation level of four spaces from left to right is suggested. Example:
46
44
47
45
```python
48
46
[FIRST_SECTION]
@@ -55,5 +53,4 @@ Fluent Bit configuration files are based in a strict **Indented Mode**, that mea
55
53
KeyN 3.14
56
54
```
57
55
58
-
As you can see there are two sections with multiple entries and comments, note also that empty lines are allowed and they do not need to be indented.
59
-
56
+
This example shows two sections with multiple entries and comments. Empty lines are allowed.
0 commit comments