Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fschlager committed May 31, 2024
1 parent 2ea3094 commit 742289e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
23 changes: 19 additions & 4 deletions docs/plugins/fluentd/output/es.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Elasticsearch
# ElasticsearchCommon

Elasticsearch defines the parameters for out_es output plugin

Expand All @@ -12,13 +12,28 @@ Elasticsearch defines the parameters for out_es output plugin
| path | Path defines the REST API endpoint of Elasticsearch to post write requests (default: nil). | *string |
| cloudId | Authenticate towards Elastic Cloud using CloudId. If set, cloudAuth must be set as well and host, port, user and password are ignored. | *[plugins.Secret](../secret.md) |
| cloudAuth | Authenticate towards Elastic Cloud using cloudAuth. | *[plugins.Secret](../secret.md) |
| indexName | IndexName defines the placeholder syntax of Fluentd plugin API. See https://docs.fluentd.org/configuration/buffer-section. | *string |
| logstashFormat | If true, Fluentd uses the conventional index name format logstash-%Y.%m.%d (default: false). This option supersedes the index_name option. | *bool |
| logstashPrefix | LogstashPrefix defines the logstash prefix index name to write events when logstash_format is true (default: logstash). | *string |
| user | Optional, The login credentials to connect to Elasticsearch | *[plugins.Secret](../secret.md) |
| password | Optional, The login credentials to connect to Elasticsearch | *[plugins.Secret](../secret.md) |
| sslVerify | Optional, Force certificate validation | *bool |
| caFile | Optional, Absolute path to CA certificate file | *string |
| clientCert | Optional, Absolute path to client Certificate file | *string |
| clientKey | Optional, Absolute path to client private Key file | *string |
| clientKeyPassword | Optional, password for ClientKey file | *[plugins.Secret](../secret.md) |
# Elasticsearch




| Field | Description | Scheme |
| ----- | ----------- | ------ |
| indexName | IndexName defines the placeholder syntax of Fluentd plugin API. See https://docs.fluentd.org/configuration/buffer-section. | *string |
| logstashFormat | If true, Fluentd uses the conventional index name format logstash-%Y.%m.%d (default: false). This option supersedes the index_name option. | *bool |
| logstashPrefix | LogstashPrefix defines the logstash prefix index name to write events when logstash_format is true (default: logstash). | *string |
# ElasticsearchDataStream




| Field | Description | Scheme |
| ----- | ----------- | ------ |
| dataStreamName | You can specify Elasticsearch data stream name by this parameter. This parameter is mandatory for elasticsearch_data_stream | *string |
1 change: 1 addition & 0 deletions docs/plugins/fluentd/output/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Output defines all available output plugins and their parameters
| forward | out_forward plugin | *Forward |
| http | out_http plugin | *Http |
| elasticsearch | out_es plugin | *Elasticsearch |
| elasticsearchDataStream | out_es datastreams plugin | *ElasticsearchDataStream |
| opensearch | out_opensearch plugin | *Opensearch |
| kafka | out_kafka plugin | *Kafka2 |
| s3 | out_s3 plugin | *S3 |
Expand Down

0 comments on commit 742289e

Please sign in to comment.