fluent-bit-docs icon indicating copy to clipboard operation
fluent-bit-docs copied to clipboard

out_azure_blob: document path templating

Open nberlee opened this issue 1 month ago • 2 comments

  • Documented Azure Blob path templating support added in fluent/fluent-bit#11178.
  • Updated the path parameter description plus added a dedicated “Path templating” section with token reference and example.
  • Clarified how buffered files retain resolved prefixes

Summary by CodeRabbit

Documentation

  • Substantially improved Azure Blob storage output documentation with comprehensive path templating guidance. Added detailed section explaining path template tokens including strftime directives, UUID values, tag references, and numeric placeholders. Enhanced with expanded practical examples demonstrating templated path configurations, best practices, and trailing-slash trimming behavior for improved user guidance and clarity.

✏️ Tip: You can customize this high-level summary in your review settings.

nberlee avatar Dec 16 '25 09:12 nberlee

Walkthrough

The Azure Blob output documentation is updated to explain path templating features. The path parameter description is rewritten, a new "Path templating" section is added detailing available tokens and examples, and existing path examples are extended to demonstrate templated usage.

Changes

Cohort / File(s) Summary
Azure Blob Documentation
pipeline/outputs/azure_blob.md
Rewrote path parameter description to introduce path templating; added "Path templating" section documenting tokens (strftime directives, %3N, %9N/%L, $UUID, $TAG, $TAG[n]); extended examples showing templated paths and trailing-slash trimming behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • No code or functional changes; review focuses on documentation clarity and accuracy of examples

Poem

🐰 A template tale the rabbit spells,
With tokens jingling like garden bells,
Path variables dance in %strftime's delight,
$UUID and $TAG paint blobs just right!
📝✨

Pre-merge checks and finishing touches

✅ 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 clearly and concisely describes the main change: documentation of path templating support for the Azure Blob output plugin.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d261f6ab1212e32a6bf12ee9cd14e95028b1ffa3 and be354dd58c9edcd0f9151a8441bd195964095484.

📒 Files selected for processing (1)
  • pipeline/outputs/azure_blob.md (1 hunks)
🔇 Additional comments (4)
pipeline/outputs/azure_blob.md (4)

28-28: Clear and actionable path parameter update.

The rewritten path parameter description effectively introduces the templating feature with a concrete example, properly references the new documentation section, and sets expectations about trailing slash handling. The example clearly demonstrates multiple token types working together.


48-50: Comprehensive introduction to templating behavior.

The section intro clearly explains template resolution, buffer persistence guarantees, and edge case handling (empty token expansion). The documentation of slice removal and path structure consistency is essential for users implementing buffering.


52-59: Well-documented token reference with helpful examples.

The token table is comprehensive, covering time-based tokens (strftime, milliseconds, nanoseconds), random identifiers (UUID), and tag-based expansion. The examples are clear and properly formatted, and the reference to record accessor limitations on line 59 appropriately flags potential gotchas for $TAG[n] users.


63-75: Accurate example with thoughtful explanation.

The YAML example effectively combines multiple token types and the accompanying explanation correctly traces token expansion (e.g., $TAG[0] and $TAG[4] components from the sample tag). The note about buffer persistence maintaining the same directory structure is valuable context for users implementing disk buffering. The example properly demonstrates how leading slashes are removed and the directory hierarchy is created as expected.


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.

coderabbitai[bot] avatar Dec 16 '25 09:12 coderabbitai[bot]

@alexakreizinger requesting a review here from you. I'd like to see the config parameter table sorted alphabetically, but not a big deal, I'm working through the docs to standardize this and will get to this plugin eventually.

eschabell avatar Dec 16 '25 11:12 eschabell