Skip to content

Commit 107f2fa

Browse files
authored
Fixed elasticsearch input plugin doc with missing config parameters and some cleanup. Fixed #2245 (#2246)
* Fixed dummy input plugin doc with missing config option and standard layout. Fixes #2243. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Fixed elasticsearch input plugin doc with missing config parameters and some cleanup. Fixed #2245. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Added fixes for review comments. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Fixed another review comment. Signed-off-by: Eric D. Schabell <eric@schabell.org> --------- Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 5e126a3 commit 107f2fa

1 file changed

Lines changed: 22 additions & 5 deletions

File tree

pipeline/inputs/elasticsearch.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,32 @@ The plugin supports the following configuration parameters:
88

99
| Key | Description | Default value |
1010
|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:--------------|
11-
| `buffer_max_size` | Set the maximum size of buffer. | `4M` |
1211
| `buffer_chunk_size` | Set the buffer chunk size. | `512K` |
13-
| `tag_key` | Specify a key name for extracting as a tag. | `NULL` |
14-
| `meta_key` | Specify a key name for meta information. | `@meta` |
12+
| `buffer_max_size` | Set the maximum size of buffer. | `4M` |
1513
| `hostname` | Specify hostname or fully qualified domain name. This parameter can be used for "sniffing" (auto-discovery of) cluster node information. | `localhost` |
16-
| `version` | Specify Elasticsearch server version. This parameter is effective for checking a version of Elasticsearch/OpenSearch server version. | `8.0.0` |
14+
| `http2` | Enable HTTP/2 support. | `true` |
15+
| `listen` | The address to listen on. | `0.0.0.0` |
16+
| `meta_key` | Specify a key name for meta information. | `@meta` |
17+
| `port` | The port for Fluent Bit to listen on. | `9200` |
18+
| `tag_key` | Specify a key name for extracting as a tag. | `NULL` |
1719
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
20+
| `version` | Specify the Elasticsearch version that Fluent Bit reports to clients during sniffing and API requests. | `8.0.0` |
21+
22+
### TLS / SSL
23+
24+
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).
25+
26+
When configuring TLS for Elasticsearch ingestion, common options include:
27+
28+
- `tls.verify`: Enable or disable certificate validation for incoming connections.
29+
- `tls.ca_file`: Specify a CA certificate to validate client certificates when using mutual TLS (mTLS).
30+
- `tls.crt_file` and `tls.key_file`: Provide the server certificate and private key.
31+
32+
### Sniffing
33+
34+
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.
1835

19-
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.
36+
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).
2037

2138
## Get started
2239

0 commit comments

Comments
 (0)