Skip to content

pipeline: outputs: arvancloud_cloudlogs: add ArvanCloud CloudLogs doc… - #2646

Open
javadnasrolahi wants to merge 3 commits into
fluent:masterfrom
javadnasrolahi:add-arvancloud-output-docs
Open

pipeline: outputs: arvancloud_cloudlogs: add ArvanCloud CloudLogs doc…#2646
javadnasrolahi wants to merge 3 commits into
fluent:masterfrom
javadnasrolahi:add-arvancloud-output-docs

Conversation

@javadnasrolahi

@javadnasrolahi javadnasrolahi commented Aug 1, 2026

Copy link
Copy Markdown

…umentation

Summary by CodeRabbit

  • Documentation
    • Added documentation for the ArvanCloud CloudLogs output plugin.
    • Documented supported event types, authentication, configuration options, payload formatting, compression, tagging, and HTTP behavior.
    • Added YAML and Classic configuration examples.
    • Included the plugin in the documentation table of contents.

…umentation

Signed-off-by: Javad Nasrolahi <javadnasrolahi13@gmail.com>
@javadnasrolahi
javadnasrolahi requested review from a team and eschabell as code owners August 1, 2026 11:19
@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 49c9b27b-1501-4420-be72-3c1f53781727

📥 Commits

Reviewing files that changed from the base of the PR and between 830c582 and 7d54ee0.

📒 Files selected for processing (2)
  • pipeline/outputs/arvancloud_cloudlogs.md
  • vale-styles/FluentBit/Headings.yml
🚧 Files skipped from review as they are similar to previous changes (2)
  • vale-styles/FluentBit/Headings.yml
  • pipeline/outputs/arvancloud_cloudlogs.md

📝 Walkthrough

Walkthrough

Added ArvanCloud CloudLogs output-plugin documentation and linked it from the pipeline outputs table of contents. The documentation covers configuration, payloads, authentication, fallback behavior, HTTP responses, compression, tags, and examples.

Changes

ArvanCloud CloudLogs documentation

Layer / File(s) Summary
Document and index the CloudLogs output plugin
pipeline/outputs/arvancloud_cloudlogs.md, SUMMARY.md, vale-styles/FluentBit/Headings.yml
Added configuration, payload, response-handling, and usage documentation. Added the plugin link to the pipeline outputs table of contents. Added the heading capitalization exception for ArvanCloud CloudLogs.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested labels: waiting-on-review

🚥 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 identifies the ArvanCloud CloudLogs documentation change for the pipeline output plugin.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

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

99-107: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Use Title_Case keys in the classic configuration examples.

Change the ArvanCloud plugin keys in the fluent-bit.conf examples to their Title_Case forms. Keep the parameter table and YAML keys lowercase.

Based on learnings, classic fluent-bit.conf examples use Title_Case for plugin-specific keys, while YAML examples and parameter tables use lowercase canonical names.

Also applies to: 141-157

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@pipeline/outputs/arvancloud_cloudlogs.md` around lines 99 - 107, Update the
classic fluent-bit.conf examples in arvancloud_cloudlogs.md to use Title_Case
for ArvanCloud plugin-specific keys, including Name, Tag, Match, and Apikey as
applicable; leave the parameter table and YAML keys lowercase.

Source: Learnings

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pipeline/outputs/arvancloud_cloudlogs.md`:
- Line 34: Fix the code-fence marker in the documentation block by removing the
unrelated URL and using the intended json language marker, ensuring the JSON
block starts with a valid ```json fence.

---

Nitpick comments:
In `@pipeline/outputs/arvancloud_cloudlogs.md`:
- Around line 99-107: Update the classic fluent-bit.conf examples in
arvancloud_cloudlogs.md to use Title_Case for ArvanCloud plugin-specific keys,
including Name, Tag, Match, and Apikey as applicable; leave the parameter table
and YAML keys lowercase.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 39c219b2-ffc1-4536-8119-dd78fdfc9941

📥 Commits

Reviewing files that changed from the base of the PR and between 0eb06a6 and e9e5d77.

📒 Files selected for processing (2)
  • SUMMARY.md
  • pipeline/outputs/arvancloud_cloudlogs.md

Comment thread pipeline/outputs/arvancloud_cloudlogs.md Outdated
… documentation

Signed-off-by: Javad Nasrolahi <javadnasrolahi13@gmail.com>
@eschabell eschabell self-assigned this Aug 1, 2026
@eschabell eschabell added waiting-on-code-merge waiting-on-review Waiting on a review from mainteners lint-vale-issues and removed waiting-on-review Waiting on a review from mainteners lint-vale-issues labels Aug 1, 2026

@eschabell eschabell left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@javadnasrolahi thanks for the docs PR! I have cleaned up some of the issues and it's now ready once the code PR merges.

…dings

- Reword the timestamp_key description to avoid 'unparseable'
- Reword the fixed-endpoint paragraph to avoid 'hardcodes'
- Change '500 and above' to '500 or greater' in the HTTP status table
- Add 'ArvanCloud CloudLogs' to the Vale heading capitalization exceptions
- Fixed Title_Case issues in classic config examples

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
eschabell force-pushed the add-arvancloud-output-docs branch from 830c582 to 7d54ee0 Compare August 2, 2026 08:53
@javadnasrolahi

Copy link
Copy Markdown
Author

@javadnasrolahi thanks for the docs PR! I have cleaned up some of the issues and it's now ready once the code PR merges.

I saw your commit—thank you for the review! I’m now waiting for the code PR to merge.
@eschabell

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants