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
The following plugin looks up if a value in a specified list exists and then
4
-
allows the addition of a record to indicate if found. Introduced in version
5
-
1.8.4
6
-
---
7
-
8
1
# CheckList
9
2
10
-
## Configuration Parameters
3
+
The CheckList plugin (introduced in version 1.8.4) looks up a value in a specified list to see if it exists. The plugin then allows the addition of a record to indicate if the value was found.
4
+
5
+
## Configuration parameters
11
6
12
7
The plugin supports the following configuration parameters
13
8
14
-
| Key | Description |
15
-
| :---| :--- |
16
-
| file | The single value file that Fluent Bit will use as a lookup table to determine if the specified `lookup_key` exists |
17
-
|lookup\_key| The specific key to look up and determine if it exists, supports record accessor |
18
-
| record | The record to add if the `lookup_key` is found in the specified `file`. Note you may add multiple record parameters. |
19
-
| mode | Set the check mode. `exact` and `partial` are supported. Default : `exact`.|
20
-
| print_query_time | Print to stdout the elapseed query time for every matched record. Default: false|
|`file`| The single value file that Fluent Bit will use as a lookup table to determine if the specified `lookup_key` exists. |_none_|
12
+
|`lookup_key`| The specific key to look up and determine if it exists. Supports [record accessor](../../administration/configuring-fluent-bit/classic-mode/record-accessor). |_none_|
13
+
|`record`| The record to add if the `lookup_key` is found in the specified `file`. You can add multiple record parameters.|_none_|
14
+
|`mode`| Set the check mode. `exact` and `partial` are supported. |`exact`|
15
+
|`print_query_time`| Print to stdout the elapsed query time for every matched record. |`false`|
16
+
|`ignore_case`| Compare strings by ignoring case. |`false`|
22
17
23
-
## Example Configuration
18
+
## Example configuration
24
19
25
-
```text
20
+
```python
26
21
[INPUT]
27
22
name tail
28
23
tag test1
@@ -44,7 +39,7 @@ The plugin supports the following configuration parameters
44
39
match test1
45
40
```
46
41
47
-
In the following configuration we will read a file `test1.log` that includes the following values
42
+
The following configuration reads a file `test1.log` that includes the following values:
@@ -57,17 +52,16 @@ In the following configuration we will read a file `test1.log` that includes the
57
52
58
53
```
59
54
60
-
Additionally, we will use the following lookup file which contains a list of malicious IPs \(`ip_list.txt`\)
55
+
Additionally, it uses the following lookup file which contains a list of malicious IP addresses (`ip_list.txt`).
61
56
62
57
```text
63
58
1.2.3.4
64
59
6.6.4.232
65
60
7.7.7.7
66
61
```
67
62
68
-
In the configuration we are using $remote\_addr as the lookup key and 7.7.7.7 is malicious. This means the record we would output for the last record would look like the following
63
+
The configuration uses `$remote_addr` as the lookup key, and `7.7.7.7` is malicious. The record output for the last record would look like the following:
0 commit comments