Skip to content

Commit dbadf88

Browse files
committed
Fix formatting issues in multiple Markdown files for Fluent Bit WASM documentation
Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
1 parent f1c944e commit dbadf88

File tree

11 files changed

+18
-12
lines changed

11 files changed

+18
-12
lines changed

content/challenges/11111111-1111-1111-1111-111111111111/processing-log-data-with-fluent-bit-and-wasm/configuring-fluent-bit-to-use-the-wasm-plugin/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ Here is the Fluent Bit configuration for our use case:
4444
match dummy
4545
```
4646

47-
Next, let's take a closer look at the configuration above.
47+
Next, let's take a closer look at the configuration above.

content/challenges/11111111-1111-1111-1111-111111111111/processing-log-data-with-fluent-bit-and-wasm/enriching-log-data-in-stream-reducing-mttd/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ The [Fluent Bit WASM plugin](https://docs.fluentbit.io/manual/pipeline/filters/w
1919

2020
![custom-filtering-wasm](custom-filtering-wasm.png)
2121

22-
With this use case in mind, let’s write a WASM program for Fluent Bit.
22+
With this use case in mind, let’s write a WASM program for Fluent Bit.

content/challenges/11111111-1111-1111-1111-111111111111/processing-log-data-with-fluent-bit-and-wasm/filter-section/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ The **[FILTER]** section specifies the configuration for a filter plugin. In thi
2323

2424
- **Function_Name:** The function within the WASM module to be executed **(go_filter)**.
2525

26-
Check out the [official documentation](https://docs.fluentbit.io/manual/pipeline/filters/wasm) for more information about the **WASM** plugin.
26+
Check out the [official documentation](https://docs.fluentbit.io/manual/pipeline/filters/wasm) for more information about the **WASM** plugin.

content/challenges/11111111-1111-1111-1111-111111111111/processing-log-data-with-fluent-bit-and-wasm/input-section/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ Each **[INPUT]** section specifies the configuration for an input plugin. In thi
2020

2121
- **Tag**: Assigns a tag **(dummy)** to this input, which is used to match this input to filters and outputs.
2222

23-
Check out the [official documentation](https://docs.fluentbit.io/manual/pipeline/inputs/dummy) for more information about the **dummy** plugin.
23+
Check out the [official documentation](https://docs.fluentbit.io/manual/pipeline/inputs/dummy) for more information about the **dummy** plugin.

content/challenges/11111111-1111-1111-1111-111111111111/processing-log-data-with-fluent-bit-and-wasm/instructions-for-compiling-the-wasm-program/_index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,15 @@ weight: 6
66
---
77

88
1. Initialize a new Golang project using the following command:
9+
910
```bash
1011
mkdir go-filter && go mod init go-filter
1112
```
13+
1214
2. Copy the above Golang program in a file called filter.go
1315

1416
3. With our filter program written, lets compile it using tinygo
17+
1518
```bash
1619
# Use the below command for tinygo version >= 0.33.0
1720
tinygo build -target=wasi -o filter.wasm filter.go
@@ -20,4 +23,4 @@ weight: 6
2023
tinygo build -wasm-abi=generic -target=wasi -o filter.wasm filter.go
2124
```
2225

23-
4. It will produce a file called filter.wasm. This compiled WASM file will be used by Fluent Bit to execute the plugin.
26+
4. It will produce a file called filter.wasm. This compiled WASM file will be used by Fluent Bit to execute the plugin.

content/challenges/11111111-1111-1111-1111-111111111111/processing-log-data-with-fluent-bit-and-wasm/instructions-for-configuring-fluent-bit/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,4 @@ weight: 11
6565

6666
![verify-fluent-bit-logs](verify-fluent-bit-logs.png)
6767

68-
To programmatically verify plugin results, you can use the Expect filter. You can read more at [Validating Your Data and Structure](https://docs.fluentbit.io/manual/local-testing/validating-your-data-and-structure).
68+
To programmatically verify plugin results, you can use the Expect filter. You can read more at [Validating Your Data and Structure](https://docs.fluentbit.io/manual/local-testing/validating-your-data-and-structure).

content/challenges/11111111-1111-1111-1111-111111111111/processing-log-data-with-fluent-bit-and-wasm/output-section/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ The **[OUTPUT]** section specifies the configuration for an output plugin. In th
1919

2020
- match: Matches the tag **(dummy)** to send the filtered input data tagged with **dummy** to **stdout**.
2121

22-
Check out the [official documentation](https://docs.fluentbit.io/manual/pipeline/outputs/standard-output) for more information about the **stdout** plugin.
22+
Check out the [official documentation](https://docs.fluentbit.io/manual/pipeline/outputs/standard-output) for more information about the **stdout** plugin.

content/challenges/11111111-1111-1111-1111-111111111111/processing-log-data-with-fluent-bit-and-wasm/overview/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ Fluent Bit supports custom processing via C plugins or Lua, but learning new lan
1111

1212
WASM enhances performance, security, and flexibility by enabling custom processing in [languages](https://webassembly.org/getting-started/developers-guide) like Go, Rust, and C++. Fluent Bit’s WASM plugin allows users to implement high-speed, scalable, and custom data transformations for advanced use cases.
1313

14-
Let's review how [WASM](https://webassembly.org/) can be used to extend Fluent Bit’s processing capabilities, enabling users to implement custom logic and functionalities. Through the application of WASM, Fluent Bit addresses a wide array of unique and sophisticated use cases.
14+
Let's review how [WASM](https://webassembly.org/) can be used to extend Fluent Bit’s processing capabilities, enabling users to implement custom logic and functionalities. Through the application of WASM, Fluent Bit addresses a wide array of unique and sophisticated use cases.

content/challenges/11111111-1111-1111-1111-111111111111/processing-log-data-with-fluent-bit-and-wasm/prerequisites/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ weight: 3
88
- **Docker:** For running Fluent Bit
99
- **Golang (1.17 / 1.18):** WASM plugins will be written using Golang
1010
- **[Tinygo (v0.24.0 or later):](https://tinygo.org/getting-started/install/)** For building WASM programs
11-
- Familiarity with Fluent Bit [concepts](https://docs.fluentbit.io/manual/concepts/data-pipeline) such as inputs, outputs, parsers, and filters
11+
- Familiarity with Fluent Bit [concepts](https://docs.fluentbit.io/manual/concepts/data-pipeline) such as inputs, outputs, parsers, and filters

content/challenges/11111111-1111-1111-1111-111111111111/processing-log-data-with-fluent-bit-and-wasm/program-explanation/_index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,16 @@ weight: 5
88
1. The core logic is written in the function go_filter. This function name will also be used during the WASM plugin configuration.
99

1010
2. It is mandatory for the WASM plugin to have the following function signature:
11+
1112
```bash
1213
//export go_filter
1314
func go_filter(tag uint8, tag_len uint, time_sec uint, time_nsec uint, record uint8, record_len uint) *uint8
1415
```
16+
1517
Note: The comment `//export go_filter` on function is required and it should be the same as the function name.
1618

