diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index c83a5382..540eb6a8 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -20,4 +20,4 @@ jobs: - name: Install codespell run: pip install codespell - name: Run codespell - run: codespell + run: codespell --exclude-file package-lock.json diff --git a/FOOTER.md b/FOOTER.md new file mode 100644 index 00000000..fe9d22c7 --- /dev/null +++ b/FOOTER.md @@ -0,0 +1,2 @@ +If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. + diff --git a/_layouts/website/page.html b/_layouts/website/page.html new file mode 100644 index 00000000..aa3c4054 --- /dev/null +++ b/_layouts/website/page.html @@ -0,0 +1,9 @@ +{% extends template.self %} + +{% block page %} +
+  Fluentd +
+ + {{ super() }} +{% endblock %} diff --git a/_redirects b/_redirects new file mode 100644 index 00000000..4024ff38 --- /dev/null +++ b/_redirects @@ -0,0 +1,212 @@ +/v1.0/articles/quickstart / 301 + +# Overview +/quickstart/td-agent-v2-vs-v3 /appendix/td-agent-v2-vs-v3-vs-v4/ 301 +/v1.0/articles/faq /quickstart/faq/ 301 +/v1.0/articles/fluent-package-v5-vs-td-agent-v4 /quickstart/fluent-package-v5-vs-td-agent/ 301 +/v1.0/articles/life-of-a-fluentd-event /quickstart/life-of-a-fluentd-event/ 301 +/v1.0/articles/logo /quickstart/logo/ 301 +/v1.0/articles/support /quickstart/support/ 301 +/v1.0/articles/td-agent-v2-vs-v3 /appendix/td-agent-v2-vs-v3-vs-v4/ 301 +/v1.0/articles/update-from-v0.12 /appendix/update-from-v0.12/ 301 + +# Install +/installation/install-by-deb /installation/ 301 +/installation/install-by-dmg /installation/ 301 +/installation/install-by-msi /installation/ 301 +/installation/install-by-rpm /installation/ 301 +/v1.0/articles/before-install /installation/before-install/ 301 +/v1.0/articles/install-by-deb /installation/ 301 +/v1.0/articles/install-by-deb-td-agent-v3 /installation/install-by-deb-td-agent-v3/ 301 +/v1.0/articles/install-by-deb-td-agent-v4 /installation/install-by-deb-td-agent-v4/ 301 +/v1.0/articles/install-by-dmg /installation/ 301 +/v1.0/articles/install-by-dmg-td-agent-v3 /installation/install-by-dmg-td-agent-v3/ 301 +/v1.0/articles/install-by-dmg-td-agent-v4 /installation/install-by-dmg-td-agent-v4/ 301 +/v1.0/articles/install-by-gem /installation/install-by-gem/ 301 +/v1.0/articles/install-by-msi /installation/ 301 +/v1.0/articles/install-by-msi-td-agent-v3 /installation/install-by-msi-td-agent-v3/ 301 +/v1.0/articles/install-by-msi-td-agent-v4 /installation/install-by-msi-td-agent-v4/ 301 +/v1.0/articles/install-by-rpm /installation/ 301 +/v1.0/articles/install-by-rpm-td-agent-v3 /installation/install-by-rpm-td-agent-v3/ 301 +/v1.0/articles/install-by-rpm-td-agent-v4 /installation/install-by-rpm-td-agent-v4/ 301 +/v1.0/articles/install-from-source /installation/install-from-source/ 301 +/v1.0/articles/post-installation-guide /installation/post-installation-guide/ 301 + +# Configuration +/v1.0/articles/buffer-section /configuration/buffer-section/ 301 +/v1.0/articles/config-file /configuration/config-file/ 301 +/v1.0/articles/config-file-yaml /configuration/config-file-yaml/ 301 +/v1.0/articles/extract-section /configuration/extract-section/ 301 +/v1.0/articles/format-section /configuration/format-section/ 301 +/v1.0/articles/inject-section /configuration/inject-section/ 301 +/v1.0/articles/parse-section /configuration/parse-section/ 301 +/v1.0/articles/plugin-common-parameters /configuration/plugin-common-parameters/ 301 +/v1.0/articles/routing-examples /configuration/routing-examples/ 301 +/v1.0/articles/storage-section /configuration/storage-section/ 301 +/v1.0/articles/transport-section /configuration/transport-section/ 301 + +# Deployment +/v1.0/articles/command-line-option /deployment/command-line-option/ 301 +/v1.0/articles/failure-scenarios /deployment/failure-scenarios/ 301 +/v1.0/articles/fluentd-ui /deployment/fluentd-ui/ 301 +/v1.0/articles/high-availability /deployment/high-availability/ 301 +/v1.0/articles/linux-capability /deployment/linux-capability/ 301 +/v1.0/articles/logging /deployment/logging/ 301 +/v1.0/articles/multi-process-workers /deployment/multi-process-workers/ 301 +/v1.0/articles/performance-tuning-single-process /deployment/performance-tuning-single-process/ 301 +/v1.0/articles/plugin-management /deployment/plugin-management/ 301 +/v1.0/articles/rpc /deployment/rpc/ 301 +/v1.0/articles/signals /deployment/signals/ 301 +/v1.0/articles/system-config /deployment/system-config/ 301 +/v1.0/articles/trouble-shooting /deployment/trouble-shooting/ 301 + +# Monitoring +/v1.0/articles/monitoring /monitoring-fluentd/overview/ 301 +/v1.0/articles/monitoring-prometheus /monitoring-fluentd/monitoring-prometheus/ 301 +/v1.0/articles/monitoring-rest-api /monitoring-fluentd/monitoring-rest-api/ 301 + +# Plugin/Input +/v1.0/articles/in_dummy /input/dummy/ 301 +/v1.0/articles/in_exec /input/exec/ 301 +/v1.0/articles/in_forward /input/forward/ 301 +/v1.0/articles/in_http /input/http/ 301 +/v1.0/articles/in_monitor_agent /input/monitor_agent/ 301 +/v1.0/articles/in_syslog /input/syslog/ 301 +/v1.0/articles/in_tail /input/tail/ 301 +/v1.0/articles/in_tcp /input/tcp/ 301 +/v1.0/articles/in_udp /input/udp/ 301 +/v1.0/articles/in_unix /input/unix/ 301 +/v1.0/articles/in_windows_eventlog /input/windows_eventlog/ 301 +/v1.0/articles/input-plugin-overview /input/ 301 + +# Plugin/Output +/v1.0/articles/out_copy /output/copy/ 301 +/v1.0/articles/out_elasticsearch /output/elasticsearch/ 301 +/v1.0/articles/out_exec /output/exec/ 301 +/v1.0/articles/out_exec_filter /output/exec_filter/ 301 +/v1.0/articles/out_file /output/file/ 301 +/v1.0/articles/out_forward /output/forward/ 301 +/v1.0/articles/out_mongo /output/mongo/ 301 +/v1.0/articles/out_mongo_replset /output/mongo_replset/ 301 +/v1.0/articles/out_null /output/null/ 301 +/v1.0/articles/out_opensearch /output/opensearch/ 301 +/v1.0/articles/out_relabel /output/relabel/ 301 +/v1.0/articles/out_rewrite_tag_filter /output/rewrite_tag_filter/ 301 +/v1.0/articles/out_roundrobin /output/roundrobin/ 301 +/v1.0/articles/out_s3 /output/s3/ 301 +/v1.0/articles/out_stdout /output/stdout/ 301 +/v1.0/articles/out_webhdfs /output/webhdfs/ 301 +/v1.0/articles/output-plugin-overview /output/ 301 + +# Plugin/Filter +/v1.0/articles/filter_geoip /filter/geoip/ 301 +/v1.0/articles/filter_parser /filter/parser/ 301 +/v1.0/articles/filter_record_transformer /filter/record_transformer/ 301 +/v1.0/articles/filter_stdout /filter/stdout/ 301 +/v1.0/articles/filter_grep /filter/grep/ 301 + +# Plugin/Parser +/v1.0/articles/parser-plugin-overview /parser/ 301 +/v1.0/articles/parser_apache2 /parser/apache2/ 301 +/v1.0/articles/parser_apache_error /parser/apache_error/ 301 +/v1.0/articles/parser_csv /parser/csv/ 301 +/v1.0/articles/parser_json /parser/json/ 301 +/v1.0/articles/parser_ltsv /parser/ltsv/ 301 +/v1.0/articles/parser_multiline /parser/multiline/ 301 +/v1.0/articles/parser_nginx /parser/nginx/ 301 +/v1.0/articles/parser_none /parser/none/ 301 +/v1.0/articles/parser_regexp /parser/regexp/ 301 +/v1.0/articles/parser_syslog /parser/syslog/ 301 +/v1.0/articles/parser_tsv /parser/tsv/ 301 +/v1.0/articles/storage-plugin-overview /storage/ 301 + +# Plugin/Formatter +/v1.0/articles/formatter_ltsv /formatter/ltsv/ 301 +/v1.0/articles/formatter_hash /formatter/hash/ 301 +/v1.0/articles/formatter_out_file /formatter/out_file/ 301 +/v1.0/articles/formatter_csv /formatter/csv/ 301 +/v1.0/articles/formatter_msgpack /formatter/msgpack/ 301 +/v1.0/articles/formatter_single_value /formatter/single_value/ 301 +/v1.0/articles/formatter_json /formatter/json/ 301 +/v1.0/articles/formatter_stdout /formatter/stdout/ 301 +/v1.0/articles/formatter_tsv /formatter/tsv/ 301 + +# Plugin/Buffer +/v1.0/articles/buffer-plugin-overview /buffer/ 301 +/v1.0/articles/buf_file /buffer/file/ 301 +/v1.0/articles/buf_memory /buffer/memory/ 301 + +# Plugin/Storage +/v1.0/articles/storage_local /storage/local/ 301 + +# Guides +/v1.0/articles/apache-to-mongodb /how-to-guides/apache-to-mongodb/ 301 +/v1.0/articles/filter-modify-apache /how-to-guides/filter-modify-apache/ 301 +/v1.0/articles/free-alternative-to-splunk-by-fluentd /how-to-guides/free-alternative-to-splunk-by-fluentd/ 301 +/v1.0/articles/http-to-hdfs /how-to-guides/http-to-hdfs/ 301 +/v1.0/articles/http-to-td /how-to-guides/http-to-td/ 301 +/v1.0/articles/kinesis-stream /how-to-guides/kinesis-stream/ 301 +/v1.0/articles/logs-to-sematext /how-to-guides/logs-to-sematext/ 301 +/v1.0/articles/parse-syslog /how-to-guides/parse-syslog/ 301 +# redirect renamed graylog guide +/v1.0/articles/apache-to-minio /how-to-guides/apache-to-minio/ 301 +/v1.0/articles/apache-to-s3 /how-to-guides/apache-to-s3/ 301 +/v1.0/articles/cep-norikra /how-to-guides/cep-norikra/ 301 +/v1.0/articles/graylog2 /how-to-guides/graylog/ 301 +/v1.0/articles/raspberrypi-cloud-data-logger /how-to-guides/raspberrypi-cloud-data-logger/ 301 +/v1.0/articles/splunk-like-grep-and-alert-email /how-to-guides/splunk-like-grep-and-alert-email/ 301 +/v1.0/articles/syslog-influxdb /how-to-guides/syslog-influxdb/ 301 + +# Language Bindings +/v1.0/articles/java /language-bindings/java/ 301 +/v1.0/articles/nodejs /language-bindings/nodejs/ 301 +/v1.0/articles/perl /language-bindings/perl/ 301 +/v1.0/articles/php /language-bindings/php/ 301 +/v1.0/articles/python /language-bindings/python/ 301 +/v1.0/articles/ruby /language-bindings/ruby/ 301 +/v1.0/articles/scala /language-bindings/scala/ 301 + +# Plugin Development +/v1.0/articles/api-config-types /plugin-development/api-config-types/ 301 +/v1.0/articles/api-plugin-base /plugin-development/api-plugin-base/ 301 +/v1.0/articles/api-plugin-buffer /plugin-development/api-plugin-buffer/ 301 +/v1.0/articles/api-plugin-filter /plugin-development/api-plugin-filter/ 301 +/v1.0/articles/api-plugin-formatter /plugin-development/api-plugin-formatter/ 301 +/v1.0/articles/api-plugin-input /plugin-development/api-plugin-input/ 301 +/v1.0/articles/api-plugin-output /plugin-development/api-plugin-output/ 301 +/v1.0/articles/api-plugin-parser /plugin-development/api-plugin-parser/ 301 +/v1.0/articles/api-plugin-storage /plugin-development/api-plugin-storage/ 301 +/v1.0/articles/plugin-development /plugin-development/ 301 +/v1.0/articles/plugin-test-code /plugin-development/plugin-test-code/ 301 +/v1.0/articles/plugin-update-from-v12 /plugin-development/plugin-update-from-v0.12/ 301 + +# Plugin Helper API +/v1.0/articles/plugin-helper-overview /plugin-helper-overview/ 301 +/v1.0/articles/api-plugin-helper-inject /plugin-helper-overview/api-plugin-helper-inject/ 301 +/v1.0/articles/api-plugin-helper-thread /plugin-helper-overview/api-plugin-helper-thread/ 301 +/v1.0/articles/api-plugin-helper-compat_parameters /plugin-helper-overview/api-plugin-helper-compat_parameters/ 301 +/v1.0/articles/api-plugin-helper-timer /plugin-helper-overview/api-plugin-helper-timer/ 301 +/v1.0/articles/api-plugin-helper-event_loop /plugin-helper-overview/api-plugin-helper-event_loop/ 301 +/v1.0/articles/api-plugin-helper-record_accessor /plugin-helper-overview/api-plugin-helper-record_accessor/ 301 +/v1.0/articles/api-plugin-helper-parser /plugin-helper-overview/api-plugin-helper-parser/ 301 +/v1.0/articles/api-plugin-helper-formatter /plugin-helper-overview/api-plugin-helper-formatter/ 301 +/v1.0/articles/api-plugin-helper-child_process /plugin-helper-overview/api-plugin-helper-child_process/ 301 +/v1.0/articles/api-plugin-helper-event_emitter /plugin-helper-overview/api-plugin-helper-event_emitter/ 301 +/v1.0/articles/api-plugin-helper-server /plugin-helper-overview/api-plugin-helper-server/ 301 +/v1.0/articles/api-plugin-helper-extract /plugin-helper-overview/api-plugin-helper-extract/ 301 +/v1.0/articles/api-plugin-helper-storage /plugin-helper-overview/api-plugin-helper-storage/ 301 +/v1.0/articles/api-plugin-helper-socket /plugin-helper-overview/api-plugin-helper-socket/ 301 +/v1.0/articles/api-plugin-helper-http_server /plugin-helper-overview/api-plugin-helper-http_server/ 301 +/v1.0/articles/api-plugin-helper-metrics /plugin-helper-overview/api-plugin-helper-metrics/ 301 + +# Obsolete Pages +/v1.0/categories/data-analytics / 301 +/v1.0/categories/data-archiving / 301 +/v1.0/categories/installation /installation/ 301 +/v1.0/categories/log-management-and-search / 301 +/v1.0/categories/logging-from-apps / 301 +/v1.0/categories/monitoring-service-logs / 301 +/v1.0/categories/plugin-advanced-sections / 301 +/v1.0/categories/plugin-apis / 301 +/v1.0/categories/plugin-development / 301 +/v1.0/categories/stream-processing / 301 diff --git a/appendix/README.md b/appendix/README.md index 678cba34..2c78f821 100644 --- a/appendix/README.md +++ b/appendix/README.md @@ -6,5 +6,3 @@ This section collects supplementary articles that do not fit into the other sect * [Update from v0.12 to v1](update-from-v0.12.md): how to update Fluentd to v1.0 from v0.12 or earlier. * [td-agent v2 vs v3 vs v4](td-agent-v2-vs-v3-vs-v4.md): differences between the `td-agent` series, kept for reference. Note that `td-agent` has already reached End of Life \(EOL\); use [`fluent-package`](../installation/install-fluent-package/) instead. - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. diff --git a/appendix/td-agent-v2-vs-v3-vs-v4.md b/appendix/td-agent-v2-vs-v3-vs-v4.md index 632aab93..c789ceee 100644 --- a/appendix/td-agent-v2-vs-v3-vs-v4.md +++ b/appendix/td-agent-v2-vs-v3-vs-v4.md @@ -58,6 +58,3 @@ This is for v0.12 and old distribution users. We don't recommend this version fo * [Windows](../installation/install-by-msi-td-agent-v4.md) * [macOS](../installation/install-by-dmg-td-agent-v4.md) * [RubyGems](../installation/install-by-gem.md) - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under [the Apache License 2.0.](https://www.apache.org/licenses/LICENSE-2.0) - diff --git a/appendix/update-from-v0.12.md b/appendix/update-from-v0.12.md index af2be11a..990e78fa 100644 --- a/appendix/update-from-v0.12.md +++ b/appendix/update-from-v0.12.md @@ -84,6 +84,3 @@ Fluentd v1 changes buffer mechanism for flexibility. The new buffer consists of ### Log Forwarding from v1.0 to v0.12 Log forwarding from v0.12 to v1.0 is no problem but log forwarding from v1.0 to v0.12 has a problem due to timestamp change. See [`in_forward`'s FAQ](https://fluentd.gitbook.io/manual/v/0.12/input/forward#i-got-messagepack-unknownexttypeerror-error-why) - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/book.json b/book.json index 6105dcab..93fe31dd 100644 --- a/book.json +++ b/book.json @@ -1,6 +1,35 @@ { "title": "Fluentd 1.0 Documentation", "plugins": [ - "hints" - ] + "anchors", + "breadcrumbs", + "copy-code-button", + "expandable-chapters", + "hints", + "intopic-toc", + "partial-summary", + "localized-footer", + "versions-select" + ], + + "pluginsConfig": { + "breadcrumbs": { + "separator": ">" + }, + "versions": { + "options": [ + { + "value": "/1.0/", + "text": "1.0" + }, + { + "value": "/0.12/", + "text": "0.12" + } + ] + } + }, + "styles": { + "website": "styles/website.css" + } } diff --git a/buffer/README.md b/buffer/README.md index 3d34f74d..c46d2e3a 100644 --- a/buffer/README.md +++ b/buffer/README.md @@ -215,6 +215,3 @@ This sometimes causes a problem when the output destination has a payload size l * [`buf_memory`](memory.md) * [`buf_file`](file.md) - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/buffer/file.md b/buffer/file.md index c5a2f56c..59e915e2 100644 --- a/buffer/file.md +++ b/buffer/file.md @@ -212,6 +212,3 @@ In such a case, it must not contain `[` or `]` in the actually evaluated `path`. If such a character was included in the path, it might be trouble (ignored) after restarting of Fluentd during resuming buffer handling process. As a workaround, override `path` parameter in `` section which does not contain such a character. {% endhint %} - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/buffer/file_single.md b/buffer/file_single.md index 96ed138b..a387a3a7 100644 --- a/buffer/file_single.md +++ b/buffer/file_single.md @@ -150,6 +150,3 @@ This limitation will be removed by adding the metadata header in the file in the {% hint style='warning' %} Caution: `file_single` buffer implementation depends on the characteristics of the local file system. Don't use `file_single` buffer on remote file systems e.g. NFS, GlusterFS, HDFS and etc. We observed major data loss by using remote file system. {% endhint %} - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/buffer/memory.md b/buffer/memory.md index a036a5d8..19c99d4d 100644 --- a/buffer/memory.md +++ b/buffer/memory.md @@ -23,6 +23,3 @@ If you want to understand buffer behavior precisely, see [Buffer Section Configu ``` - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/configuration/buffer-section.md b/configuration/buffer-section.md index e003240e..b875aa05 100644 --- a/configuration/buffer-section.md +++ b/configuration/buffer-section.md @@ -603,5 +603,3 @@ With `exponential_backoff`, `retry_wait` interval will be calculated as below: * k: number of retry times * total retry time: `c + c*b^1 + (...) + c*b^(k-1) = c*(b^k - 1) / (b - 1)` * = `2^k - 1` by default - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. diff --git a/configuration/config-file-yaml.md b/configuration/config-file-yaml.md index 71e1a75b..3aa35036 100644 --- a/configuration/config-file-yaml.md +++ b/configuration/config-file-yaml.md @@ -615,5 +615,3 @@ The backslash `\` is interpreted as an escape character. You need `\` for settin ```yaml str_param: "foo\nbar" # \n is interpreted as actual LF character ``` - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. diff --git a/configuration/config-file.md b/configuration/config-file.md index bebc4254..0054eea0 100644 --- a/configuration/config-file.md +++ b/configuration/config-file.md @@ -681,6 +681,3 @@ The backslash `\` is interpreted as an escape character. You need `\` for settin ```text str_param "foo\nbar" # \n is interpreted as actual LF character ``` - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/configuration/extract-section.md b/configuration/extract-section.md index 04ab8fec..31532775 100644 --- a/configuration/extract-section.md +++ b/configuration/extract-section.md @@ -95,6 +95,3 @@ The **extract** section can be under ``, ``, or `` sectio 3. `[+-]HH` \(e.g. "+09"\) 4. Region/Zone \(e.g. `Asia/Tokyo`\) 5. Region/Zone/Zone \(e.g. `America/Argentina/Buenos_Aires`\) - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/configuration/format-section.md b/configuration/format-section.md index 3886df0f..1d246d45 100644 --- a/configuration/format-section.md +++ b/configuration/format-section.md @@ -114,6 +114,3 @@ The `@type` parameter specifies the type of the formatter plugin. 3. `[+-]HH` \(e.g. "+09"\) 4. Region/Zone \(e.g. `Asia/Tokyo`\) 5. Region/Zone/Zone \(e.g. `America/Argentina/Buenos_Aires`\) - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/configuration/inject-section.md b/configuration/inject-section.md index 6a2ec0ff..848b3427 100644 --- a/configuration/inject-section.md +++ b/configuration/inject-section.md @@ -133,6 +133,3 @@ Injected Record: 3. `[+-]HH` \(e.g. "+09"\) 4. Region/Zone \(e.g. `Asia/Tokyo`\) 5. Region/Zone/Zone \(e.g. `America/Argentina/Buenos_Aires`\) - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/configuration/parse-section.md b/configuration/parse-section.md index ec486a3c..51bae00a 100644 --- a/configuration/parse-section.md +++ b/configuration/parse-section.md @@ -215,6 +215,3 @@ For the `types` parameter, the following types are supported: ``` In the above use case, the timestamp is parsed as `unixtime` at first, if it fails, then it is parsed as `%iso8601` secondary. Note that `time_format_fallbacks` is the last resort to parse mixed timestamp format. There is a performance penalty \(Typically, N fallbacks are specified in `time_format_fallbacks` and if the last specified format is used as a fallback, N times slower in the worst case\). - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/configuration/plugin-common-parameters.md b/configuration/plugin-common-parameters.md index ec5b00a4..2496854f 100644 --- a/configuration/plugin-common-parameters.md +++ b/configuration/plugin-common-parameters.md @@ -94,6 +94,3 @@ The `@label` parameter is to route the input events to ` ``` - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/configuration/service_discovery-section.md b/configuration/service_discovery-section.md index 058709b0..30527ce8 100644 --- a/configuration/service_discovery-section.md +++ b/configuration/service_discovery-section.md @@ -45,6 +45,3 @@ The `@type` parameter specifies the type of service discovery plugin. # ... ``` - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/configuration/storage-section.md b/configuration/storage-section.md index 0d55d5ec..ed4d1a54 100644 --- a/configuration/storage-section.md +++ b/configuration/storage-section.md @@ -55,6 +55,3 @@ The following parameters are common to all storage plugins. Individual storage p * Default: `10` * **`save_at_shutdown`** \(bool\) \(optional\): If `true`, the storage saves its data when the plugin shuts down. This takes effect regardless of `persistent` and `autosave`. * Default: `true` - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/configuration/transport-section.md b/configuration/transport-section.md index 291c0a66..ef31a716 100644 --- a/configuration/transport-section.md +++ b/configuration/transport-section.md @@ -167,6 +167,3 @@ For ``: * `generate_cert_digest`: \[enum: `sha1`/`sha256`/`sha384`/`sha512`\] * Default: `sha256` - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/container-deployment/docker-compose.md b/container-deployment/docker-compose.md index 0fd19285..395eaaaf 100644 --- a/container-deployment/docker-compose.md +++ b/container-deployment/docker-compose.md @@ -182,6 +182,3 @@ Then, go to `Discover` tab to check the logs. As you can see, logs are properly * [Fluentd: Architecture](https://www.fluentd.org/architecture) * [Fluentd: Get Started](../quickstart/) * [Downloading Fluentd](https://www.fluentd.org/download) - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/container-deployment/docker-logging-driver.md b/container-deployment/docker-logging-driver.md index 812c27cb..3705525e 100644 --- a/container-deployment/docker-logging-driver.md +++ b/container-deployment/docker-logging-driver.md @@ -281,6 +281,3 @@ This document describes how to set up a multi-container logging environment via In a production environment, you must use one of the container orchestration tools. Currently, Kubernetes has better integration with Fluentd, and we're working on making better integrations with other tools as well. * [Logging Architecture](https://kubernetes.io/docs/concepts/cluster-administration/logging/) - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/container-deployment/install-by-docker.md b/container-deployment/install-by-docker.md index 4058a178..e0e9317a 100644 --- a/container-deployment/install-by-docker.md +++ b/container-deployment/install-by-docker.md @@ -118,6 +118,3 @@ Also, refer to the following tutorials to learn how to collect data from various * [Store Apache Log into Amazon S3](../how-to-guides/apache-to-s3.md) * [Store Apache Log into MongoDB](../how-to-guides/apache-to-mongodb.md) * [Data Collection into HDFS](../how-to-guides/http-to-hdfs.md) - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/container-deployment/kubernetes.md b/container-deployment/kubernetes.md index 15aa0853..36af7f34 100644 --- a/container-deployment/kubernetes.md +++ b/container-deployment/kubernetes.md @@ -104,6 +104,3 @@ This YAML file contains two relevant environment variables that are used by Flue | `FLUENT_ELASTICSEARCH_SSL_VERSION` | Specify the version of TLS. | `TLSv1_2` | Any relevant change needs to be done in the YAML file before deployment. The defaults assume that at least one Elasticsearch Pod **elasticsearch-logging** exists in the cluster. - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/deployment/command-line-option.md b/deployment/command-line-option.md index d9c8e048..ff204d74 100644 --- a/deployment/command-line-option.md +++ b/deployment/command-line-option.md @@ -220,6 +220,3 @@ As for non-Windows, you don't have to use this function because you can manually ## `fluent-cap-ctl` Control Linux Capability for Fluentd. See [Linux Capability](linux-capability.md) article. - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/deployment/failure-scenarios.md b/deployment/failure-scenarios.md index 0d95b404..afc47c41 100644 --- a/deployment/failure-scenarios.md +++ b/deployment/failure-scenarios.md @@ -33,6 +33,3 @@ Please note that the data will be lost if the buffer file is broken due to I/O e If the storage destination \(e.g. Amazon S3, MongoDB, HDFS, etc.\) goes down, Fluentd will keep trying to resend the buffered data. The retry logic depends on the plugin implementation. If you're using [`buf_memory`](../buffer/memory.md), the aggregators will stop accepting new logs once they reach their buffer limits. If you are using [`buf_file`](../buffer/file.md), the aggregators will continue accepting logs until they run out of disk space. - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/deployment/fluentd-ui.md b/deployment/fluentd-ui.md index 760e68b8..e68c5e7c 100644 --- a/deployment/fluentd-ui.md +++ b/deployment/fluentd-ui.md @@ -77,6 +77,3 @@ The default account credentials are: ![](../.gitbook/assets/04.png) ![](../.gitbook/assets/05.png) - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/deployment/high-availability.md b/deployment/high-availability.md index 1ac4b26b..2c25088d 100644 --- a/deployment/high-availability.md +++ b/deployment/high-availability.md @@ -148,6 +148,3 @@ $ nmap -p 24224 -sU host ``` Please note that there is one [known issue](http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2019944) where VMware will occasionally lose small UDP packages used for the heartbeat. - -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - diff --git a/deployment/linux-capability.md b/deployment/linux-capability.md index 9f9a5c39..11b1ebe0 100644 --- a/deployment/linux-capability.md +++ b/deployment/linux-capability.md @@ -179,8 +179,6 @@ $ bundle exec fluentd -c in_tail_camouflage_permission.conf Fluentd, which is running by a non-root user, does not complain with `Permission denied`. Users can retrieve root files' contents on a non-root process, yay! -If this article is incorrect or outdated, or omits critical information, please [let us know](https://github.com/fluent/fluentd-docs-gitbook/issues?state=open). [Fluentd](https://www.fluentd.org/) is an open-source project under [Cloud Native Computing Foundation \(CNCF\)](https://cncf.io/). All components are available under the Apache 2 License. - ## Capability handling on docker container If you would like to collect logs from a file as a non-root user, you can use `CAP_DAC_READ_SEARCH` Linux capabilities. However, `CAP_DAC_READ_SEARCH` now cannot be used on a docker container by default. diff --git a/deployment/logging.md b/deployment/logging.md index 3320cc0f..27e4bf91 100644 --- a/deployment/logging.md +++ b/deployment/logging.md @@ -330,6 +330,3 @@ If an error occurs, you will get a notification message in your Slack `notify` c ### Deprecate Top-Level Match You can still use [v0.12 way](https://fluentd.gitbook.io/manual/v/0.12/deployment/logging#capture-fluentd-logs) without `