From 02dfc5ae44d0efc5b86bb966d0b72d6987b9edae Mon Sep 17 00:00:00 2001 From: "Eric D. Schabell" Date: Fri, 28 Nov 2025 15:34:13 +0100 Subject: [PATCH 1/4] Fixed dummy input plugin doc with missing config option and standard layout. Fixes #2243. Signed-off-by: Eric D. Schabell --- pipeline/inputs/dummy.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/pipeline/inputs/dummy.md b/pipeline/inputs/dummy.md index a886994cc..a5a83b6ee 100644 --- a/pipeline/inputs/dummy.md +++ b/pipeline/inputs/dummy.md @@ -6,19 +6,20 @@ The _Dummy_ input plugin generates dummy events. Use this plugin for testing, de The plugin supports the following configuration parameters: -| Key | Description | Default | -|:-------------------|:------------------------------------------------------------------------------------------------------------------------|:----------------------| -| `Dummy` | Dummy JSON record. | `{"message":"dummy"}` | -| `Metadata` | Dummy JSON metadata. | `{}` | -| `Start_time_sec` | Dummy base timestamp, in seconds. | `0` | -| `Start_time_nsec` | Dummy base timestamp, in nanoseconds. | `0` | -| `Rate` | Rate at which messages are generated expressed in how many times per second. | `1` | -| `Interval_sec` | Set time interval, in seconds, at which every message is generated. If set, `Rate` configuration is ignored. | `0` | -| `Interval_nsec` | Set time interval, in nanoseconds, at which every message is generated. If set, `Rate` configuration is ignored. | `0` | -| `Samples` | If set, the events number will be limited. For example, if Samples=3, the plugin generates only three events and stops. | _none_ | -| `Copies` | Number of messages to generate each time messages generate. | `1` | -| `Flush_on_startup` | If set to `true`, the first dummy event is generated at startup. | `false` | -| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | +| Key | Description | Default | +|:----|:------------|:--------| +| `copies` | Number of messages to generate each time messages are generated. | `1` | +| `dummy` | Dummy JSON record. | `{"message":"dummy"}` | +| `fixed_timestamp` | If enabled, use a fixed timestamp. This allows the message to be pre-generated once. | `false` | +| `flush_on_startup` | If set to `true`, the first dummy event is generated at startup. | `false` | +| `interval_nsec` | Set time interval, in nanoseconds, at which every message is generated. If set, `rate` configuration is ignored. | `0` | +| `interval_sec` | Set time interval, in seconds, at which every message is generated. If set, `rate` configuration is ignored. | `0` | +| `metadata` | Dummy JSON metadata. | `{}` | +| `rate` | Rate at which messages are generated, expressed in how many times per second. | `1` | +| `samples` | Limit the number of events generated. For example, if `samples=3`, the plugin generates only three events and stops. `0` means no limit. | `0` | +| `start_time_nsec` | Set a dummy base timestamp, in nanoseconds. If set to `-1`, the current time is used. | `-1` | +| `start_time_sec` | Set a dummy base timestamp, in seconds. If set to `-1`, the current time is used. | `-1` | +| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | ## Get started @@ -65,7 +66,7 @@ pipeline: ```text [INPUT] Name dummy - Dummy {"message": "custom dummy"} + Dummy {"message": "custom dummy"} [OUTPUT] Name stdout From fcc58929c12d4aceff0aea6fc826990fd496d2e7 Mon Sep 17 00:00:00 2001 From: "Eric D. Schabell" Date: Fri, 28 Nov 2025 16:14:32 +0100 Subject: [PATCH 2/4] Fixed elasticsearch input plugin doc with missing config parameters and some cleanup. Fixed #2245. Signed-off-by: Eric D. Schabell --- pipeline/inputs/elasticsearch.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/pipeline/inputs/elasticsearch.md b/pipeline/inputs/elasticsearch.md index 8dfa7d3f6..4a8cefe4b 100644 --- a/pipeline/inputs/elasticsearch.md +++ b/pipeline/inputs/elasticsearch.md @@ -8,13 +8,20 @@ The plugin supports the following configuration parameters: | Key | Description | Default value | |:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:--------------| -| `buffer_max_size` | Set the maximum size of buffer. | `4M` | | `buffer_chunk_size` | Set the buffer chunk size. | `512K` | -| `tag_key` | Specify a key name for extracting as a tag. | `NULL` | -| `meta_key` | Specify a key name for meta information. | `@meta` | +| `buffer_max_size` | Set the maximum size of buffer. | `4M` | | `hostname` | Specify hostname or fully qualified domain name. This parameter can be used for "sniffing" (auto-discovery of) cluster node information. | `localhost` | -| `version` | Specify Elasticsearch server version. This parameter is effective for checking a version of Elasticsearch/OpenSearch server version. | `8.0.0` | +| `http2` | Enable HTTP/2 support. | `true` | +| `listen` | The address to listen on. | `0.0.0.0` | +| `meta_key` | Specify a key name for meta information. | `@meta` | +| `port` | The port for Fluent Bit to listen on. | `9200` | +| `tag_key` | Specify a key name for extracting as a tag. | `NULL` | | `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | +| `version` | Specify Elasticsearch server version. This parameter is effective for checking a version of Elasticsearch/OpenSearch server version. | `8.0.0` | + +### TLS / SSL + +The Elasticsearch input plugin supports TLS/SSL. For more details about the properties available and general configuration, refer to [Transport Security](../../administration/transport-security.md). The Elasticsearch cluster uses "sniffing" to optimize the connections between its cluster and clients, which means it builds its cluster and dynamically generate a connection list. The `hostname` will be used for sniffing information and this is handled by the sniffing endpoint. From 1aff26ed973da1d512d07d0a5ccea05a2ebe1a0f Mon Sep 17 00:00:00 2001 From: "Eric D. Schabell" Date: Fri, 28 Nov 2025 17:02:34 +0100 Subject: [PATCH 3/4] Added fixes for review comments. Signed-off-by: Eric D. Schabell --- pipeline/inputs/elasticsearch.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/pipeline/inputs/elasticsearch.md b/pipeline/inputs/elasticsearch.md index 4a8cefe4b..819da2cc4 100644 --- a/pipeline/inputs/elasticsearch.md +++ b/pipeline/inputs/elasticsearch.md @@ -21,9 +21,19 @@ The plugin supports the following configuration parameters: ### TLS / SSL -The Elasticsearch input plugin supports TLS/SSL. For more details about the properties available and general configuration, refer to [Transport Security](../../administration/transport-security.md). +The Elasticsearch input plugin supports TLS/SSL for receiving data from Beats agents or other clients over encrypted connections. For more details about the properties available and general configuration, refer to [Transport Security](../../administration/transport-security.md). -The Elasticsearch cluster uses "sniffing" to optimize the connections between its cluster and clients, which means it builds its cluster and dynamically generate a connection list. The `hostname` will be used for sniffing information and this is handled by the sniffing endpoint. +When configuring TLS for Elasticsearch ingestion, common options include: + +- `tls.verify`: Enable or disable certificate validation for incoming connections. +- `tls.ca_file`: Specify a CA certificate to validate client certificates when using mutual TLS (mTLS). +- `tls.crt_file` and `tls.key_file`: Provide the server certificate and private key. + +### Sniffing + +Elasticsearch clients use a process called "sniffing" to automatically discover cluster nodes. When a client connects, it can query the cluster to retrieve a list of available nodes and their addresses. This allows the client to distribute requests across the cluster and adapt when nodes join or leave. + +The `hostname` parameter specifies the hostname or fully qualified domain name that Fluent Bit returns during sniffing requests. Clients use this information to build their connection list. Set this value to match how clients should reach this Fluent Bit instance (for example, an external IP or load balancer address rather than `localhost` in production environments). ## Get started From 2277daa4a9bb8b04b38a7f6324025616bcb708e3 Mon Sep 17 00:00:00 2001 From: "Eric D. Schabell" Date: Fri, 28 Nov 2025 17:10:08 +0100 Subject: [PATCH 4/4] Fixed another review comment. Signed-off-by: Eric D. Schabell --- pipeline/inputs/elasticsearch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/inputs/elasticsearch.md b/pipeline/inputs/elasticsearch.md index 819da2cc4..8532f3c89 100644 --- a/pipeline/inputs/elasticsearch.md +++ b/pipeline/inputs/elasticsearch.md @@ -17,7 +17,7 @@ The plugin supports the following configuration parameters: | `port` | The port for Fluent Bit to listen on. | `9200` | | `tag_key` | Specify a key name for extracting as a tag. | `NULL` | | `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | -| `version` | Specify Elasticsearch server version. This parameter is effective for checking a version of Elasticsearch/OpenSearch server version. | `8.0.0` | +| `version` | Specify the Elasticsearch version that Fluent Bit reports to clients during sniffing and API requests. | `8.0.0` | ### TLS / SSL