Skip to content

Commit 3d5661d

Browse files
committed
Filters: Correcting stylistic issues
Signed-off-by: Lynette Miles <[email protected]>
1 parent db56f46 commit 3d5661d

File tree

4 files changed

+32
-32
lines changed

4 files changed

+32
-32
lines changed

pipeline/filters/aws-metadata.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ If you run Fluent Bit in a container, you might need to use instance metadata v1
2929
Run Fluent Bit from the command line:
3030

3131
```shell
32-
$ ./fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.conf
32+
fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.conf
3333
```
3434

3535
You should see results like this:
@@ -66,7 +66,7 @@ pipeline:
6666
hostname: true
6767
vpc_id: true
6868
tags_enabled: true
69-
69+
7070
outputs:
7171
- name: stdout
7272
match: '*'
@@ -188,4 +188,4 @@ The resulting logs might look like this:
188188

189189
```text
190190
{"log"=>"aws is awesome", "az"=>"us-east-1a", "ec2_instance_id"=>"i-0e66fc7f9809d7168", "Name"=>"fluent-bit-docs-example", "project"=>"fluentbit"}
191-
```
191+
```

pipeline/filters/ecs-metadata.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ The following template variables can be used for values with the `ADD` option. S
3535

3636
### Configuration file
3737

38-
Below configurations assume a properly configured parsers file and 'storage.path' variable defined in the services
39-
section of the fluent bit configuration (not shown below).
38+
The following configurations assume a properly configured parsers file and 'storage.path' variable defined in the services
39+
section of the Fluent bit Configuration (not shown).
4040

4141
#### Example 1: Attach Task ID and cluster name to container logs
4242

@@ -65,10 +65,10 @@ pipeline:
6565
- name: ecs
6666
match: '*'
6767
ecs_tag_prefix: ecs.var.lib.docker.containers.
68-
add:
68+
add:
6969
- ecs_task_id $TaskID
7070
- cluster $ClusterName
71-
71+
7272
outputs:
7373
- name: stdout
7474
match: '*'
@@ -150,7 +150,7 @@ pipeline:
150150
match: '*'
151151
ecs_tag_prefix: ecs.var.lib.docker.containers.
152152
add: resource $ClusterName.$TaskDefinitionFamily.$TaskID.$ECSContainerName
153-
153+
154154
outputs:
155155
- name: stdout
156156
match: '*'
@@ -207,7 +207,7 @@ The template variables in the value for the `resource` key are separated by dot
207207

208208
#### Example 3: Attach cluster metadata to non-container logs
209209

210-
This examples shows a use case for the `Cluster_Metadata_Only` option attaching cluster metadata to ECS Agent logs.
210+
This example shows a use case for the `Cluster_Metadata_Only` option attaching cluster metadata to ECS Agent logs.
211211

212212
{% tabs %}
213213
{% tab title="fluent-bit.yaml" %}
@@ -232,7 +232,7 @@ pipeline:
232232
match: '*'
233233
cluster_metadata_only: on
234234
add: cluster $ClusterName
235-
235+
236236
outputs:
237237
- name: stdout
238238
match: '*'
@@ -269,4 +269,4 @@ pipeline:
269269
```
270270

271271
{% endtab %}
272-
{% endtabs %}
272+
{% endtabs %}

pipeline/filters/record-modifier.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ pipeline:
3838
inputs:
3939
- name: mem
4040
tag: mem.local
41-
41+
4242
filters:
4343
- name: record_modifier
4444
match: '*'
@@ -76,7 +76,7 @@ pipeline:
7676
You can run the filter from command line:
7777

7878
```shell
79-
$ ./fluent-bit -i mem -o stdout -F record_modifier -p 'Record=hostname ${HOSTNAME}' -p 'Record=product Awesome_Tool' -m '*'
79+
fluent-bit -i mem -o stdout -F record_modifier -p 'Record=hostname ${HOSTNAME}' -p 'Record=product Awesome_Tool' -m '*'
8080
```
8181

8282
The output looks something like:
@@ -97,15 +97,15 @@ pipeline:
9797
inputs:
9898
- name: mem
9999
tag: mem.local
100-
100+
101101
filters:
102102
- name: record_modifier
103103
match: '*'
104104
remove_key:
105105
- Swap.total
106106
- Swap.used
107107
- Swap.free
108-
108+
109109
outputs:
110110
- name: stdout
111111
match: '*'
@@ -137,7 +137,7 @@ pipeline:
137137
You can also run the filter from command line.
138138

139139
```shell
140-
$ ./fluent-bit -i mem -o stdout -F record_modifier -p 'Remove_key=Swap.total' -p 'Remove_key=Swap.free' -p 'Remove_key=Swap.used' -m '*'
140+
fluent-bit -i mem -o stdout -F record_modifier -p 'Remove_key=Swap.total' -p 'Remove_key=Swap.free' -p 'Remove_key=Swap.used' -m '*'
141141
```
142142

