Skip to content

Commit dd264fc

Browse files
authored
Merge pull request #1665 from fluent/lynettemiles/sc-135600/update-fluent-bit-fluent-bit-docs-administration
2 parents 405071f + c48dfce commit dd264fc

File tree

1 file changed

+22
-25
lines changed

1 file changed

+22
-25
lines changed
Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
# Formats and Schema
1+
# Formats and schema
22

33
Fluent Bit might optionally use a configuration file to define how the service will behave.
44

5-
Before proceeding we need to understand how the configuration schema works.
6-
75
The schema is defined by three concepts:
86

9-
* Sections
10-
* Entries: Key/Value
11-
* Indented Configuration Mode
7+
- Sections
8+
- Entries: key/value
9+
- Indented Configuration Mode
1210

13-
A simple example of a configuration file is as follows:
11+
An example of a configuration file is as follows:
1412

1513
```python
1614
[SERVICE]
@@ -19,30 +17,30 @@ A simple example of a configuration file is as follows:
1917
log_level debug
2018
```
2119

22-
## Sections <a id="sections"></a>
20+
## Sections
2321

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:
2523

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.
3129

32-
## Entries: Key/Value <a id="entries_kv"></a>
30+
## Entries: key/value
3331

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:
3533

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.
4038

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.
4240

43-
## Indented Configuration Mode <a id="indented_mode"></a>
41+
## Indented configuration mode
4442

45-
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:
4644

4745
```python
4846
[FIRST_SECTION]
@@ -55,5 +53,4 @@ Fluent Bit configuration files are based in a strict **Indented Mode**, that mea
5553
KeyN 3.14
5654
```
5755

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

Comments
 (0)