Skip to content

docs: outputs: aws plugins adding description of EUSC and China region endpoint handling#2507

Open
eschabell wants to merge 4 commits intofluent:masterfrom
eschabell:erics_output_plugins_region_aws_support_note
Open

docs: outputs: aws plugins adding description of EUSC and China region endpoint handling#2507
eschabell wants to merge 4 commits intofluent:masterfrom
eschabell:erics_output_plugins_region_aws_support_note

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 20, 2026

The following plugins update the region configuration param description:

pipeline/outputs/cloudwatch.md
pipeline/outputs/firehose.md
pipeline/outputs/kinesis.md
pipeline/outputs/s3.md

Fixes #2499

Summary by CodeRabbit

  • Documentation
    • Updated AWS output plugins documentation (CloudWatch, Firehose, Kinesis, S3) to clarify support for China regions (cn-north-1, cn-northwest-1) and AWS European Sovereign Cloud region (eusc-de-east-1).
    • Documented automatic endpoint suffix handling for these regions with no custom configuration required.

…ndling

Applies to fluent#2499

Signed-off-by: Eric D. Schabell <eric@schabell.org>
…ling

    Applies to fluent#2499

Signed-off-by: Eric D. Schabell <eric@schabell.org>
    Applies to fluent#2499

Signed-off-by: Eric D. Schabell <eric@schabell.org>
    Applies to fluent#2499

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

coderabbitai bot commented Mar 20, 2026

📝 Walkthrough

Walkthrough

Documentation updates to four AWS output plugins expand region parameter descriptions to explicitly document support for China regions (cn-north-1, cn-northwest-1) and AWS European Sovereign Cloud (eusc-de-east-1), noting automatic endpoint suffix handling.

Changes

Cohort / File(s) Summary
AWS Output Plugin Region Documentation
pipeline/outputs/cloudwatch.md, pipeline/outputs/firehose.md, pipeline/outputs/kinesis.md, pipeline/outputs/s3.md
Expanded region parameter descriptions to explicitly document support for China regions (cn-north-1, cn-northwest-1) and European Sovereign Cloud region (eusc-de-east-1), clarifying that Fluent Bit automatically applies correct endpoint suffixes (.amazonaws.com.cn or .amazonaws.eu) without requiring custom endpoint configuration.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • PR #2317: Modifies the same output plugin documentation files (kinesis.md and firehose.md), specifically updating region/Region configuration descriptions for AWS regional cloud support.

Suggested reviewers

  • patrick-stephens

Poem

🐰 A hop through the clouds, both near and far,
From cn-north to eusc, we've raised the bar!
No custom endpoints need apply,
Fluent Bit knows where to fly. 🌍
Docs now shine with regional grace,
Every cloud finds its proper place!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: adding documentation about EUSC and China region endpoint handling to AWS output plugins.
Linked Issues check ✅ Passed The PR updates documentation for four AWS output plugins to document EUSC and China region support with endpoint handling, fully addressing the coding requirements from issue #2499.
Out of Scope Changes check ✅ Passed All changes are documentation updates to the region parameter descriptions in four AWS output plugins, directly related to the linked issue objectives with no out-of-scope modifications.
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.

@eschabell
Copy link
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 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/s3.md (1)

77-77: Prefer eusc-* wording to avoid under-documenting EUSC support.

Line 77 currently names only eusc-de-east-1. Since the behavior is pattern-based for EUSC regions, consider wording it as eusc-* (with eusc-de-east-1 as an example) to prevent the docs from implying single-region support.

Suggested wording
-| `region` | The AWS region of your S3 bucket. China regions (`cn-north-1`, `cn-northwest-1`) and the AWS European Sovereign Cloud region (`eusc-de-east-1`) are supported; Fluent Bit automatically uses the correct endpoint suffix (`.amazonaws.com.cn` or `.amazonaws.eu`) and no custom `endpoint` is required. | `us-east-1` |
+| `region` | The AWS region of your S3 bucket. China regions (`cn-north-1`, `cn-northwest-1`) and AWS European Sovereign Cloud regions (`eusc-*`, for example `eusc-de-east-1`) are supported; Fluent Bit automatically uses the correct endpoint suffix (`.amazonaws.com.cn` or `.amazonaws.eu`) and no custom `endpoint` is required. | `us-east-1` |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pipeline/outputs/s3.md` at line 77, Update the region wording in the S3
output docs: replace the single-region mention `eusc-de-east-1` with
pattern-style `eusc-*` and keep `eusc-de-east-1` as an example (e.g., "eusc-*
(for example, eusc-de-east-1)") so the `region` table entry and the text that
currently references `eusc-de-east-1` reflect EUSC-wide support; search for the
`region` table cell and the literal `eusc-de-east-1` in the s3.md content to
make the change.
🤖 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/s3.md`:
- Line 77: Update the region wording in the S3 output docs: replace the
single-region mention `eusc-de-east-1` with pattern-style `eusc-*` and keep
`eusc-de-east-1` as an example (e.g., "eusc-* (for example, eusc-de-east-1)") so
the `region` table entry and the text that currently references `eusc-de-east-1`
reflect EUSC-wide support; search for the `region` table cell and the literal
`eusc-de-east-1` in the s3.md content to make the change.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9da96d6d-9028-45a0-b4bd-a0d3fa086125

📥 Commits

Reviewing files that changed from the base of the PR and between 3179471 and 000aea1.

📒 Files selected for processing (4)
  • pipeline/outputs/cloudwatch.md
  • pipeline/outputs/firehose.md
  • pipeline/outputs/kinesis.md
  • pipeline/outputs/s3.md

@eschabell
Copy link
Collaborator Author

@patrick-stephens ready for review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5.0 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feb 2026 audit - docs: aws eu regional cloud information updates needed

1 participant