Skip to content

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

Merged
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_out_elasticsearch_fix
Jul 15, 2026
Merged

docs: pipeline: outputs: elasticsearch: opensearch: document YAML quoting for strftime values#2625
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_out_elasticsearch_fix

Conversation

@eschabell

@eschabell eschabell commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator
  • Add note that strftime format values beginning with % (logstash_dateformat, time_key_format) must be quoted in YAML, since % is a reserved character and an unquoted value like logstash_dateformat: %Y.%m.%d fails to parse
  • Fix MD060 table alignment in the write_operation tables
  • Fix MD060 header spacing in the OpenSearch parameters table

Fixes #2624

Summary by CodeRabbit

  • Documentation
    • Added guidance to quote YAML strftime values beginning with % to prevent parsing errors.
    • Improved formatting and readability of configuration and write-operation tables for Elasticsearch and OpenSearch outputs.

…ting for strftime values

- Add note that strftime format values beginning with % (logstash_dateformat,
  time_key_format) must be quoted in YAML, since % is a reserved character and
  an unquoted value like `logstash_dateformat: %Y.%m.%d` fails to parse
- Fix MD060 table alignment in the write_operation tables
- Fix MD060 header spacing in the OpenSearch parameters table

Fixes fluent#2624

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Jul 14, 2026
@eschabell eschabell requested a review from a team as a code owner July 14, 2026 14:22
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0.9 labels Jul 14, 2026
@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 67f16b5d-bf0f-4282-af01-9af8f64234db

📥 Commits

Reviewing files that changed from the base of the PR and between e913342 and 7c8fd00.

📒 Files selected for processing (2)
  • pipeline/outputs/elasticsearch.md
  • pipeline/outputs/opensearch.md

📝 Walkthrough

Walkthrough

Elasticsearch and OpenSearch documentation now explain YAML quoting for strftime formats beginning with % and reformat existing configuration and write_operation tables.

Changes

Output documentation

Layer / File(s) Summary
strftime YAML guidance
pipeline/outputs/elasticsearch.md, pipeline/outputs/opensearch.md
Adds informational guidance to quote YAML strftime values beginning with % and adjusts an OpenSearch table separator.
write_operation tables
pipeline/outputs/elasticsearch.md, pipeline/outputs/opensearch.md
Reformats the write_operation Markdown tables without changing the supported operations or descriptions.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • fluent/fluent-bit-docs#2428: Updates overlapping Elasticsearch documentation for logstash_dateformat, time_key_format, and write_operation.

Suggested labels: 5.0

Suggested reviewers: patrick-stephens, cosmo0920

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the docs change about quoting YAML strftime values for Elasticsearch/OpenSearch outputs.
Linked Issues check ✅ Passed The docs now clarify that logstash_dateformat and similar strftime values starting with % must be quoted, matching #2624.
Out of Scope Changes check ✅ Passed The table formatting updates are documentation-only and align with the stated PR objectives, so no unrelated changes stand out.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Jul 15, 2026
@eschabell eschabell merged commit 4a310fb into fluent:master Jul 15, 2026
8 checks passed
@eschabell eschabell deleted the erics_out_elasticsearch_fix branch July 15, 2026 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

logstash_dateformat in quotes

2 participants