Merge pull request #1998 from fluent/lynettemiles/sc-143126/check-for-links-to-commits-and-404s

Author: esmerel

administration/configuring-fluent-bit/classic-mode/upstream-servers.md

@@ -1,6 +1,6 @@
 # Upstream servers
 
-Fluent Bit [output plugins](../../pipeline/outputs/) aim to connect to external services to deliver logs over the network. Being able to connect to one node (host) is normal and enough for more of the use cases, but there are other scenarios where balancing across different nodes is required. The `Upstream` feature provides this capability.
+Fluent Bit [output plugins](../../../pipeline/outputs/) aim to connect to external services to deliver logs over the network. Being able to connect to one node (host) is normal and enough for more of the use cases, but there are other scenarios where balancing across different nodes is required. The `Upstream` feature provides this capability.
 
 An `Upstream` defines a set of nodes that will be targeted by an output plugin, by the nature of the implementation an output plugin must support the `Upstream` feature. The following plugin has `Upstream` support:
 

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

@@ -18,7 +18,7 @@ Fluent Bit exposes certain pre-configured parsers (built-in) to solve specific m
 | Parser | Description |
 | ------ | ----------- |
 | `docker` | Process a log entry generated by a Docker container engine. This parser supports the concatenation of log entries split by Docker.      |
-| `cri` | Process a log entry generated by CRI-O container engine. Like the `docker` parser, it supports concatenation of log entries          |
+| `cri` | Process a log entry generated by CRI-O container engine. Like the `docker` parser, it supports concatenation of log entries.          |
 | `go`     | Process log entries generated by a Go based language application and perform concatenation if multiline messages are detected.          |
 | `python` | Process log entries generated by a Python based language application and perform concatenation if multiline messages are detected.      |
 | `java`   | Process log entries generated by a Google Cloud Java language application and perform concatenation if multiline messages are detected. |
@@ -35,7 +35,7 @@ To understand which multiline parser type is required for your use case you have
 | -------- | ----------- | ------- |
 | `name` | Specify a unique name for the multiline parser definition. A good practice is to prefix the name with the word `multiline_` to avoid confusion with normal parser definitions. | _none_ |
 | `type`          | Set the multiline mode. Fluent Bit supports the type `regex`.| _none_ |
