diff --git a/.github/workflows/linkcheck.yaml b/.github/workflows/linkcheck.yaml index 7c99c2828..6fd9abc10 100644 --- a/.github/workflows/linkcheck.yaml +++ b/.github/workflows/linkcheck.yaml @@ -3,6 +3,7 @@ name: Links on: schedule: - cron: "00 18 1 * *" + # Uncomment the following line while testing links in a single PR. Recomment when # done. Be sure to comment out the 'Create Issue from File' section while testing. # pull_request @@ -24,10 +25,10 @@ jobs: # If testing links on pull_request, comment these lines out! - - name: Create Issue From File - if: steps.lychee.outputs.exit_code != 0 - uses: peter-evans/create-issue-from-file@v5 - with: - title: Link Checker Report - content-filepath: ./lychee/out.md - labels: report, automated issue +# - name: Create Issue From File +# if: steps.lychee.outputs.exit_code != 0 +# uses: peter-evans/create-issue-from-file@v5 +# with: +# title: Link Checker Report +# content-filepath: ./lychee/out.md +# labels: report, automated issue diff --git a/development/wasm-filter-plugins.md b/development/wasm-filter-plugins.md index 84e474068..bfb236127 100644 --- a/development/wasm-filter-plugins.md +++ b/development/wasm-filter-plugins.md @@ -32,7 +32,7 @@ Fluent Bit supports the following Wasm tool chains: ## Get started -As described in the general options in the [source installation](../installation/sources/build-and-install.md) guide, Wasm support is enabled by default. Compile Fluent Bit with Wasm support, for example: +As described in the general options in the [source installation](../installation/downloads/source/build-and-install.md) guide, Wasm support is enabled by default. Compile Fluent Bit with Wasm support, for example: ```text cd build/ diff --git a/installation/downloads/kubernetes.md b/installation/downloads/kubernetes.md index 5c21fd9bf..92d3c954e 100644 --- a/installation/downloads/kubernetes.md +++ b/installation/downloads/kubernetes.md @@ -55,7 +55,7 @@ The default configuration of Fluent Bit ensures the following: - Consume all containers logs from the running node and parse them with either the `docker` or `cri` multi-line parser. - Persist how far it got into each file it's tailing so if a pod is restarted it picks up from where it left off. - The Kubernetes filter adds Kubernetes metadata, specifically `labels` and `annotations`. The filter only contacts the API Server when it can't find the cached information, otherwise it uses the cache. -- The default backend in the configuration is Elasticsearch set by the [Elasticsearch Output Plugin](../pipeline/outputs/elasticsearch.md). It uses the Logstash format to ingest the logs. If you need a different `Index` and `Type`, refer to the plugin option and update as needed. +- The default backend in the configuration is Elasticsearch set by the [Elasticsearch Output Plugin](../../pipeline/outputs/elasticsearch.md). It uses the Logstash format to ingest the logs. If you need a different `Index` and `Type`, refer to the plugin option and update as needed. - There is an option called `Retry_Limit`, which is set to `False`. If Fluent Bit can't flush the records to Elasticsearch, it will retry indefinitely until it succeeds. ## Windows deployment diff --git a/installation/downloads/linux.md b/installation/downloads/linux.md index 63a6e59d9..cb21e6675 100644 --- a/installation/downloads/linux.md +++ b/installation/downloads/linux.md @@ -33,7 +33,7 @@ The GPG Key fingerprint of the old key is: F209 D876 2A60 CD49 E680 633B 4FF8 368B 6EA0 722A ``` -Refer to the [supported platform documentation](supported-platforms.md) to see which platforms are supported in each release. +Refer to the [supported platform documentation](../getting-started-with-fluent-bit.md#supported-platforms-and-packages) to see which platforms are supported in each release. ## Migration to Fluent Bit diff --git a/installation/downloads/source/build-and-install.md b/installation/downloads/source/build-and-install.md index d853f3ba1..7837af78a 100644 --- a/installation/downloads/source/build-and-install.md +++ b/installation/downloads/source/build-and-install.md @@ -171,22 +171,22 @@ Filter plugins let you modify, enrich or drop records. The following table descr | Option | Description | Default | | :--- | :--- | :--- | -| [`FLB_FILTER_AWS`](../../pipeline/filters/aws-metadata.md) | Enable AWS metadata filter | `On` | -| [`FLB_FILTER_ECS`](../../pipeline/filters/ecs-metadata.md) | Enable AWS metadata filter | `On` | +| [`FLB_FILTER_AWS`](../../../pipeline/filters/aws-metadata.md) | Enable AWS metadata filter | `On` | +| [`FLB_FILTER_ECS`](../../../pipeline/filters/ecs-metadata.md) | Enable AWS metadata filter | `On` | | `FLB_FILTER_EXPECT` | Enable Expect data test filter | `On` | -| [`FLB_FILTER_GREP`](../../pipeline/filters/grep.md) | Enable Grep filter | `On` | -| [`FLB_FILTER_KUBERNETES`](../../pipeline/filters/kubernetes.md) | Enable Kubernetes metadata filter | `On` | -| [`FLB_FILTER_LUA`](../../pipeline/filters/lua.md) | Enable Lua scripting filter | `On` | -| [`FLB_FILTER_MODIFY`](../../pipeline/filters/modify.md) | Enable Modify filter | `On` | -| [`FLB_FILTER_NEST`](../../pipeline/filters/nest.md) | Enable Nest filter | `On` | -| [`FLB_FILTER_PARSER`](../../pipeline/filters/parser.md) | Enable Parser filter | `On` | -| [`FLB_FILTER_RECORD_MODIFIER`](../../pipeline/filters/record-modifier.md) | Enable Record Modifier filter | `On` | -| [`FLB_FILTER_REWRITE_TAG`](../../pipeline/filters/rewrite-tag.md) | Enable Rewrite Tag filter | `On` | -| [`FLB_FILTER_STDOUT`](../../pipeline/filters/standard-output.md) | Enable Stdout filter | `On` | -| [`FLB_FILTER_SYSINFO`](../../pipeline/filters/sysinfo.md) | Enable Sysinfo filter | `On` | -| [`FLB_FILTER_THROTTLE`](../../pipeline/filters/throttle.md) | Enable Throttle filter | `On` | -| [`FLB_FILTER_TYPE_CONVERTER`](../../pipeline/filters/type-converter.md) | Enable Type Converter filter | `On` | -| [`FLB_FILTER_WASM`](../../pipeline/filters/wasm.md) | Enable Wasm filter | `On` | +| [`FLB_FILTER_GREP`](../../../pipeline/filters/grep.md) | Enable Grep filter | `On` | +| [`FLB_FILTER_KUBERNETES`](../../../pipeline/filters/kubernetes.md) | Enable Kubernetes metadata filter | `On` | +| [`FLB_FILTER_LUA`](../../../pipeline/filters/lua.md) | Enable Lua scripting filter | `On` | +| [`FLB_FILTER_MODIFY`](../../../pipeline/filters/modify.md) | Enable Modify filter | `On` | +| [`FLB_FILTER_NEST`](../../../pipeline/filters/nest.md) | Enable Nest filter | `On` | +| [`FLB_FILTER_PARSER`](../../../pipeline/filters/parser.md) | Enable Parser filter | `On` | +| [`FLB_FILTER_RECORD_MODIFIER`](../../../pipeline/filters/record-modifier.md) | Enable Record Modifier filter | `On` | +| [`FLB_FILTER_REWRITE_TAG`](../../../pipeline/filters/rewrite-tag.md) | Enable Rewrite Tag filter | `On` | +| [`FLB_FILTER_STDOUT`](../../../pipeline/filters/standard-output.md) | Enable Stdout filter | `On` | +| [`FLB_FILTER_SYSINFO`](../../../pipeline/filters/sysinfo.md) | Enable Sysinfo filter | `On` | +| [`FLB_FILTER_THROTTLE`](../../../pipeline/filters/throttle.md) | Enable Throttle filter | `On` | +| [`FLB_FILTER_TYPE_CONVERTER`](../../../pipeline/filters/type-converter.md) | Enable Type Converter filter | `On` | +| [`FLB_FILTER_WASM`](../../../pipeline/filters/wasm.md) | Enable Wasm filter | `On` | ### Output plugins @@ -194,35 +194,35 @@ Output plugins let you flush the information to some external interface, service | Option | Description | Default | | :--- | :--- | :--- | -| [`FLB_OUT_AZURE`](../../pipeline/outputs/azure.md) | Enable Microsoft Azure output plugin | `On` | -| [`FLB_OUT_AZURE_KUSTO`](../../pipeline/outputs/azure_kusto.md) | Enable Azure Kusto output plugin | `On` | -| [`FLB_OUT_BIGQUERY`](../../pipeline/outputs/bigquery.md) | Enable Google BigQuery output plugin | `On` | -| [`FLB_OUT_COUNTER`](../../pipeline/outputs/counter.md) | Enable Counter output plugin | `On` | -| [`FLB_OUT_CLOUDWATCH_LOGS`](../../pipeline/outputs/cloudwatch.md) | Enable Amazon CloudWatch output plugin | `On` | -| [`FLB_OUT_DATADOG`](../../pipeline/outputs/datadog.md) | Enable Datadog output plugin | `On` | -| [`FLB_OUT_ES`](../../pipeline/outputs/elasticsearch.md) | Enable [Elastic Search](http://www.elastic.co) output plugin | `On` | -| [`FLB_OUT_FILE`](../../pipeline/outputs/file.md) | Enable File output plugin | `On` | -| [`FLB_OUT_KINESIS_FIREHOSE`](../../pipeline/outputs/firehose.md) | Enable Amazon Kinesis Data Firehose output plugin | `On` | -| [`FLB_OUT_KINESIS_STREAMS`](../../pipeline/outputs/kinesis.md) | Enable Amazon Kinesis Data Streams output plugin | `On` | -| [`FLB_OUT_FLOWCOUNTER`](../../pipeline/outputs/flowcounter.md) | Enable Flow counter output plugin | `On` | -| [`FLB_OUT_FORWARD`](../../pipeline/outputs/forward.md) | Enable [Fluentd](http://www.fluentd.org) output plugin | `On` | -| [`FLB_OUT_GELF`](../../pipeline/outputs/gelf.md) | Enable GELF output plugin | `On` | -| [`FLB_OUT_HTTP`](../../pipeline/outputs/http.md) | Enable HTTP output plugin | `On` | -| [`FLB_OUT_INFLUXDB`](../../pipeline/outputs/influxdb.md) | Enable InfluxDB output plugin | `On` | -| [`FLB_OUT_KAFKA`](../../pipeline/outputs/kafka.md) | Enable Kafka output | Off | -| [`FLB_OUT_KAFKA_REST`](../../pipeline/outputs/kafka-rest-proxy.md) | Enable Kafka REST Proxy output plugin | `On` | +| [`FLB_OUT_AZURE`](../../../pipeline/outputs/azure.md) | Enable Microsoft Azure output plugin | `On` | +| [`FLB_OUT_AZURE_KUSTO`](../../../pipeline/outputs/azure_kusto.md) | Enable Azure Kusto output plugin | `On` | +| [`FLB_OUT_BIGQUERY`](../../../pipeline/outputs/bigquery.md) | Enable Google BigQuery output plugin | `On` | +| [`FLB_OUT_COUNTER`](../../../pipeline/outputs/counter.md) | Enable Counter output plugin | `On` | +| [`FLB_OUT_CLOUDWATCH_LOGS`](../../../pipeline/outputs/cloudwatch.md) | Enable Amazon CloudWatch output plugin | `On` | +| [`FLB_OUT_DATADOG`](../../../pipeline/outputs/datadog.md) | Enable Datadog output plugin | `On` | +| [`FLB_OUT_ES`](../../../pipeline/outputs/elasticsearch.md) | Enable [Elastic Search](http://www.elastic.co) output plugin | `On` | +| [`FLB_OUT_FILE`](../../../pipeline/outputs/file.md) | Enable File output plugin | `On` | +| [`FLB_OUT_KINESIS_FIREHOSE`](../../../pipeline/outputs/firehose.md) | Enable Amazon Kinesis Data Firehose output plugin | `On` | +| [`FLB_OUT_KINESIS_STREAMS`](../../../pipeline/outputs/kinesis.md) | Enable Amazon Kinesis Data Streams output plugin | `On` | +| [`FLB_OUT_FLOWCOUNTER`](../../../pipeline/outputs/flowcounter.md) | Enable Flow counter output plugin | `On` | +| [`FLB_OUT_FORWARD`](../../../pipeline/outputs/forward.md) | Enable [Fluentd](http://www.fluentd.org) output plugin | `On` | +| [`FLB_OUT_GELF`](../../../pipeline/outputs/gelf.md) | Enable GELF output plugin | `On` | +| [`FLB_OUT_HTTP`](../../../pipeline/outputs/http.md) | Enable HTTP output plugin | `On` | +| [`FLB_OUT_INFLUXDB`](../../../pipeline/outputs/influxdb.md) | Enable InfluxDB output plugin | `On` | +| [`FLB_OUT_KAFKA`](../../../pipeline/outputs/kafka.md) | Enable Kafka output | Off | +| [`FLB_OUT_KAFKA_REST`](../../../pipeline/outputs/kafka-rest-proxy.md) | Enable Kafka REST Proxy output plugin | `On` | | `FLB_OUT_LIB` | Enable Lib output plugin | `On` | -| [`FLB_OUT_NATS`](../../pipeline/outputs/nats.md) | Enable [NATS](http://www.nats.io) output plugin | `On` | +| [`FLB_OUT_NATS`](../../../pipeline/outputs/nats.md) | Enable [NATS](http://www.nats.io) output plugin | `On` | | `FLB_OUT_NULL` | Enable `NULL` output plugin | `On` | | `FLB_OUT_PGSQL` | Enable PostgreSQL output plugin | `On` | | `FLB_OUT_PLOT` | Enable Plot output plugin | `On` | | `FLB_OUT_SLACK` | Enable Slack output plugin | `On` | -| [`FLB_OUT_S3`](../../pipeline/outputs/s3.md) | Enable Amazon S3 output plugin | `On` | -| [`FLB_OUT_SPLUNK`](../../pipeline/outputs/splunk.md) | Enable Splunk output plugin | `On` | -| [`FLB_OUT_STACKDRIVER`](../../pipeline/outputs/stackdriver.md) | Enable Google Stackdriver output plugin | `On` | +| [`FLB_OUT_S3`](../../../pipeline/outputs/s3.md) | Enable Amazon S3 output plugin | `On` | +| [`FLB_OUT_SPLUNK`](../../../pipeline/outputs/splunk.md) | Enable Splunk output plugin | `On` | +| [`FLB_OUT_STACKDRIVER`](../../../pipeline/outputs/stackdriver.md) | Enable Google Stackdriver output plugin | `On` | | [`FLB_OUT_STDOUT`](build-and-install.md) | Enable STDOUT output plugin | `On` | | `FLB_OUT_TCP` | Enable TCP/TLS output plugin | `On` | -| [`FLB_OUT_TD`](../../pipeline/outputs/treasure-data.md) | Enable [Treasure Data](http://www.treasuredata.com) output plugin | `On` | +| [`FLB_OUT_TD`](../../../pipeline/outputs/treasure-data.md) | Enable [Treasure Data](http://www.treasuredata.com) output plugin | `On` | ### Processor plugins @@ -232,5 +232,5 @@ The following table describes the processors available: | Option | Description | Default | | :--- | :--- | :--- | -| [`FLB_PROCESSOR_METRICS_SELECTOR`](../../pipeline/processors/metrics-selector.md) | Enable metrics selector processor | `On` | -| [`FLB_PROCESSOR_LABELS`](../../pipeline/processors/labels.md) | Enable metrics label manipulation processor | `On` | +| [`FLB_PROCESSOR_METRICS_SELECTOR`](../../../pipeline/processors/metrics-selector.md) | Enable metrics selector processor | `On` | +| [`FLB_PROCESSOR_LABELS`](../../../pipeline/processors/labels.md) | Enable metrics label manipulation processor | `On` | diff --git a/installation/downloads/source/build-with-static-configuration.md b/installation/downloads/source/build-with-static-configuration.md index 75bcb8774..6ff02008d 100644 --- a/installation/downloads/source/build-with-static-configuration.md +++ b/installation/downloads/source/build-with-static-configuration.md @@ -12,7 +12,7 @@ The following steps assume you are familiar with configuring Fluent Bit using te #### Configuration directory -In your file system, prepare a specific directory that will be used as an entry point for the build system to lookup and parse the configuration files. This directory must contain a minimum of one configuration file, called `fluent-bit.conf`, that contains the required [`SERVICE`](/administration/configuring-fluent-bit/yaml/service-section.md), [`INPUT`](../../pipeline/inputs.md), and [`OUTPUT`](../../pipeline/outputs.md) sections. +In your file system, prepare a specific directory that will be used as an entry point for the build system to lookup and parse the configuration files. This directory must contain a minimum of one configuration file, called `fluent-bit.conf`, that contains the required [`SERVICE`](../../../administration/configuring-fluent-bit/yaml/service-section.md), [`INPUT`](../../../pipeline/inputs.md), and [`OUTPUT`](../../../pipeline/outputs.md) sections. As an example, create a new `fluent-bit.yaml` file or `fluent-bit.conf` file: diff --git a/installation/getting-started-with-fluent-bit.md b/installation/getting-started-with-fluent-bit.md index c6a6ab379..111205119 100644 --- a/installation/getting-started-with-fluent-bit.md +++ b/installation/getting-started-with-fluent-bit.md @@ -17,7 +17,7 @@ All Fluent Bit installations must meet certain [requirements](./requirements.md) Fluent Bit software is available for a variety of platforms and can be installed using several methods. -You can [direct download and compile the source code](../installation/source.md). +You can [direct download and compile the source code](../installation/downloads/source.md). To select a package for a container or operating system, use the instructions for that option from the following links: