docs: outputs: datadog: fix issues in this doc#2426
docs: outputs: datadog: fix issues in this doc#2426patrick-stephens merged 1 commit intofluent:masterfrom
Conversation
- Fix Key column: Host, TLS, Proxy -> host, tls, proxy - Add backticks to workers and header key names in table - Fix compress default: _none_ -> false - Fix dd_message_key default: _none_ -> log - Sort configuration parameters table alphabetically - Remove redundant "This plugin uses the following configuration parameters:" intro sentence - Remove "Optional." prefix from compress and dd_tags descriptions for consistency - Apply Title_Case to classic config keys Applies to fluent#2412 Signed-off-by: Eric D. Schabell <eric@schabell.org>
📝 WalkthroughWalkthroughDocumentation update converting Datadog output plugin configuration parameters from legacy naming conventions (lowercase/snake_case) to CamelCase variants, introducing new parameters (dd_hostname, dd_message_key), and updating configuration examples to reflect the new naming scheme. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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 You can disable poems in the walkthrough.Disable the |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
🧹 Nitpick comments (1)
pipeline/outputs/datadog.md (1)
18-18: Line 18: tighten wording fordd_message_keybehavior.Current phrasing is a bit awkward (“property name key”). Consider simplifying for clarity.
Proposed wording
-| `dd_message_key` | By default, the plugin searches for the key `log` and remaps the value to the key `message`. If the property is set, the plugin searches for the property name key. | `log` | +| `dd_message_key` | By default, the plugin searches for the key `log` and remaps its value to `message`. If this option is set, the plugin searches for the configured key name instead. | `log` |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pipeline/outputs/datadog.md` at line 18, Rewrite the dd_message_key description to tighten wording: replace the phrase "property name key" and the awkward clause with a clearer sentence that says this property specifies which field to use as the message (defaulting to "log"), e.g. "By default the plugin looks for the `log` field and remaps its value to `message`; set `dd_message_key` to use a different field as the message." Update the table cell for `dd_message_key` accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@pipeline/outputs/datadog.md`:
- Line 18: Rewrite the dd_message_key description to tighten wording: replace
the phrase "property name key" and the awkward clause with a clearer sentence
that says this property specifies which field to use as the message (defaulting
to "log"), e.g. "By default the plugin looks for the `log` field and remaps its
value to `message`; set `dd_message_key` to use a different field as the
message." Update the table cell for `dd_message_key` accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 071aa8d6-6c1f-4666-a62c-a19452df5b1a
📒 Files selected for processing (1)
pipeline/outputs/datadog.md
|
@cosmo0920 and @patrick-stephens ready for review! |
Applies to #2412
Summary by CodeRabbit
Documentation
apikey→Apikey,dd_tags→Dd_tags).dd_hostnameanddd_message_keyfor enhanced customization options.