docs: outputs: elasticsearch: updating doc to latest code#2428
Conversation
- 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>
📝 WalkthroughWalkthroughUpdated Elasticsearch output configuration documentation to rename parameters from CamelCase to snake_case convention (e.g., Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment 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. |
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
pipeline/outputs/elasticsearch.md
|
@cosmo0920 and @patrick-stephens ready for review! |
Applies to #2412
Summary by CodeRabbit
New Features
Documentation