Skip to content

Commit 8706155

Browse files
authored
Docs analytics fixes applied for entire documentation site. Fixes #2052.
* Adding in deleted scarf pixel for analytics tracking on SQL processor docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on Labels processor docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on Metrics Selector processor docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on Content Modifier processor docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on YAML config file admin docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on classic config file variables admin docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on type converter filter docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on log to metrics filter docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on classic config file admin docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on multiline parsing admin docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on lua filter docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on memory management admin docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on backpressure admin docs. Signed-off-by: Eric D. Schabell <[email protected]> * Adding in deleted scarf pixel for analytics tracking on sandbox lab resources docs. Signed-off-by: Eric D. Schabell <[email protected]> --------- Signed-off-by: Eric D. Schabell <[email protected]>
1 parent c6890c5 commit 8706155

File tree

14 files changed

+38
-10
lines changed

14 files changed

+38
-10
lines changed

about/sandbox-and-lab-resources.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ description: >-
66

77
# Sandbox and lab resources
88

9+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=83d7b072-bdfc-4f7d-810d-3ab42267ff54" />
10+
911
## Open Source labs - environment required
1012

1113
The following are open source labs where you will need to spin up resources to run through the lab in details
@@ -32,4 +34,4 @@ Fluent Bit Workshop for Getting Started with Cloud Native Telemetry Pipelines
3234

3335
This workshop by Amazon goes through common Kubernetes logging patterns and routing data to OpenSearch and visualizing with OpenSearch dashboards
3436

35-
{% embed url="https://eksworkshop.com/" %}
37+
{% embed url="https://eksworkshop.com/" %}

administration/backpressure.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Backpressure
22

3+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=63e37cfe-9ce3-4a18-933a-76b9198958c1" />
4+
35
It's possible for logs or data to be ingested or created faster than the ability to flush it to some destinations. A common scenario is when reading from big log files, especially with a large backlog, and dispatching the logs to a backend over the network, which takes time to respond. This generates _backpressure_, leading to high memory consumption in the service.
46

57
To avoid backpressure, Fluent Bit implements a mechanism in the engine that restricts the amount of data an input plugin can ingest. Restriction is done through the configuration parameters `Mem_Buf_Limit` and `storage.Max_Chunks_Up`.
@@ -68,4 +70,4 @@ With `storage.type filesystem` and `storage.max_chunks_up`, the following log me
6870
```text
6971
[input] {input name or alias} paused (storage buf overlimit)
7072
[input] {input name or alias} resume (storage buf overlimit)
71-
```
73+
```

administration/configuring-fluent-bit/classic-mode/configuration-file.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Configuration file
22

3+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=5e67142e-3887-4b56-b940-18494bcc23a7" />
4+
35
One of the ways to configure Fluent Bit is using a main configuration file. Fluent Bit allows the use one configuration file that works at a global scope and uses the defined [Format and Schema](format-schema.md).
46

57
The main configuration file supports four sections:

administration/configuring-fluent-bit/classic-mode/variables.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Variables
22

3+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=1731c7b5-34c6-424f-bfc6-88c2aa71e81f" />
4+
35
Fluent Bit supports the usage of environment variables in any value associated to a key when using a configuration file.
46

57
The variables are case sensitive and can be used in the following format:

administration/configuring-fluent-bit/multiline-parsing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Multiline parsing
22

3+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=e19a4c14-a9e4-4163-8f3a-52196eb9a585" />
4+
35
In an ideal world, applications might log their messages within a single line, but in reality applications generate multiple log messages that sometimes belong to the same context. Processing this information can be complex, like in application stack traces, which always have multiple log lines.
46

57
Fluent Bit v1.8 implemented a unified Multiline core capability to solve corner cases.

administration/configuring-fluent-bit/yaml.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# YAML configuration
22

3+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=864c6f0e-8977-4838-8772-84416943548e" />
4+
35
## Before you get started
46

57
Fluent Bit traditionally offered a `classic` configuration mode, a custom configuration format that's phasing out. While `classic` mode has served well for many years, it has several limitations. Its basic design only supports grouping sections with key-value pairs and lacks the ability to handle sub-sections or complex data structures like lists.
@@ -41,4 +43,4 @@ To access detailed configuration guides for each section, use the following link
4143
- [Environment Variables Section documentation](./yaml/environment-variables-section.md)
4244
- Information on setting environment variables and their scope within Fluent Bit.
4345
- [Includes Section documentation](./yaml/includes-section.md)
44-
- Description on how to include external YAML files.
46+
- Description on how to include external YAML files.

administration/memory-management.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Memory management
22

3+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=5cc3ce54-e910-4ebf-85f5-f02530b3e11b" />
4+
35
You might need to estimate how much memory Fluent Bit could be using in scenarios like containerized environments where memory limits are essential.
46

57
To make an estimate, in-use input plugins must set the `Mem_Buf_Limit`option. Learn more about it in [Backpressure](backpressure.md).
@@ -33,4 +35,4 @@ FLB_HAVE_PROXY_GO FLB_HAVE_JEMALLOC JEMALLOC_MANGLE FLB_HAVE_REGEX
3335
FLB_HAVE_C_TLS FLB_HAVE_SETJMP FLB_HAVE_ACCEPT4 FLB_HAVE_INOTIFY
3436
```
3537

