Skip to content

Commit f08af26

Browse files
committed
Docs: general: Removing not actually smart quotes
Signed-off-by: Lynette Miles <lynette.miles@chronosphere.io>
1 parent 0b3f472 commit f08af26

File tree

7 files changed

+11
-12
lines changed

7 files changed

+11
-12
lines changed

administration/configuring-fluent-bit/yaml/environment-variables-section.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Fluent Bit provides a set of predefined environment variables that can be used i
2929
3030
| Name | Description |
3131
|--|--|
32-
| `${HOSTNAME}` | The systems hostname. |
32+
| `${HOSTNAME}` | The system's hostname. |
3333

3434
## External Variables
3535

administration/configuring-fluent-bit/yaml/pipeline-section.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The `pipeline` section defines the flow of how data is collected, processed, and
1111

1212
## Example Configuration
1313

14-
Heres a simple example of a pipeline configuration:
14+
Here's a simple example of a pipeline configuration:
1515

1616
```yaml
1717
pipeline:

administration/configuring-fluent-bit/yaml/plugins-section.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ While Fluent Bit comes with a variety of built-in plugins, it also supports load
44

55
## 1. Inline YAML Section
66

7-
You can specify external plugins directly within your main YAML configuration file using the `plugins` section. Heres an example:
7+
You can specify external plugins directly within your main YAML configuration file using the `plugins` section. Here's an example:
88

99
```yaml
1010
plugins:
@@ -22,9 +22,9 @@ pipeline:
2222
match: '*'
2323
```
2424
25-
## 2. YAML Plugins File Included via plugins_file Option
25+
## 2. YAML Plugins File Included using the `plugins_file` Option
2626

27-
Alternatively, you can load external plugins from a separate YAML file by specifying the plugins_file option in the service section. Heres how to configure this:
27+
Alternatively, you can load external plugins from a separate YAML file by specifying the `plugins_file` option in the service section. Here's how to configure this:
2828

2929
```yaml
3030
service:
@@ -49,6 +49,5 @@ plugins:
4949

5050
### Key Points
5151

52-
- Built-in vs. External: Fluent Bit comes with many built-in plugins, but you can load external plugins at runtime to extend the tools functionality.
52+
- Built-in versus External: Fluent Bit comes with many built-in plugins, but you can load external plugins at runtime to extend the tool's functionality.
5353
- Loading Mechanism: External plugins must be shared object files (.so). You can define them inline in the main YAML configuration or include them from a separate YAML file for better modularity.
54-

administration/performance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ By increasing the buffer size, Fluent Bit will make fewer system calls (read(2))
2121
2222
## Fluent Bit and SIMD for JSON Encoding
2323
24-
Starting in Fluent Bit v3.2, performance improvements have been introduced for JSON encoding. Plugins that convert logs from Fluent Bits internal binary representation to JSON can now do so up to 30% faster using SIMD (Single Instruction, Multiple Data) optimizations.
24+
Starting in Fluent Bit v3.2, performance improvements have been introduced for JSON encoding. Plugins that convert logs from Fluent Bit's internal binary representation to JSON can now do so up to 30% faster using SIMD (Single Instruction, Multiple Data) optimizations.
2525
2626
### Enabling SIMD Support
2727

development/msgpack-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ MessagePack is a standard and well-defined format, refer to the official documen
88
This section provides an overview of the specific types used by Fluent Bit within the format to help anyone consuming it.
99

