Skip to content

Conversation

@jimin9038
Copy link

@jimin9038 jimin9038 commented Dec 10, 2025

This PR is a short addition noting that environment variables cannot be used in the include section.
Some users may attempt to use environment variables in the include section and eventually run into issues - often ending up at workaround discussions such as this one: fluent/fluent-bit#2020

It would be great to add a note clarifying that the include section does not parse environment variables, and, if possible, include a link to the above issue as a reference for the workaround.

Thank you!

Summary by CodeRabbit

  • Documentation
    • Clarified that environment variables are not supported in the includes section.
    • Stated that file paths in the includes section must be specified as literal strings.

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

@jimin9038 jimin9038 requested review from a team as code owners December 10, 2025 23:30
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 10, 2025

Warning

Rate limit exceeded

@jimin9038 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 21 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 88b73b5 and 14848e9.

📒 Files selected for processing (1)
  • administration/configuring-fluent-bit/yaml/includes-section.md (1 hunks)

Walkthrough

Added a documentation clarification to the Fluent Bit YAML includes section: environment variables are not supported there and included file paths must be literal string values.

Changes

Cohort / File(s) Summary
Documentation Update
administration/configuring-fluent-bit/yaml/includes-section.md
Clarified that environment variables are not supported in the includes section and that file paths must be specified as literal strings.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hop through docs with ink so bright,
I stamp the rule in plain daylight,
No env vars here, just strings that sing,
Paths written true — a tidy thing,
Fluent Bit's includes now clear and 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 directly and accurately describes the main change: adding a note that environment variables cannot be used in the include section, matching the PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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
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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
administration/configuring-fluent-bit/yaml/includes-section.md (1)

29-30: Consider adding a reference link to guide users toward workarounds.

The clarification accurately states that environment variables aren't supported in the includes section. However, per the PR objectives, a link to the referenced issue (fluent/fluent-bit#2020) should be included to help users discover workaround discussions.

Apply this diff to add context for users seeking alternatives:

-Environment variables are not supported in includes section. The file path must be specified as a literal string.
+Environment variables are not supported in includes section. The file path must be specified as a literal string. For workaround discussions, see [this issue](https://github.com/fluent/fluent-bit/issues/2020).
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef0fa03 and e219304.

📒 Files selected for processing (1)
  • administration/configuring-fluent-bit/yaml/includes-section.md (1 hunks)

@jimin9038 jimin9038 force-pushed the master branch 2 times, most recently from 88b73b5 to 8a75226 Compare December 10, 2025 23:34
@cosmo0920
Copy link
Contributor

cosmo0920 commented Dec 12, 2025

@eschabell Hi, this is not updating to reflect code changes. This describes the current limitation of Fluent Bit's configuration syntax of YAML.
So, we can :shipit:!

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.

4 participants