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: pipeline/parsers/regular-expression.md
+28-21Lines changed: 28 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,39 @@
1
1
# Regular Expression
2
2
3
-
The **regex** parser allows to define a custom Ruby Regular Expression that will use a named capture feature to define which content belongs to which key name.
3
+
The **Regex** parser lets you to define a custom Ruby regular expression that uses
4
+
a named capture feature to define which content belongs to which key name.
4
5
5
-
Fluent Bit uses [Onigmo](https://github.com/k-takata/Onigmo) regular expression library on Ruby mode, for testing purposes you can use the following web editor to test your expressions:
6
+
Use [Tail Multiline](../inputs/tail.md#multiline) when you need to support regexes
7
+
across multiple lines from a `tail`. The [Tail](../inputs/tail.md) input plugin
8
+
treats each line as a separate entity.
6
9
7
-
[http://rubular.com/](http://rubular.com/)
10
+
{% hint style="warning" %}
11
+
Security Warning: Onigmo is a backtracking regex engine. When using expensive
12
+
regex patterns Onigmo can take a long time to perform pattern matching. Read
Important: do not attempt to add multiline support in your regular expressions if you are using [Tail](../inputs/tail.md) input plugin since each line is handled as a separated entity. Instead use Tail [Multiline](../inputs/tail.md#multiline) support configuration feature.
10
-
11
-
Security Warning: Onigmo is a _backtracking_ regex engine. You need to be careful not to use expensive regex patterns, or Onigmo can take very long time to perform pattern matching. For details, please read the article ["ReDoS"](https://owasp.org/www-community/attacks/Regular_expression_Denial_of_Service_-_ReDoS) on OWASP.
12
-
13
-
> Note: understanding how regular expressions works is out of the scope of this content.
14
-
15
-
From a configuration perspective, when the format is set to **regex**, is mandatory and expected that a _Regex_ configuration key exists.
17
+
Setting the format to **regex** requires a `regex` configuration key.
16
18
17
19
## Configuration Parameters
18
20
19
21
The regex parser supports the following configuration parameters.
20
22
21
-
|Key|Description|Default Value|
22
-
|-------|------------|--------|
23
-
|`Skip_Empty_Values`|If enabled, the parser ignores empty value of the record.| True|
23
+
| Key | Description | Default Value |
24
+
| --- | ----------- | ------------- |
25
+
|`Skip_Empty_Values`| If enabled, the parser ignores empty value of the record. |`True`|
26
+
27
+
Fluent Bit uses the [Onigmo](https://github.com/k-takata/Onigmo) regular expression
28
+
library on Ruby mode.
24
29
25
-
The following parser configuration example aims to provide rules that can be applied to an Apache HTTP Server log entry:
30
+
You can only use alphanumeric characters and underscore in group names. For example,
31
+
a group name like `(?<user-name>.*)` causes an error due to the invalid dash (`-`)
32
+
character. Use the [http://rubular.com/](http://rubular.com/) web editor to test your
33
+
expressions
34
+
35
+
The following parser configuration example provides rules that can be applied to an
36
+
Apache HTTP Server log entry:
26
37
27
38
```python
28
39
[PARSER]
@@ -34,13 +45,14 @@ The following parser configuration example aims to provide rules that can be app
34
45
Types code:integer size:integer
35
46
```
36
47
37
-
As an example, takes the following Apache HTTP Server log entry:
48
+
As an example, review the following Apache HTTP Server log entry:
The above content do not provide a defined structure for Fluent Bit, but enabling the proper parser we can help to make a structured representation of it:
54
+
This log entry doesn't provide a defined structure for Fluent Bit. Enabling the
55
+
proper parser can help to make a structured representation of the entry:
44
56
45
57
```text
46
58
[1154104030, {"host"=>"192.168.2.20",
@@ -54,8 +66,3 @@ The above content do not provide a defined structure for Fluent Bit, but enablin
54
66
}
55
67
]
56
68
```
57
-
58
-
A common pitfall is that you cannot use characters other than alphabets, numbers and underscore in group names. For example, a group name like `(?<user-name>.*)` will cause an error due to containing an invalid character \(`-`\).
59
-
60
-
In order to understand, learn and test regular expressions like the example above, we suggest you try the following Ruby Regular Expression Editor: [http://rubular.com/r/X7BH0M4Ivm](http://rubular.com/r/X7BH0M4Ivm)
0 commit comments