-| `parser`        | Name of a pre-defined parser that must be applied to the incoming content before applying the regular expression rule. If no parser is defined, it's assumed that's a raw text and not a structured message. <br /> When a parser is applied to a raw text, the regular expression is applied against a specific key of the structured message by using the `key_content` configuration property. | _none_ |
+| `parser`        | Name of a pre-defined parser that must be applied to the incoming content before applying the regular expression rule. If no parser is defined, it's assumed that's a raw text and not a structured message. When a parser is applied to a raw text, the regular expression is applied against a specific key of the structured message by using the `key_content` configuration property. | _none_ |
 | `key_content`   | For an incoming structured message, specify the key that contains the data that should be processed by the regular expression and possibly concatenated. | _none_ |
 | `flush_timeout` | Timeout in milliseconds to flush a non-terminated multiline buffer. | `5s` |
 | `rule`          | Configure a rule to match a multiline pattern. The rule has a [specific format](#rules-definition). Multiple rules can be defined. | _none_|
@@ -59,7 +59,7 @@ A rule specifies how to match a multiline pattern and perform the concatenation.
 - regular expression pattern
 - next state
 
-A rule might be defined as follows (comments added to simplify the definition) in corresponding YAML and classic  configuration examples below:
+A rule might be defined as follows (comments added to simplify the definition) in corresponding YAML and classic configuration examples below:
 
 {% tabs %}
 {% tab title="parsers_multiline.yaml" %}
@@ -90,12 +90,12 @@ rule         "cont"          "/^\s+at.*/"                      "cont"
 {% endtab %}
 {% endtabs %}
 
-This example defines two rules. Each rule has its own state name, regex patterns, and the next state name. Every field that composes a rule must be inside double quotes.
+This example defines two rules. Each rule has its own state name, regular expression patterns, and the next state name. Every field that composes a rule must be inside double quotes.
 
-The first rule of a state name must be `start_state`. The regex pattern must match the first line of a multiline message, and a next state must be set to specify what the possible continuation lines look like.
+The first rule of a state name must be `start_state`. The regular expression pattern must match the first line of a multiline message, and a next state must be set to specify what the possible continuation lines look like.
 
 {% hint style="info" %}
-To simplify the configuration of regular expressions, you can use the [Rubular]((https://rubular.com/r/NDuyKwlTGOvq2g)) web site. This link uses the regex described in the previous example, plus a log line that matches the pattern:
+To simplify the configuration of regular expressions, you can use the [Rubular](https://rubular.com/r/NDuyKwlTGOvq2g) web site. This link uses the regular expression described in the previous example, plus a log line that matches the pattern:
 {% endhint %}
 
 #### Configuration example

administration/configuring-fluent-bit/unit-sizes.md

@@ -1,12 +1,12 @@
 # Unit sizes
 
-Some configuration directives in Fluent Bit refer to unit sizes such as when defining the size of a buffer or specific limits. Plugins like [Tail Input](https://github.com/fluent/fluent-bit-docs/tree/5f926fd1330690179b8c1edab90d672699599ec7/administration/input/tail.md), [Forward Input](https://github.com/fluent/fluent-bit-docs/tree/5f926fd1330690179b8c1edab90d672699599ec7/administration/input/forward.md) or generic properties like [Mem\_Buf\_Limit](https://github.com/fluent/fluent-bit-docs/tree/5f926fd1330690179b8c1edab90d672699599ec7/administration/configuring-fluent-bit/backpressure.md) use unit sizes.
+Some configuration directives in [Fluent Bit](http://fluentbit.io) refer to unit sizes such as when defining the size of a buffer or specific limits. Plugins like [Tail Input](../../pipeline/inputs/tail), [Forward Input](../../pipeline/inputs/forward.md) or generic properties like [`Mem_Buf_Limit`](../backpressure) use unit sizes.
 
-[Fluent Bit](http://fluentbit.io) v0.11.10 standardized unit sizes across the core and plugins. The following table describes the options that can be used and what they mean:
+Fluent Bit v0.11.10 standardized unit sizes across the core and plugins. The following table describes the options that can be used and what they mean:
 
 | Suffix | Description | Example |
 | :--- | :--- | :--- |
-|  | When a suffix isn't specified, assume that the value given is a bytes representation. | Specifying a value of 32000 means 32000 bytes. |
-| `k`, `K`, `KB`, `kb` | Kilobyte: a unit of memory equal to 1,000 bytes. | 32k means 32000 bytes. |
-| `m`, `M`, `MB`, `mb` | Megabyte: a unit of memory equal to 1,000,000 bytes. | 1M means 1000000 bytes. |
-| `g`, `G`, `GB`, `gb` | Gigabyte: a unit of memory equal to 1,000,000,000 bytes. | 1G means 1000000000 bytes. |
+|  | When a suffix isn't specified, assume that the value given is a bytes representation. | Specifying a value of `32000` means 32000 bytes. |
+| `k`, `K`, `KB`, `kb` | Kilobyte: a unit of memory equal to 1,000 bytes. | `32k` means 32000 bytes. |
+| `m`, `M`, `MB`, `mb` | Megabyte: a unit of memory equal to 1,000,000 bytes. | `1M` means 1000000 bytes. |
+| `g`, `G`, `GB`, `gb` | Gigabyte: a unit of memory equal to 1,000,000,000 bytes. | `1G` means 1000000000 bytes. |

administration/monitoring.md

@@ -62,7 +62,7 @@ pipeline:
 {% endtab %}
 {% endtabs %}
 
-Start Fluent bit with the corresponding configuration chosen above:
+Start Fluent bit with the corresponding configuration chosen previously:
 
 ```shell
 # For YAML configuration.
@@ -381,15 +381,15 @@ When querying the related metrics, the aliases are returned instead of the plugi
 
 You can create Grafana dashboards and alerts using Fluent Bit's exposed Prometheus style metrics.
 
-The provided [example dashboard](https://github.com/fluent/fluent-bit-docs/blob/master/monitoring/dashboard.json) is heavily inspired by [Banzai Cloud](https://banzaicloud.com)'s [logging operator dashboard](https://grafana.com/grafana/dashboards/7752) with a few key differences, such as the use of the `instance` label, stacked graphs, and a focus on Fluent Bit metrics. See [this blog post](https://www.robustperception.io/controlling-the-instance-label) for more information.
+The provided [example dashboard](https://github.com/fluent/fluent-bit-docs/blob/master/monitoring/dashboard.json) is heavily inspired by [Banzai Cloud](https://github.com/banzaicloud)'s [logging operator dashboard](https://grafana.com/grafana/dashboards/7752) with a few key differences, such as the use of the `instance` label, stacked graphs, and a focus on Fluent Bit metrics. See [this blog post](https://www.robustperception.io/controlling-the-instance-label) for more information.
 
 ![dashboard](/.gitbook/assets/dashboard.png)
 
 ### Alerts
 
-Sample alerts are available [here](https://github.com/fluent/fluent-bit-docs/blob/master/monitoring/alerts.yaml).
+Sample alerts [are available](https://github.com/fluent/fluent-bit-docs/blob/master/monitoring/alerts.yaml).
 
-## Health Check for Fluent Bit
+## Health check for Fluent Bit
 
 Fluent bit supports the following configurations to set up the health check.
 

administration/troubleshooting.md

@@ -2,19 +2,19 @@
 
 <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=759ddb3d-b363-4ee6-91fa-21025259767a" />
 
-- [Tap: generate events or records](troubleshooting.md#tap)
-- [Dump internals signal](troubleshooting#dump-internals-signal)
+- [Tap: generate events or records](#tap)
+- [Dump internals signal](#dump-internals-and-signal)
 
 ## Tap
 
 Tap can be used to generate events or records detailing what messages pass through Fluent Bit, at what time and what filters affect them.
 
-### Basic Tap example
+### Tap example
 
 Ensure that the container image supports Fluent Bit Tap (available in Fluent Bit 2.0+):
 
 ```shell
-$ docker run --rm -ti fluent/fluent-bit:latest --help | grep trace
+docker run --rm -ti fluent/fluent-bit:latest --help | grep trace
   -Z, --enable-chunk-traceenable chunk tracing, it can be activated either through the http api or the command line
   --trace-input           input to start tracing on startup.
   --trace-output          output to use for tracing on startup.
@@ -27,7 +27,7 @@ If the `--enable-chunk-trace` option is present, your Fluent Bit version support
 You can start Fluent Bit with tracing activated from the beginning by using the `trace-input` and `trace-output` properties:
 
 ```bash
-$ fluent-bit -Z -i dummy -o stdout -f 1 --trace-input=dummy.0 --trace-output=stdout
+fluent-bit -Z -i dummy -o stdout -f 1 --trace-input=dummy.0 --trace-output=stdout
 Fluent Bit v2.1.8
 * Copyright (C) 2015-2022 The Fluent Bit Authors
 * Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
@@ -338,7 +338,7 @@ This filter record is an example to explain the details of a Tap record:
 - `plugin_alias`: If an alias is set this field will contain the alias set for a plugin.
 - `records`: An array of all the records being sent. Fluent Bit handles records in chunks of multiple records and chunks are indivisible, the same is done in the Tap output. Each record consists of its timestamp followed by the actual data which is a composite type of keys and values.
 
-## Dump Internals / Signal
+## Dump Internals and signal
 
 When the service is running, you can export [metrics](monitoring.md) to see the overall status of the data flow of the service. There are other use cases where you might need to know the current status of the service internals, like the current status of the internal buffers. Dump Internals can help provide this information.
 
@@ -436,7 +436,7 @@ Depending of the buffering strategy and limits imposed by configuration, some Ch
 |  | `size` | Amount of bytes used by the Chunk. |
 |  | `size err` | Number of Chunks in an error state where its size couldn't be retrieved. |
 
-### Storage Layer
+### Storage layer
 
 Fluent Bit relies on a custom storage layer interface designed for hybrid buffering. The `Storage Layer` entry contains a total summary of Chunks registered by Fluent Bit:
 

concepts/data-pipeline/parser.md

@@ -26,7 +26,7 @@ The parser converts unstructured data to structured data. As an example, conside
 192.168.2.20 - - [28/Jul/2006:10:27:10 -0300] "GET /cgi-bin/try/ HTTP/1.0" 200 3395
 ```
 
-This log line is a raw string without format. Structuring the log makes it easier to process the data later. If the [regular expression parser](pipeline/parsers/regular-expression) is used, the log entry could be converted to:
+This log line is a raw string without format. Structuring the log makes it easier to process the data later. If the [regular expression parser](../../pipeline/parsers/regular-expression) is used, the log entry could be converted to:
 
 ```javascript
 {

installation/docker.md

@@ -16,27 +16,31 @@ Use the following command to start Fluent Bit while using a configuration file:
 
 {% tabs %}
 {% tab title="fluent-bit.conf" %}
+
 ```shell
 docker run -ti -v ./fluent-bit.conf:/fluent-bit/etc/fluent-bit.conf \
   cr.fluentbit.io/fluent/fluent-bit
 ```
+
 {% endtab %}
 
 {% tab title="fluent-bit.yaml" %}
+
 ```shell
 docker run -ti -v ./fluent-bit.yaml:/fluent-bit/etc/fluent-bit.yaml \
   cr.fluentbit.io/fluent/fluent-bit \
   -c /fluent-bit/etc/fluent-bit.yaml
+
 ```
+
 {% endtab %}
 {% endtabs %}
 
-
 ## Tags and versions
 
 The following table describes the Linux container tags that are available on Docker Hub [fluent/fluent-bit](https://hub.docker.com/r/fluent/fluent-bit/) repository:
 
-| Tag(s)       | Manifest Architectures    | Description                                                    |
+| Tags       | Manifest Architectures    | Description                                                    |
 | ------------ | ------------------------- | -------------------------------------------------------------- |
 | 4.0.4-debug | x86_64, arm64v8, arm32v7, s390x | Debug images |
 | 4.0.4 | x86_64, arm64v8, arm32v7, s390x | Release [v4.0.4](https://fluentbit.io/announcements/v4.0.4/) |
@@ -122,8 +126,6 @@ The following table describes the Linux container tags that are available on Doc
 | 2.1.6 | x86_64, arm64v8, arm32v7 | Release [v2.1.6](https://fluentbit.io/announcements/v2.1.6/) |
 | 2.1.5 | x86_64, arm64v8, arm32v7 | Release [v2.1.5](https://fluentbit.io/announcements/v2.1.5/) |
 | 2.1.5-debug | x86_64, arm64v8, arm32v7 | Debug images |
-| 2.1.4 | x86_64, arm64v8, arm32v7 | Release [v2.1.4](https://fluentbit.io/announcements/v2.1.4/) |
-| 2.1.4-debug | x86_64, arm64v8, arm32v7 | Debug images |
 | 2.1.3 | x86_64, arm64v8, arm32v7 | Release [v2.1.3](https://fluentbit.io/announcements/v2.1.3/) |
 | 2.1.3-debug | x86_64, arm64v8, arm32v7 | Debug images |
 | 2.1.2 | x86_64, arm64v8, arm32v7 | Release [v2.1.2](https://fluentbit.io/announcements/v2.1.2/) |
@@ -189,7 +191,7 @@ From a deployment perspective, there's no need to specify an architecture. The c
 
 ## Verify signed container images
 
-Version 1.9 and 2.0 container images are signed using Cosign/Sigstore. Verify these signatures using `cosign` ([install guide](https://docs.sigstore.dev/cosign/installation/)):
+Version 1.9 and 2.0 container images are signed using Cosign/Sigstore. Verify these signatures using `cosign` ([install guide](https://docs.sigstore.dev/quickstart/quickstart-cosign/)):
 
 ```shell
 $ cosign verify --key "https://packages.fluentbit.io/fluentbit-cosign.pub" fluent/fluent-bit:2.0.6

installation/kubernetes.md

@@ -4,8 +4,6 @@ description: Kubernetes Production Grade Log Processor
 
 # Kubernetes
 
-![](<../.gitbook/assets/fluentbit\_kube\_logging (1).png>)
-
 [Fluent Bit](http://fluentbit.io) is a lightweight and extensible log processor with full support for Kubernetes:
 
 - Process Kubernetes containers logs from the file system or Systemd/Journald.
@@ -16,17 +14,17 @@ description: Kubernetes Production Grade Log Processor
 
 Before getting started it's important to understand how Fluent Bit will be deployed. Kubernetes manages a cluster of nodes. The Fluent Bit log agent tool needs to run on every node to collect logs from every pod. Fluent Bit is deployed as a DaemonSet, which is a pod that runs on every node of the cluster.
 
-When Fluent Bit runs, it reads, parses, and filters the logs of every pod. In addition, Fluent Bit adds metadata to each entry using the [Kubernetes](../pipeline/filters/kubernetes) filter plugin.
+When Fluent Bit runs, it reads, parses, and filters the logs of every pod. In addition, Fluent Bit adds metadata to each entry using the [Kubernetes](https://docs.fluentbit.io/manual/pipeline/filters/kubernetes) filter plugin.
 
 The Kubernetes filter plugin talks to the Kubernetes API Server to retrieve relevant information such as the `pod_id`, `labels`, and `annotations`. Other fields, such as `pod_name`, `container_id`, and `container_name`, are retrieved locally from the log file names. All of this is handled automatically, and no intervention is required from a configuration aspect.
 
 ## Installation
 
-[Fluent Bit](http://fluentbit.io) should be deployed as a DaemonSet, so it will be available on every node of your Kubernetes cluster.
+Fluent Bit should be deployed as a DaemonSet, so it will be available on every node of your Kubernetes cluster.
 
-The recommended way to deploy Fluent Bit for Kubernetes is with the official Helm Chart at <https://github.com/fluent/helm-charts>.
+The recommended way to deploy Fluent Bit for Kubernetes is with the official [Helm Chart](https://github.com/fluent/helm-charts).
 
-### Note for OpenShift
+### OpenShift
 
 If you are using Red Hat OpenShift you must set up Security Context Constraints (SCC) using the relevant option in the helm chart.
 
@@ -46,7 +44,7 @@ To validate that the repository was added, run `helm search repo fluent` to ensu
 helm upgrade --install fluent-bit fluent/fluent-bit
 ```
 
-### Default Values
+### Default values
 
 The default chart values include configuration to read container logs. With Docker parsing, Systemd logs apply Kubernetes metadata enrichment, and output to an Elasticsearch cluster. You can modify the [included values file](https://github.com/fluent/helm-charts/blob/master/charts/fluent-bit/values.yaml) to specify additional outputs, health checks, monitoring endpoints, or other configuration options.
 

installation/linux/raspbian-raspberry-pi.md

@@ -1,10 +1,10 @@
-# Raspbian and Raspberry Pi
+# Raspberry Pi
 
-Fluent Bit is distributed as the `fluent-bit` package and is available for the Raspberry, specifically for [Raspbian](http://raspbian.org) distribution. The following versions are supported:
+Fluent Bit is distributed as the `fluent-bit` package and is available for [Raspberry Pi](https://www.raspberrypi.com/software/operating-systems/). The following versions are supported:
 
-* Raspbian Bookworm (12)
-* Raspbian Bullseye (11)
-* Raspbian Buster (10)
+- Raspbian Bookworm (12)
+- Raspbian Bullseye (11)
+- Raspbian Buster (10)
 
 ## Server GPG key