Skip to content

Commit 09bcd1f

Browse files
Merge pull request #1885 from fluent/alexakreizinger/sc-141445/fix-formatting-errors-from-fluent-bit-docs
2 parents 1d92bd3 + 66c60c5 commit 09bcd1f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+142
-142
lines changed

administration/monitoring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@ Start Fluent bit with the corresponding configuration chosen above:
7171

7272
```shell
7373
# For YAML configuration.
74-
$ ./bin/fluent-bit --config fluent-bit.yaml
74+
./bin/fluent-bit --config fluent-bit.yaml
7575

7676
# For classic configuration.
77-
$ ./bin/fluent-bit --config fluent-bit.conf
77+
./bin/fluent-bit --config fluent-bit.conf
7878
```
7979

8080
Fluent Bit starts and generates output in your terminal:
@@ -282,7 +282,7 @@ The command prints a similar output like this:
282282
Query internal metrics in JSON format with the following command:
283283

284284
```shell
285-
$ curl -s http://127.0.0.1:2020/api/v1/metrics | jq
285+
curl -s http://127.0.0.1:2020/api/v1/metrics | jq
286286
```
287287

288288
The command prints a similar output like this:
@@ -312,7 +312,7 @@ The command prints a similar output like this:
312312
Query internal metrics in Prometheus Text 0.0.4 format:
313313

314314
```shell
315-
$ curl -s http://127.0.0.1:2020/api/v1/metrics/prometheus
315+
curl -s http://127.0.0.1:2020/api/v1/metrics/prometheus
316316
```
317317

318318
This command returns the same metrics in Prometheus format instead of JSON:
@@ -506,7 +506,7 @@ pipeline:
506506
Use the following command to call the health endpoint:
507507

508508
```shell
509-
$ curl -s http://127.0.0.1:2020/api/v1/health
509+
curl -s http://127.0.0.1:2020/api/v1/health
510510
```
511511

512512
With the example configuration, the health status is determined by the following equation:

development/msgpack-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This section provides an overview of the specific types used by Fluent Bit withi
1616
Set up Fluent Bit to send in `msgpack` format to a specific port.
1717

1818
```bash
19-
$ docker run --rm -it --network=host fluent/fluent-bit /fluent-bit/bin/fluent-bit -i cpu -o tcp://127.0.0.1:5170 -p format=msgpack -v
19+
docker run --rm -it --network=host fluent/fluent-bit /fluent-bit/bin/fluent-bit -i cpu -o tcp://127.0.0.1:5170 -p format=msgpack -v
2020

2121
```
2222

development/wasm-filter-plugins.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ Currently, Fluent Bit supports the following Wasm tool chains:
3535
As described in the general options in the [source installation](../installation/sources/build-and-install.md) guide, Wasm support is enabled by default. Compile Fluent Bit with Wasm support, for example:
3636

3737
```text
38-
$ cd build/
39-
$ cmake .. [-DFLB_WAMRC=On]
40-
$ make
38+
cd build/
39+
cmake .. [-DFLB_WAMRC=On]
40+
make
4141
```
4242

4343
To support AOT-compiled Wasm execution as filter plugins, build Fluent Bit with `-DFLB_WAMRC=On`.
@@ -65,7 +65,7 @@ The Fluent Bit Wasm filter assumes C ABI, also known as `wasm32-unknown-unknown`
6565
TinyGo and WASI SDK support Wasm target by default. When using Rust's `wasm32-unknown-unknown` target, you must install `wasm32-unknown-unknown` by using [rustup](https://rustup.rs/). Then, install the target components as follows:
6666

6767
```text
68-
$ rustup target add wasm32-unknown-unknown
68+
rustup target add wasm32-unknown-unknown
6969
```
7070

7171
### Requirements of Wasm programs
@@ -228,13 +228,13 @@ To optimize Wasm program execution, there is the option of using `flb-wamrc`. Th
228228
This tool will be built when the `-DFLB_WAMRC=On` CMake option is specified and LLVM infrastructure is installed on the building box.
229229

230230
```shell
231-
$ flb-wamrc -o /path/to/built_wasm.aot /path/to/built_wasm.wasm
231+
flb-wamrc -o /path/to/built_wasm.aot /path/to/built_wasm.wasm
232232
```
233233