143143
The output looks something like:
@@ -158,15 +158,15 @@ pipeline:
158158
inputs:
159159
- name: mem
160160
tag: mem.local
161-
161+
162162
filters:
163163
- name: record_modifier
164164
match: '*'
165165
Allowlist_key:
166166
- Mem.total
167167
- Mem.used
168168
- Mem.free
169-
169+
170170
outputs:
171171
- name: stdout
172172
match: '*'
@@ -186,7 +186,7 @@ pipeline:
186186
Allowlist_key Mem.total
187187
Allowlist_key Mem.used
188188
Allowlist_key Mem.free
189-
189+
190190
[OUTPUT]
191191
Name stdout
192192
Match *
@@ -198,11 +198,11 @@ pipeline:
198198
You can also run the filter from command line:
199199

200200
```shell
201-
$ ./fluent-bit -i mem -o stdout -F record_modifier -p 'Allowlist_key=Mem.total' -p 'Allowlist_key=Mem.free' -p 'Allowlist_key=Mem.used' -m '*'
201+
fluent-bit -i mem -o stdout -F record_modifier -p 'Allowlist_key=Mem.total' -p 'Allowlist_key=Mem.free' -p 'Allowlist_key=Mem.used' -m '*'
202202
```
203203

204204
The output looks something like:
205205

206206
```text
207207
[0] mem.local: [1492436998.000000000, {"Mem.total"=>1016024, "Mem.used"=>716672, "Mem.free"=>295332}]
208-
```
208+
```

pipeline/filters/tensorflow.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,33 +25,33 @@ The plugin supports the following configuration parameters:
2525
To create a Tensorflow Lite shared library:
2626

2727
1. Clone the [Tensorflow repository](https://github.com/tensorflow/tensorflow).
28-
2. Install the [Bazel](https://bazel.build/) package manager.
29-
3. Run the following command to create the shared library:
28+
1. Install the [Bazel](https://bazel.build/) package manager.
29+
1. Run the following command to create the shared library:
3030

3131
```shell
32-
$ ./bazel build -c opt //tensorflow/lite/c:tensorflowlite_c # see https://github.com/tensorflow/tensorflow/tree/master/tensorflow/lite/c
32+
bazel build -c opt //tensorflow/lite/c:tensorflowlite_c # see https://github.com/tensorflow/tensorflow/tree/master/tensorflow/lite/c
3333
```
3434

3535
The script creates the shared library
3636
`bazel-bin/tensorflow/lite/c/libtensorflowlite_c.so`.
37-
4. Copy the library to a location such as `/usr/lib` that can be used by Fluent Bit.
37+
1. Copy the library to a location such as `/usr/lib` that can be used by Fluent Bit.
3838

3939
## Building Fluent Bit with Tensorflow filter plugin
4040

4141
The Tensorflow filter plugin is disabled by default. You must build Fluent Bit with the Tensorflow plugin enabled. In addition, it requires access to Tensorflow Lite header files to compile. Therefore, you must pass the address of the Tensorflow source code on your machine to the [build script](https://github.com/fluent/fluent-bit#build-from-scratch):
4242

4343
```shell
44-
$ ./cmake -DFLB_FILTER_TENSORFLOW=On -DTensorflow_DIR=<AddressOfTensorflowSourceCode> ...
44+
cmake -DFLB_FILTER_TENSORFLOW=On -DTensorflow_DIR=<AddressOfTensorflowSourceCode> ...
4545
```
4646

4747
### Command line
4848

49-
If Tensorflow plugin initializes correctly, it reports successful creation of the interpreter, and prints a summary of model's input and output types and dimensions.
49+
If the Tensorflow plugin initializes correctly, it reports successful creation of the interpreter, and prints a summary of model's input and output types and dimensions.
5050

5151
The command:
5252

5353
```shell
54-
$ ./fluent-bit -i mqtt -p 'tag=mqtt.data' -F tensorflow -m '*' -p 'input_field=image' -p 'model_file=/home/user/model.tflite' -p
54+
fluent-bit -i mqtt -p 'tag=mqtt.data' -F tensorflow -m '*' -p 'input_field=image' -p 'model_file=/home/user/model.tflite' -p
5555
```
5656

5757
produces an output like:
@@ -75,20 +75,20 @@ service:
7575
flush: 1
7676
daemon: off
7777
log_level: info
78-
78+
7979
pipeline:
8080
inputs:
8181
- name: mqtt
8282
tag: mqtt.data
83-
83+
8484
filters:
8585
- name: tensorflow
8686
match: mqtt.data
8787
input_field: image
8888
model_file: /home/m/model.tflite
8989
include_input_fields: false
9090
normalization_value: 255
91-
91+
9292
outputs:
9393
- name: stdout
9494
match: '*'
@@ -121,4 +121,4 @@ pipeline:
121121
```
122122

123123
{% endtab %}
124-
{% endtabs %}
124+
{% endtabs %}

0 commit comments

Comments
 (0)