1010
* The data structure used by Fluent Bit is a 2-length [`fixarray`](https://github.com/msgpack/msgpack/blob/master/spec.md#array-format-family) of the timestamp and the data.
11-
* The timestamp comes from [`flb_time_append_to_msgpack`])(https://github.com/fluent/fluent-bit/blob/2138cee8f4878733956d42d82f6dcf95f0aa9339/src/flb_time.c#L197), so its either a `uint64`, a `float64`, or a [`fixext`](https://github.com/msgpack/msgpack/blob/master/spec.md#ext-format-family) where the 4 MSBs are the seconds (big-endian `uint32`) and 4 LSBs are nanoseconds.
11+
* The timestamp comes from [`flb_time_append_to_msgpack`])(https://github.com/fluent/fluent-bit/blob/2138cee8f4878733956d42d82f6dcf95f0aa9339/src/flb_time.c#L197), so it's either a `uint64`, a `float64`, or a [`fixext`](https://github.com/msgpack/msgpack/blob/master/spec.md#ext-format-family) where the 4 MSBs are the seconds (big-endian `uint32`) and 4 LSBs are nanoseconds.
1212
* The data itself is just a [`msgpack` map](https://github.com/msgpack/msgpack/blob/master/spec.md#map-format-family) with the keys as strings.
1313

1414
## Example

development/wasm-filter-plugins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ For Rust:
9797
// #[no_mangle] attribute is needed for preventing mangles and align C ABI.
9898
// Also we can use an arbitrary function name for filter operations w/ WASM.
9999
#[no_mangle]
100-
pub extern “C” fn rust_filter(tag: *const c_char, tag_len: u32, time_sec: u32, time_nsec: u32, record: *const c_char, record_len: u32)
100+
pub extern "C" fn rust_filter(tag: *const c_char, tag_len: u32, time_sec: u32, time_nsec: u32, record: *const c_char, record_len: u32)
101101
```
102102

103103
Note that `//export XXX` on TinyGo and `#[no_mangle]` attributes on Rust are required. This is because TinyGo and Rust will mangle their function names if they are not specified.
@@ -158,7 +158,7 @@ The output after the filter logic will be:
158158
```text
159159
[0] iis.*: [[1692131925.559486675, {}], {"c_authorization_header"=>"-", "c_ip"=>"::1", "cs_bytes"=>756, "cs_cookie"=>"-", "cs_host"=>"localhost", "cs_method"=>"GET", "cs_referer"=>"-", "cs_uri_query"=>"-", "cs_uri_stem"=>"/", "cs_user_agent"=>"Mozilla/5.0+(Windows+NT+10.0;+Win64;+x64)+AppleWebKit/537.36+(KHTML,+like+Gecko)+Chrome/115.0.0.0+Safari/537.36+Edg/115.0.1901.200", "date"=>"2023-08-11 19:56:44", "s_computername"=>"WIN-PC1", "s_ip"=>"::1", "s_port"=>"80", "s_sitename"=>"W3SVC1", "sc_bytes"=>142, "sc_status"=>"304", "source"=>"LogEntryIIS", "tag"=>"iis.*", "time"=>"2023-08-15T20:38:45.559486675 +0000", "time_taken"=>1078}]
160160
```
161-
This filter approach provides us with several powerful advantages inherent to programming languages.
161+
This filter approach provides us with several powerful advantages inherent to programming languages.
162162
For instance, it:
163163
- Can be extended by adding type conversion to fields such as `sc_bytes, cs_bytes, time_taken`. This is particularly useful when we need to validate our data results.
164164
- Allows for the use of conditions to apply more descriptive filters, for example, "get only all logs that contain status codes above 4xx or 5xx".

pipeline/outputs/vivo-exporter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Here is a simple configuration of Vivo Exporter, note that this example is not b
3232

3333
### How it works
3434

35-
Vivo Exporter provides buffers that serve as streams for each telemetry data type, in this case, `logs`, `metrics`, and `traces`. Each buffer contains a fixed capacity in terms of size (20M by default). When the data arrives at a stream, its appended to the end. If the buffer is full, it removes the older entries to make room for new data.
35+
Vivo Exporter provides buffers that serve as streams for each telemetry data type, in this case, `logs`, `metrics`, and `traces`. Each buffer contains a fixed capacity in terms of size (20M by default). When the data arrives at a stream, it's appended to the end. If the buffer is full, it removes the older entries to make room for new data.
3636

3737
The `data` that arrives is a `chunk`. A chunk is a group of events that belongs to the same type (logs, metrics or traces) and contains the same `tag`. Every chunk placed in a stream is assigned with an auto-incremented `id`.
3838

0 commit comments

Comments
 (0)