1719
3. Using the function parameters we will have access to the original log record, tag, and timestamp. Here is an example log record:
20+
1821
```bash
1922
{
2023
"log": "2023-10-02T06:52:52.843524746Z stdout F 122.30.117.241 - - [02/Oct/2023:06:52:23 +0000] GET /vortals HTTP/1.0 204 12615",
@@ -35,7 +38,7 @@ Note: The comment `//export go_filter` on function is required and it should be
3538
6. **Modify and return:**
3639

3740
- The determined region is added to the original JSON. The modified record will look like this:
38-
41+
3942
```bash
4043
{
4144
"log": "2023-10-02T06:52:52.843524746Z stdout F 122.30.117.241 - - [02/Oct/2023:06:52:23 +0000] GET /vortals HTTP/1.0 204 12615",
@@ -51,4 +54,4 @@ Note: The comment `//export go_filter` on function is required and it should be
5154

5255
7. The **main** function is empty because the primary function here **(go_filter)** is meant to be exported and used as a plugin.
5356

54-
Follow the [official documentation](https://docs.fluentbit.io/manual/development/wasm-filter-plugins) for more information on writing WASM plugins.
57+
Follow the [official documentation](https://docs.fluentbit.io/manual/development/wasm-filter-plugins) for more information on writing WASM plugins.

0 commit comments

Comments
 (0)