Skip to content

Commit 5095879

Browse files
committed
Adding YAML examples for nightfall filter doc. Part of issue #1872.
Signed-off-by: Eric D. Schabell <[email protected]>
1 parent f6c3e5f commit 5095879

File tree

1 file changed

+37
-4
lines changed

1 file changed

+37
-4
lines changed

pipeline/filters/nightfall.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,32 @@ The plugin supports the following configuration parameters:
2727

2828
The following is an example of a configuration file for the Nightfall filter:
2929

30+
{% tabs %}
31+
{% tab title="fluent-bit.yaml" %}
32+
33+
```yaml
34+
pipeline:
35+
inputs:
36+
- name: http
37+
host: 0.0.0.0
38+
port: 8000
39+
40+
filters:
41+
- name: nightfall
42+
match: '*'
43+
nightfall_api_key: <API key>
44+
policy_id: 5991946b-1cc8-4c38-9240-72677029a3f7
45+
sampling_rate: 1
46+
tls.ca_path: /etc/ssl/certs
47+
48+
outputs:
49+
- name: stdout
50+
match: '*'
51+
```
52+
53+
{% endtab %}
54+
{% tab title="fluent-bit.conf" %}
55+
3056
```text
3157
[INPUT]
3258
name http
@@ -43,15 +69,22 @@ The following is an example of a configuration file for the Nightfall filter:
4369

4470
[OUTPUT]
4571
Name stdout
72+
Match *
4673
```
4774

75+
{% endtab %}
76+
{% endtabs %}
77+
4878
### Command line
4979

50-
After you configure the filter, you can use the it from the command line by running a
51-
command like:
80+
After you configure the filter, you can use it from the command line by running a command like:
5281

5382
```shell
54-
bin/fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.conf
83+
# For YAML configuration.
84+
$ ./fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.yaml
85+
86+
# For classic configuration.
87+
$ ./fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.conf
5588
```
5689

5790
Replace _`PATH_TO_CONF_FILE`_ with the path for where your filter configuration file
@@ -71,4 +104,4 @@ Which results in output like:
71104
[0] app.log: [1644464790.280412000, {"A"=>"there is nothing sensitive here", "B"=>[{"A"=>"my credit card number is *******************"}, {"A"=>"*********** is my social security."}], "C"=>false, "D"=>"key ********************"}]
72105
[2022/02/09 19:47:25] [ info] [filter:nightfall:nightfall.0] Nightfall request http_do=0, HTTP Status: 200
73106
[0] app.log: [1644464845.675431000, {"A"=>"a very safe string"}]
74-
```
107+
```

0 commit comments

Comments
 (0)