234234
For further optimizations to the specific CPU, such as Cortex-A57 series:
235235

236236
```text
237-
$ flb-wamrc --size-level=3 --target=aarch64v8 --cpu=cortex-a57 -o /path/to/built_wasm.aot /path/to/built_wasm.wasm
237+
flb-wamrc --size-level=3 --target=aarch64v8 --cpu=cortex-a57 -o /path/to/built_wasm.aot /path/to/built_wasm.wasm
238238
```
239239

240240
Then, when AOT (Ahead Of Time) compiling has succeeded:

development/wasm-input-plugins.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ Fluent Bit supports the following Wasm toolchains:
2525
Compile Fluent Bit with Wasm support. For example:
2626

2727
```text
28-
$ cd build/
29-
$ cmake ..
30-
$ make
28+
cd build/
29+
cmake ..
30+
make
3131
```
3232

3333
Once compiled, you can see new plugins that handle `wasm`. For example:
@@ -53,7 +53,7 @@ Wasm input in Fluent Bit assumes WASI ABI, also known as `wasm32-wasi` on Rust t
5353
TinyGo and WASI SDK support Wasm target by default. When using Rust's `wasm32-wasi` target, you must install `wasm32-wasi` by using [rustup](https://rustup.rs/). Then, install the target components as:
5454

5555
```text
56-
$ rustup target add wasm32-wasi
56+
rustup target add wasm32-wasi
5757
```
5858

5959
### Requirements of Wasm/WASI programs

pipeline/filters/aws-metadata.md

Lines changed: 1 addition & 1 deletion
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:

pipeline/filters/grep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ When using the command line, pay close attention to quote the regular expression
4242
The following command loads the [tail](../../pipeline/inputs/tail) plugin and reads the content of `lines.txt`. Then the `grep` filter applies a regular expression rule over the `log` field created by the `tail` plugin and only passes records with a field value starting with `aa`:
4343

4444
```shell
45-
$ ./fluent-bit -i tail -p 'path=lines.txt' -F grep -p 'regex=log aa' -m '*' -o stdout
45+
./fluent-bit -i tail -p 'path=lines.txt' -F grep -p 'regex=log aa' -m '*' -o stdout
4646
```
4747

4848
### Configuration file

pipeline/filters/lua.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To test the Lua filter, you can run the plugin from the command line or through
3131
From the command line you can use the following options:
3232

3333
```shell
34-
$ ./fluent-bit -i dummy -F lua -p script=test.lua -p call=cb_print -m '*' -o null
34+
./fluent-bit -i dummy -F lua -p script=test.lua -p call=cb_print -m '*' -o null
3535
```
3636

3737
### Configuration file

pipeline/filters/modify.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ which outputs data similar to the following:
9595
Using the command line mode requires quotes parse the wildcard properly. The use of a configuration file is recommended.
9696

9797
```shell
98-
$ ./fluent-bit -i mem \
98+
./fluent-bit -i mem \
9999
-p 'tag=mem.local' \
100100
-F modify \
101101
-p 'Add=Service1 SOMEVALUE' \

pipeline/filters/multiline-stacktrace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ one more line, no multiline
246246
Running Fluent Bit with the given configuration file:
247247

248248
```shell
249-
$ ./fluent-bit -c fluent-bit.conf
249+
./fluent-bit -c fluent-bit.conf
250250
```
251251

252252
Should return something like the following:

pipeline/filters/nest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ wildcard rule to the keys and nests the keys matching `Mem.*` under the new key
9191
`NEST`.
9292

9393
```shell
94-
$ ./fluent-bit -i mem -p 'tag=mem.local' -F nest -p 'Operation=nest' -p 'Wildcard=Mem.*' -p 'Nest_under=Memstats' -p 'Remove_prefix=Mem.' -m '*' -o stdout
94+
./fluent-bit -i mem -p 'tag=mem.local' -F nest -p 'Operation=nest' -p 'Wildcard=Mem.*' -p 'Nest_under=Memstats' -p 'Remove_prefix=Mem.' -m '*' -o stdout
9595
```
9696

9797
### Nest configuration file

0 commit comments

Comments
 (0)