From 2e1acbc27d1cbecfa98546b56b7b64267dd925fd Mon Sep 17 00:00:00 2001 From: Kentaro Hayashi Date: Fri, 17 Jul 2026 14:22:29 +0900 Subject: [PATCH] input/output: add hint markup Closes: #405 Signed-off-by: Kentaro Hayashi --- input/windows_eventlog.md | 5 +++++ output/elasticsearch.md | 5 ++++- output/kafka.md | 5 +++++ output/mongo.md | 5 ++++- output/mongo_replset.md | 5 +++++ output/opensearch.md | 5 ++++- output/rewrite_tag_filter.md | 9 +++++++++ output/s3.md | 5 ++++- output/webhdfs.md | 5 ++++- 9 files changed, 44 insertions(+), 5 deletions(-) diff --git a/input/windows_eventlog.md b/input/windows_eventlog.md index f343575f..42306e8a 100644 --- a/input/windows_eventlog.md +++ b/input/windows_eventlog.md @@ -2,6 +2,11 @@ The `in_windows_eventlog` Input plugin allows Fluentd to read events from the Windows Event Log. +{% hint style='warning' %} +This document doesn't describe all/most of parameters. For details, refer to the **Further Reading** section. +If you afford to improve this article, please send pull request to https://github.com/fluent/fluentd-docs-gitbook +{% endhint %} + ## Installation `in_windows_eventlog` is included in `td-agent` 3 MSI by default. Fluentd gem users will need to install the `fluent-plugin-windows-eventlog` gem using the following command: diff --git a/output/elasticsearch.md b/output/elasticsearch.md index c6269b6c..9fc49c26 100644 --- a/output/elasticsearch.md +++ b/output/elasticsearch.md @@ -6,7 +6,10 @@ The `out_elasticsearch` Output plugin writes records into Elasticsearch. By defa Records will be sent to Elasticsearch when the `chunk_keys` condition has been met. To change the output frequency, please specify the `time` in `chunk_keys` and specify `timekey` value in the configuration. -This document does not describe all the parameters. For details, refer to the **Further Reading** section. +{% hint style='warning' %} +This document doesn't describe all/most of parameters. For details, refer to the **Further Reading** section. +If you afford to improve this article, please send pull request to https://github.com/fluent/fluentd-docs-gitbook +{% endhint %} ## Installation diff --git a/output/kafka.md b/output/kafka.md index 9e97f365..f33e4c3a 100644 --- a/output/kafka.md +++ b/output/kafka.md @@ -4,6 +4,11 @@ The `out_kafka2` Output plugin writes records into [Apache Kafka](https://kafka.apache.org/). +{% hint style='warning' %} +This document doesn't describe all/most of parameters. For details, refer to the **Further Reading** section. +If you afford to improve this article, please send pull request to https://github.com/fluent/fluentd-docs-gitbook +{% endhint %} + ## Installation `out_kafka2` is included in `td-agent`. Fluentd gem users will need to install the `fluent-plugin-kafka` gem using the following command: diff --git a/output/mongo.md b/output/mongo.md index add17125..d5636be9 100644 --- a/output/mongo.md +++ b/output/mongo.md @@ -6,7 +6,10 @@ The `out_mongo` Output plugin writes records into [MongoDB](http://mongodb.org/) If you're using `ReplicaSet`, please see the [`out_mongo_replset`](mongo_replset.md) article instead. -This document does not describe all the parameters. For details, check the **Further Reading** section. +{% hint style='warning' %} +This document doesn't describe all/most of parameters. For details, refer to the **Further Reading** section. +If you afford to improve this article, please send pull request to https://github.com/fluent/fluentd-docs-gitbook +{% endhint %} ## Why Fluentd with MongoDB? diff --git a/output/mongo_replset.md b/output/mongo_replset.md index 89c3841b..e67e4fcb 100644 --- a/output/mongo_replset.md +++ b/output/mongo_replset.md @@ -8,6 +8,11 @@ This plugin is for users using ReplicaSet. If you are not using `ReplicaSet`, pl This plugin has breaking changes since 0.8.0 due to mongo-ruby driver's breaking changes. If you are using a prior 0.7.x series, please be careful to upgrade 1.0.0 or later versions. +{% hint style='warning' %} +This document doesn't describe all/most of parameters. For details, refer to the **Further Reading** section. +If you afford to improve this article, please send pull request to https://github.com/fluent/fluentd-docs-gitbook +{% endhint %} + ## Why Fluentd with MongoDB? Fluentd enables your apps to insert records to MongoDB asynchronously with batch-insertion, unlike direct insertion of records from your apps. This has the following advantages: diff --git a/output/opensearch.md b/output/opensearch.md index 0763b5d5..cc7371e0 100644 --- a/output/opensearch.md +++ b/output/opensearch.md @@ -4,7 +4,10 @@ The `out_opensearch` Output plugin writes records into OpenSearch. By default, i Records will be sent to OpenSearch when the `chunk_keys` condition has been met. To change the output frequency, please specify the `time` in `chunk_keys` and specify `timekey` value in the configuration. -This document does not describe all the parameters. For details, refer to the **Further Reading** section. +{% hint style='warning' %} +This document doesn't describe all/most of parameters. For details, refer to the **Further Reading** section. +If you afford to improve this article, please send pull request to https://github.com/fluent/fluentd-docs-gitbook +{% endhint %} ## Installation diff --git a/output/rewrite_tag_filter.md b/output/rewrite_tag_filter.md index d3309a47..e262c448 100644 --- a/output/rewrite_tag_filter.md +++ b/output/rewrite_tag_filter.md @@ -2,6 +2,11 @@ The `out_rewrite_tag_filter` Output plugin provides a rule-based mechanism for rewriting tags. +{% hint style='warning' %} +This document doesn't describe all/most of parameters. For details, refer to the **Further Reading** section. +If you afford to improve this article, please send pull request to https://github.com/fluent/fluentd-docs-gitbook +{% endhint %} + ## How It Works The plugin is configured by defining a list of rules containing conditional statements and information on how to rewrite the matching tags. @@ -504,5 +509,9 @@ In this case, `rewrite_tag_filter` causes an infinite loop because the fluentd's ``` +## Further Reading + +* [`fluent-plugin-rewrite-tag-filter`](https://github.com/fluent/fluent-plugin-rewrite-tag-filter) + 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](http://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/output/s3.md b/output/s3.md index 7cc6e042..5934e1b7 100644 --- a/output/s3.md +++ b/output/s3.md @@ -6,7 +6,10 @@ The `out_s3` Output plugin writes records into the Amazon S3 cloud object storag The file will be created when the `timekey` condition has been met. To change the output frequency, please modify the `timekey` value in the buffer section. For more details, see [time chunk keys](../configuration/buffer-section.md#time). -This document doesn't describe all parameters. If you want to know full features, check the Further Reading section. +{% hint style='warning' %} +This document doesn't describe all/most of parameters. For details, refer to the **Further Reading** section. +If you afford to improve this article, please send pull request to https://github.com/fluent/fluentd-docs-gitbook +{% endhint %} ## Installation diff --git a/output/webhdfs.md b/output/webhdfs.md index bd7e70da..ba5fbfb1 100644 --- a/output/webhdfs.md +++ b/output/webhdfs.md @@ -6,7 +6,10 @@ The `out_webhdfs` Output plugin writes records into HDFS \(Hadoop Distributed Fi The file will be created when the `timekey` condition has been met. To change the output frequency, please modify the `timekey` value. -This document does not describe all the parameters. For more details, see the **Further Reading** section. +{% hint style='warning' %} +This document doesn't describe all/most of parameters. For details, refer to the **Further Reading** section. +If you afford to improve this article, please send pull request to https://github.com/fluent/fluentd-docs-gitbook +{% endhint %} ## Install