Skip to content

docs: pipeline: outputs: elasticsearch: opensearch: document YAML quoting for strftime values #2625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eschabell merged 1 commit into from
Jul 15, 2026
Merged

docs: pipeline: outputs: elasticsearch: opensearch: document YAML quoting for strftime values #2625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions pipeline/outputs/elasticsearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ The _Elasticsearch_ (`es`) output plugin lets you ingest your records into an [E

If you have used a common relational database, the parameters `index` and `type` can be compared to the `database` and `table` concepts.

{% hint style="info" %}

In YAML configuration, quote any [strftime](https://man7.org/linux/man-pages/man3/strftime.3.html) format value that begins with `%`, such as `logstash_dateformat` and `time_key_format`. YAML treats `%` as a reserved character, so an unquoted value like `logstash_dateformat: %Y.%m.%d` fails to parse. Use `logstash_dateformat: "%Y.%m.%d"` instead.

{% endhint %}

### TLS / SSL

The Elasticsearch output plugin supports TLS/SSL. For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md).
Expand All @@ -60,12 +66,12 @@ The Elasticsearch output plugin supports TLS/SSL. For more details about the pro

The `write_operation` can be any of:

| Operation | Description |
| ----------- | ----------- |
| `create` | Adds new data. If the data already exists (based on its id), the op is skipped.|
| `index` | New data is added while existing data (based on its id) is replaced (reindexed).|
| `update` | Updates existing data (based on its id). If no data is found, the op is skipped. |
| `upsert` | Merge or insert if the data doesn't exist, updates if the data exists (based on its id).|
| Operation | Description |
| --------- | ---------------------------------------------------------------------------------------- |
| `create` | Adds new data. If the data already exists (based on its id), the op is skipped. |
| `index` | New data is added while existing data (based on its id) is replaced (reindexed). |
| `update` | Updates existing data (based on its id). If no data is found, the op is skipped. |
| `upsert` | Merge or insert if the data doesn't exist, updates if the data exists (based on its id). |

{% hint style="info" %}

Expand Down
18 changes: 12 additions & 6 deletions pipeline/outputs/opensearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The _OpenSearch_ output plugin lets you ingest your records into an [OpenSearch]
This plugin supports the following parameters:

| Key | Description | Default |
|:--- |:----------- |:------- |
| :--- | :----------- | :------- |
| `aws_auth` | Enable AWS Sigv4 Authentication for Amazon OpenSearch Service. | `Off` |
| `aws_external_id` | External ID for the AWS IAM Role specified with `aws_role_arn`. | _none_ |
| `aws_profile` | AWS profile name. | `default` |
Expand Down Expand Up @@ -55,6 +55,12 @@ This plugin supports the following parameters:

The parameters `index` and `type` can be confusing if you are new to OpenSearch. If you have used a common relational database before, they can be compared to the `database` and `table` concepts. Also see [the FAQ](opensearch.md#faq).

{% hint style="info" %}

In YAML configuration, quote any [strftime](https://man7.org/linux/man-pages/man3/strftime.3.html) format value that begins with `%`, such as `logstash_dateformat` and `time_key_format`. YAML treats `%` as a reserved character, so an unquoted value like `logstash_dateformat: %Y.%m.%d` fails to parse. Use `logstash_dateformat: "%Y.%m.%d"` instead.

{% endhint %}

### TLS / SSL

The OpenSearch output plugin supports TLS/SSL. For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md).
Expand All @@ -63,11 +69,11 @@ The OpenSearch output plugin supports TLS/SSL. For more details about the proper

The `write_operation` can be any of:

| Operation | Description |
|------------------|----------------------------------------------------------------------------------------------------|
| `create` (default) | Adds new data - if the data already exists (based on its id), the op is skipped. |
| `index` | New data is added while existing data (based on its id) is replaced (reindexed). |
| `update` | Updates existing data (based on its id). If no data is found, the op is skipped. |
| Operation | Description |
| ------------------ | ----------------------------------------------------------------------------------------------------- |
| `create` (default) | Adds new data - if the data already exists (based on its id), the op is skipped. |
| `index` | New data is added while existing data (based on its id) is replaced (reindexed). |
| `update` | Updates existing data (based on its id). If no data is found, the op is skipped. |
| `upsert` | Known as `merge` or `insert` if the data doesn't exist. Updates if the data exists (based on its id). |

{% hint style="info" %}
Expand Down
Loading