Skip to content

docs: outputs: datadog: fix issues in this doc#2426

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

docs: outputs: datadog: fix issues in this doc#2426
patrick-stephens merged 1 commit intofluent:masterfrom
eschabell:erics_out_datadog_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 16, 2026

  • 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 #2412

Summary by CodeRabbit

Documentation

  • Configuration parameter naming updated from legacy format to CamelCase conventions (e.g., apikeyApikey, dd_tagsDd_tags).
  • Two new configuration parameters introduced: dd_hostname and dd_message_key for enhanced customization options.
  • Configuration examples and documentation updated to reflect the new parameter naming standards.

  - 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>
@eschabell eschabell self-assigned this Mar 16, 2026
@eschabell eschabell requested a review from a team as a code owner March 16, 2026 09:28
@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

Documentation 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

Cohort / File(s) Summary
Datadog Plugin Documentation
pipeline/outputs/datadog.md
Configuration parameter table and examples updated to use CamelCase naming conventions (Host, Tls, Compress, Apikey, Dd_service, Dd_source, Dd_tags, Dd_hostname) instead of legacy keys; new parameters dd_hostname and dd_message_key added with updated descriptions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 Parameters hop in CamelCase so bright,
Legacy names transformed to new height,
Datadog docs now dance with grace,
Configuration keys find their rightful place! 🎉

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'docs: outputs: datadog: fix issues in this doc' is vague and uses imprecise language. It doesn't clearly indicate what specific issues were fixed or what changes were made to the documentation. Use a more specific title that describes the actual changes, such as 'docs: outputs: datadog: standardize configuration parameter naming and formatting' or 'docs: outputs: datadog: update key naming to lowercase and improve table formatting'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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

You can disable poems in the walkthrough.

Disable the reviews.poem setting to disable the poems in the walkthrough.

@eschabell
Copy link
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 16, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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.

🧹 Nitpick comments (1)
pipeline/outputs/datadog.md (1)

18-18: Line 18: tighten wording for dd_message_key behavior.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 69238cc and 0432dca.

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

@eschabell
Copy link
Collaborator Author

@cosmo0920 and @patrick-stephens ready for review!

@patrick-stephens patrick-stephens merged commit 2a548ae 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_datadog_updates branch March 16, 2026 14:04
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