Skip to content

output: update pgsql documentation#2542

Merged
eschabell merged 1 commit intofluent:masterfrom
sxd:update_docs_for_out_pgsql_plugin
Apr 13, 2026
Merged

output: update pgsql documentation#2542
eschabell merged 1 commit intofluent:masterfrom
sxd:update_docs_for_out_pgsql_plugin

Conversation

@sxd
Copy link
Copy Markdown
Member

@sxd sxd commented Apr 11, 2026

Summary by CodeRabbit

  • Documentation
    • Updated PostgreSQL output plugin documentation to reflect revised data storage behavior and timestamp handling.
    • Removed support for async, max_pool_size, min_pool_size, and timestamp_key configuration parameters.
    • Changed default workers value from 0 to 1.
    • Updated configuration examples accordingly.

Signed-off-by: Jonathan Gonzalez V. <jonathan.abdiel@gmail.com>
@sxd sxd requested review from a team and eschabell as code owners April 11, 2026 08:56
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 11, 2026

📝 Walkthrough

Walkthrough

Updated PostgreSQL output plugin documentation to reflect that the pgsql plugin stores log records with data column as JSONB and time from event timestamps, removing support for async/pooling settings, and changing the default workers value from 0 to 1.

Changes

Cohort / File(s) Summary
PostgreSQL Output Plugin Documentation
pipeline/outputs/postgresql.md
Removed unsupported configuration parameters (async, max_pool_size, min_pool_size, timestamp_key), updated default workers from 0 to 1, and removed timestamp_key from configuration examples and schema descriptions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 No more timestamps to confess,
One worker's default—one less stress!
JSONB data, pure and bright,
PostgreSQL docs shine with light! ✨

🚥 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 'output: update pgsql documentation' accurately summarizes the main change: updating PostgreSQL output plugin documentation with revised configuration parameters and behavior.
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

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.

Copy link
Copy Markdown
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/postgresql.md (1)

67-70: Consider adding a one-line migration note for removed keys.

Useful addition overall; consider explicitly stating whether old keys are ignored or cause config errors, so upgrades are safer.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pipeline/outputs/postgresql.md` around lines 67 - 70, Update the PostgreSQL
output docs to add a one-line migration note clarifying the fate of the removed
config keys (`async`, `max_pool_size`, `min_pool_size`) and whether they will be
ignored or treated as configuration errors; edit the paragraph that currently
mentions those removed settings (near the `workers` table and the sentence "The
previous `async`, `max_pool_size`, and `min_pool_size` settings are no longer
supported.") to append a concise statement like "These deprecated keys are
ignored and will not cause errors" or "These keys now produce a configuration
error" as appropriate for the implementation so users know the expected upgrade
behavior.
🤖 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/postgresql.md`:
- Around line 67-70: Update the PostgreSQL output docs to add a one-line
migration note clarifying the fate of the removed config keys (`async`,
`max_pool_size`, `min_pool_size`) and whether they will be ignored or treated as
configuration errors; edit the paragraph that currently mentions those removed
settings (near the `workers` table and the sentence "The previous `async`,
`max_pool_size`, and `min_pool_size` settings are no longer supported.") to
append a concise statement like "These deprecated keys are ignored and will not
cause errors" or "These keys now produce a configuration error" as appropriate
for the implementation so users know the expected upgrade behavior.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ecbdc771-b050-47f1-b107-624c82f2e4ce

📥 Commits

Reviewing files that changed from the base of the PR and between 20eda88 and f0b9814.

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

Copy link
Copy Markdown
Collaborator

@eschabell eschabell left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @sxd!

@eschabell eschabell merged commit 9007e77 into fluent:master Apr 13, 2026
8 checks passed
@eschabell eschabell self-assigned this Apr 13, 2026
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