Skip to content

Commit 63218e2

Browse files
authored
Merge pull request #2027 from fluent/lynettemiles/sc-143136/ci-cd-add-a-link-checker
2 parents 454fc3b + c9b1bd3 commit 63218e2

File tree

15 files changed

+24
-23
lines changed

15 files changed

+24
-23
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Unit sizes
22

3-
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.
3+
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.md), [Forward Input](../../pipeline/inputs/forward.md), or generic properties like [`Mem_Buf_Limit`](../backpressure.md) use unit sizes.
44

55
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:
66

administration/configuring-fluent-bit/yaml/configuration-file.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ description: Learn about the YAML configuration file used by Fluent Bit
44

55
# YAML configuration file
66

7-
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=864c6f0e-8977-4838-8772-84416943548e" />
7+
<img referrerpolicy="no-referrer-when-downgrade"
8+
src="https://static.scarf.sh/a.png?x-pxid=864c6f0e-8977-4838-8772-84416943548e" alt="" />
89

910
One of the ways to configure Fluent Bit is using a YAML configuration file that works at a global scope.
1011

concepts/data-pipeline/parser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The parser converts unstructured data to structured data. As an example, conside
2626
192.168.2.20 - - [28/Jul/2006:10:27:10 -0300] "GET /cgi-bin/try/ HTTP/1.0" 200 3395
2727
```
2828

29-
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:
29+
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.md) is used, the log entry could be converted to:
3030

3131
```javascript
3232
{

local-testing/validating-your-data-and-structure.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Fluent Bit supports multiple sources and formats. In addition, it provides filte
44

55
Fluent Bit users are encouraged to integrate data validation in their continuous integration (CI) systems.
66

7-
In a normal production environment, inputs, filters, and outputs are defined in configuration files. Fluent Bit provides the [Expect](../pipeline/filters/expect) filter, which you can use to validate keys and values from your records and take action when an exception is found.
7+
In a normal production environment, inputs, filters, and outputs are defined in configuration files. Fluent Bit provides the [Expect](../pipeline/filters/expect.md) filter, which you can use to validate keys and values from your records and take action when an exception is found.
88

99
A simplified view of the data processing pipeline is as follows:
1010

@@ -20,8 +20,8 @@ IS --> Fil --> OD
2020

2121
Consider the following pipeline, which uses a JSON file as its data source and has two filters:
2222

23-
- [Grep](../pipeline/filters/grep) to exclude certain records.
24-
- [Record Modifier](../pipeline/filters/record-modifier) to alter records' content by adding and removing specific keys.
23+
- [Grep](../pipeline/filters/grep.md) to exclude certain records.
24+
- [Record Modifier](../pipeline/filters/record-modifier.md) to alter records' content by adding and removing specific keys.
2525

2626
```mermaid
2727
flowchart LR
@@ -37,7 +37,7 @@ record --> stdout
3737

3838
Add data validation between each step to ensure your data structure is correct.
3939

40-
This example uses the [Expect](../pipeline/filters/expect) filter.
40+
This example uses the [Expect](../pipeline/filters/expect.md) filter.
4141

4242
```mermaid
4343
flowchart LR
@@ -164,7 +164,7 @@ The following is the Fluent Bit classic parsers file:
164164
{% endtab %}
165165
{% endtabs %}
166166

167-
If the JSON parser fails or is missing in the [Tail](../pipeline/inputs/tail) input (`parser json`), the Expect filter triggers the `exit` action.
167+
If the JSON parser fails or is missing in the [Tail](../pipeline/inputs/tail.md) input (`parser json`), the Expect filter triggers the `exit` action.
168168

169169
To extend the pipeline, add a Grep filter to match records that map `label` containing a key called `name` with value the `abc`, and add an Expect filter to re-validate that condition:
170170

pipeline/filters/checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The plugin supports the following configuration parameters
99
| Key | Description | Default |
1010
| :-- | :---------- | :------ |
1111
| `file` | The single value file that Fluent Bit will use as a lookup table to determine if the specified `lookup_key` exists. | _none_ |
12-
| `lookup_key` | The specific key to look up and determine if it exists. Supports [record accessor](../../administration/configuring-fluent-bit/classic-mode/record-accessor). | _none_ |
12+
| `lookup_key` | The specific key to look up and determine if it exists. Supports [record accessor](../../administration/configuring-fluent-bit/classic-mode/record-accessor.md). | _none_ |
1313
| `record` | The record to add if the `lookup_key` is found in the specified `file`. You can add multiple record parameters. | _none_ |
1414
| `mode` | Set the check mode. `exact` and `partial` are supported. | `exact`|
1515
| `print_query_time` | Print to stdout the elapsed query time for every matched record. | `false` |

pipeline/filters/grep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To start filtering records, run the filter from the command line or through the
3939

4040
When using the command line, pay close attention to quote the regular expressions. Using a configuration file might be easier.
4141

42-
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`:
42+
The following command loads the [tail](../../pipeline/inputs/tail.md) 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
4545
fluent-bit -i tail -p 'path=lines.txt' -F grep -p 'regex=log aa' -m '*' -o stdout

pipeline/filters/log_to_metrics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ The plugin supports the following configuration parameters:
2626
| `metric_description` | Required. Sets a description for the metric. | |
2727
| `bucket` | Required for mode `histogram`. Defines a bucket for histograms. | For example, `0.75` |
2828
| `add_label` | Adds a custom label `NAME` and set the value to the value of `KEY`. | |
29-
| `label_field` | Includes a record field as label dimension in the metric. | Name of record key. Supports [record accessor](../../administration/configuring-fluent-bit/classic-mode/record-accessor) notation for nested fields. |
30-
| `value_field` | Required for modes `gauge` and `histogram`. Specifies the record field that holds a numerical value. | Name of record key. Supports [record accessor](../../administration/configuring-fluent-bit/classic-mode/record-accessor) notation for nested fields. |
31-
| `kubernetes_mode` | If enabled, adds `pod_id`, `pod_name`, `namespace_name`, `docker_id` and `container_name` to the metric as labels. This option is intended to be used in combination with the [Kubernetes](./kubernetes) filter plugin, which fills those fields. | |
29+
| `label_field` | Includes a record field as label dimension in the metric. | Name of record key. Supports [record accessor](../../administration/configuring-fluent-bit/classic-mode/record-accessor.md) notation for nested fields. |
30+
| `value_field` | Required for modes `gauge` and `histogram`. Specifies the record field that holds a numerical value. | Name of record key. Supports [record accessor](../../administration/configuring-fluent-bit/classic-mode/record-accessor.md) notation for nested fields. |
31+
| `kubernetes_mode` | If enabled, adds `pod_id`, `pod_name`, `namespace_name`, `docker_id` and `container_name` to the metric as labels. This option is intended to be used in combination with the [Kubernetes](./kubernetes.md) filter plugin, which fills those fields. | |
3232
| `Regex` | Includes records in which the content of `KEY` matches the regular expression. | `KEY REGEX` |
3333
| `Exclude` | Excludes records in which the content of `KEY` matches the regular expression. | `KEY REGEX` |
3434
| `Flush_Interval_Sec` | The interval for metrics emission, in seconds. If `Flush_Interval_Sec` and `Flush_Interval_Nsec` are either both unset or both set to `0`, the filter emits metrics immediately after each filter match. Otherwise, if either parameter is set to a non-zero value, the filter emits metrics at the specified interval. Longer intervals help lower resource consumption in high-load situations. Default value: `0`. | |

pipeline/inputs/process.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The _Process metrics_ input plugin lets you check how healthy a process is. It does so by performing service checks at specified intervals.
44

5-
This plugin creates metrics that are log-based, such as JSON payloads. For Prometheus-based metrics, see the [Node exporter metrics](./node-exporter-metrics) input plugin.
5+
This plugin creates metrics that are log-based, such as JSON payloads. For Prometheus-based metrics, see the [Node exporter metrics](./node-exporter-metrics.md) input plugin.
66

77
## Configuration parameters
88

@@ -16,7 +16,7 @@ The plugin supports the following configuration parameters:
1616
| `Alert` | If enabled, the plugin will only generate messages if the target process is down. | `false` |
1717
| `Fd` | If enabled, a number of `fd` is appended to each record. | `true` |
1818
| `Mem` | If enabled, memory usage of the process is appended to each record. | `true` |
19-
| `Threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading#inputs). | `false` |
19+
| `Threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2020

2121
## Get started
2222

pipeline/outputs/azure_kusto.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Fluent Bit uses the application's credentials to ingest data into your cluster.
2626

2727
- [Register an application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app#register-an-application)
2828
- [Add a client secret](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app#add-a-client-secret)
29-
- [Authorize the app in your database](https://docs.microsoft.com/en-us/azure/data-explorer/kusto/management/access-control/principals-and-identity-providers#azure-ad-tenants)
29+
- [Authorize the app in your database](https://learn.microsoft.com/en-us/azure/app-service/overview-authentication-authorization)
3030

3131
## Create a table
3232

pipeline/outputs/kinesis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This is the documentation for the core Fluent Bit Kinesis plugin written in C. I
1010

1111
This `kinesis_streams` plugin always uses a random partition key when uploading records to Kinesis through the [PutRecords API](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecords.html).
1212

13-
For information about how AWS credentials are fetched, see [AWS credentials](../../administration/aws-credentials).
13+
For information about how AWS credentials are fetched, see [AWS credentials](../../administration/aws-credentials.md).
1414

1515
## Configuration parameters
1616

0 commit comments

Comments
 (0)