Skip to content

docs: outputs: elasticsearch: updating doc to latest code#2428

Merged
patrick-stephens merged 1 commit intofluent:masterfrom
eschabell:erics_out_elasticsearch_updates
Mar 16, 2026
Merged

docs: outputs: elasticsearch: updating doc to latest code#2428
patrick-stephens merged 1 commit intofluent:masterfrom
eschabell:erics_out_elasticsearch_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 16, 2026

  • Lowercase all Key column entries
  • Sort configuration parameters table alphabetically
  • Fix aws_profile default: "default" -> "none"
  • Fix tag_key default: "_flb-key" -> "flb-key"
  • Fix path default: "Empty string" -> "none"
  • Fix buffer_size default: "512KB" -> "512k"
  • Remove redundant intro sentence
  • Fix suppress_type_name description: remove incorrect "and is set to On" claim
  • Update cross-references to use lowercase key names in descriptions
  • Fix classic config title-case uses in examples

Applies to #2412

Summary by CodeRabbit

  • New Features

    • Added AWS SigV4 and Elastic Cloud integration support with new authentication and configuration options
    • Expanded Elasticsearch output with AWS region, profile, and role ARN settings
  • Documentation

    • Updated configuration examples to reflect new parameter naming convention
    • Standardized all configuration parameters from CamelCase to snake_case format
    • Enhanced YAML and CONF configuration samples with new options

  - Lowercase all Key column entries
  - Sort configuration parameters table alphabetically
  - Fix aws_profile default: "default" -> "_none_"
  - Fix tag_key default: "_flb-key" -> "flb-key"
  - Fix path default: "Empty string" -> "_none_"
  - Fix buffer_size default: "512KB" -> "512k"
  - Remove redundant intro sentence
  - Fix suppress_type_name description: remove incorrect "and is set to On" claim
  - Update cross-references to use lowercase key names in descriptions
  - Fix classic config title-case uses in examples

  Applies to fluent#2412

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Mar 16, 2026
@eschabell eschabell requested a review from a team as a code owner March 16, 2026 14:00
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Mar 16, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 16, 2026

📝 Walkthrough

Walkthrough

Updated Elasticsearch output configuration documentation to rename parameters from CamelCase to snake_case convention (e.g., Hosthost, Portport) and added new AWS SigV4, OpenSearch Cloud, and authentication-related configuration options. Examples and documentation updated to reflect the new naming scheme.

Changes

Cohort / File(s) Summary
Elasticsearch Configuration Documentation
pipeline/outputs/elasticsearch.md
Comprehensive parameter naming standardization from CamelCase to snake_case (~33+ parameters renamed: Host/Port/Index/etc. to host/port/index). Added new AWS authentication parameters (aws_auth, aws_region, aws_profile, aws_role_arn, aws_service_name, aws_sts_endpoint, aws_external_id) and Elastic Cloud options (cloud_id, cloud_auth). Updated all code examples and parameter documentation blocks to reflect new naming conventions.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 From CamelCase hops to snake_case glides,
Parameters dancing in AWS tides,
Cloud and OpenSearch, now side by side,
The Elasticsearch config takes a cleaner stride!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating Elasticsearch output documentation to reflect the latest code with snake_case parameter naming convention.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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 and usage tips.

Tip

CodeRabbit can use TruffleHog to scan for secrets in your code with verification capabilities.

Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@pipeline/outputs/elasticsearch.md`:
- Around line 249-250: Update the fluent-bit.conf example to use Title_Case keys
for consistency: replace the entries named Cloud_id and Cloud_auth with Cloud_ID
and Cloud_Auth respectively so they match the neighboring classic-style keys
like Include_Tag_Key and Suppress_Type_Name; ensure only the key names change
and their values remain unchanged in the fluent-bit.conf example block.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: efd2e240-40f6-425f-bd7c-a76d7981d034

📥 Commits

Reviewing files that changed from the base of the PR and between 2a548ae and 018b201.

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

@eschabell
Copy link
Collaborator Author

@cosmo0920 and @patrick-stephens ready for review!

@patrick-stephens patrick-stephens merged commit 878a3b8 into fluent:master Mar 16, 2026
8 checks passed
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 16, 2026
@eschabell eschabell deleted the erics_out_elasticsearch_updates branch March 17, 2026 19:27
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.

2 participants