36-
If the `FLB_HAVE_JEMALLOC` option is listed in `Build Flags`, jemalloc is enabled.
38+
If the `FLB_HAVE_JEMALLOC` option is listed in `Build Flags`, jemalloc is enabled.

pipeline/filters/log_to_metrics.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: Generate metrics from logs
44

55
# Logs to metrics
66

7+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=768830f6-8d2d-4231-9e5e-259ce6797ba5" />
8+
79
The _log to metrics_ filter lets you generate log-derived metrics. It supports modes to count records, provide a gauge for field values, or create a histogram. You can also match or exclude specific records based on regular expression patterns for values or nested values.
810

911
This filter doesn't actually act as a record filter and therefore doesn't change or drop records. All records will pass through this filter untouched, and any generated metrics will be emitted into a separate metric pipeline.
@@ -530,4 +532,4 @@ The `+Inf` bucket will always be included regardless of the buckets you specify.
530532

531533
{% endhint %}
532534

533-
This filter also attaches Kubernetes labels to each metric, identical to the behavior of `label_field`. This results in two sets for the histogram.
535+
This filter also attaches Kubernetes labels to each metric, identical to the behavior of `label_field`. This results in two sets for the histogram.

pipeline/filters/lua.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Lua
22

3+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=f519378e-536c-4b25-8949-ee6ed8d8d6c1" />
4+
35
The _Lua_ filter lets you modify incoming records (or split one record into multiple records) using custom [Lua](https://www.lua.org/) scripts.
46

57
A Lua-based filter requires two steps:
@@ -804,4 +806,4 @@ pipeline:
804806

805807
```text
806808
test: [[1731990257.781970977, {}], {"my_env"=>{"A"=>"aaa", "C"=>"ccc", "HOSTNAME"=>"monox-2.lan", "B"=>"bbb"}, "rand_value"=>4805047635809401856}]
807-
```
809+
```

pipeline/filters/type-converter.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Type converter
22

3+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=8984f540-d95a-462b-8a08-09f72f5fab63" />
4+
35
The _Type converter_ filter plugin converts data types and appends new key-value pairs.
46

57
You can use this filter in combination with plugins which expect incoming string value. For example, [Grep](grep.md) and [Modify](modify.md).
@@ -88,4 +90,4 @@ The output will be
8890

8991
```text
9092
[0] mem.0: [1639915154.160159749, {"Mem.total"=>8146052, "Mem.used"=>4513564, "Mem.free"=>3632488, "Swap.total"=>1918356, "Swap.used"=>0, "Swap.free"=>1918356, "Mem.total_str"=>"8146052", "Mem.used_str"=>"4513564", "Mem.free_str"=>"3632488"}]
91-
```
93+
```

0 commit comments

Comments
 (0)