Skip to content

Conversation

@alexakreizinger
Copy link
Member

@alexakreizinger alexakreizinger commented Nov 12, 2025

fixes #2168. I noticed the same issue in a few other docs as well.

Summary by CodeRabbit

  • Documentation
    • Updated TLS certificate configuration property name to tls.crt_file across multiple pipeline components (inputs and outputs).
    • Added new TLS configuration options for enhanced security: key password, version limits, hostname verification, and Windows certificate store settings.
    • Updated default value for Azure Kusto output unify_tag setting.

Signed-off-by: Alexa Kreizinger <[email protected]>
@alexakreizinger alexakreizinger requested review from a team as code owners November 12, 2025 21:56
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 12, 2025

Walkthrough

Documentation updates correct TLS configuration option naming from tls.cert_file to tls.crt_file across multiple documentation files (administration, inputs, and outputs), aligning with the correct property name used in Fluent Bit v4.1.

Changes

Cohort / File(s) Summary
TLS documentation property rename
administration/transport-security.md, pipeline/inputs/opentelemetry.md, pipeline/outputs/opentelemetry.md, pipeline/outputs/s3.md
Updated TLS configuration field name from tls.cert_file to tls.crt_file in documentation tables and examples; minor formatting adjustment in transport-security.
Azure Kusto output enhancements
pipeline/outputs/azure_kusto.md
Renamed tls.cert_file to tls.crt_file; added new TLS configuration keys (tls.key_passwd, tls.max_version, tls.min_version, tls.verify_hostname, tls.vhost, tls.verify, Windows certificate store options); updated unify_tag default from On to true.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • All changes are documentation-only corrections focused on aligning property names with actual implementation
  • Highly homogeneous pattern (consistent tls.cert_filetls.crt_file rename across files)
  • No code logic, control flow, or exported entity declarations affected
  • Additional TLS options in Azure Kusto are straightforward documentation additions

Poem

🐰 Hop-hop, the typos flee!
From cert_file to crt_file, now we see,
Documentation fixed with care,
Fluent Bit docs beyond compare!

Pre-merge checks and finishing touches

✅ 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 accurately summarizes the primary change: fixing the tls.cert_file typo across multiple documentation files.
Linked Issues check ✅ Passed The PR fully addresses issue #2168 by replacing tls.cert_file with tls.crt_file across all affected documentation files.
Out of Scope Changes check ✅ Passed All changes are scoped to correcting the tls configuration parameter name across documentation; no unrelated modifications detected.
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
  • Commit unit tests in branch alexakreizinger/sc-154515/fix-typo-in-fb-otel-output-doc

📜 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 21a716a and 7e32c29.

📒 Files selected for processing (5)
  • administration/transport-security.md (2 hunks)
  • pipeline/inputs/opentelemetry.md (1 hunks)
  • pipeline/outputs/azure_kusto.md (1 hunks)
  • pipeline/outputs/opentelemetry.md (1 hunks)
  • pipeline/outputs/s3.md (1 hunks)
🔇 Additional comments (6)
pipeline/outputs/opentelemetry.md (1)

78-78: TLS certificate configuration parameter correctly renamed.

The parameter has been updated from tls.cert_file to tls.crt_file to match the actual Fluent Bit v4.1 configuration option. This aligns with the issue objective and other documentation updates in this PR.

pipeline/inputs/opentelemetry.md (1)

49-49: TLS certificate configuration parameter correctly renamed.

The parameter has been updated from tls.cert_file to tls.crt_file to match the actual Fluent Bit v4.1 configuration option, consistent with the output plugin documentation.

administration/transport-security.md (1)

98-98: TLS configuration examples consistently updated to use correct parameter name.

All code examples (shell command, YAML, and CONF formats) have been updated from tls.cert_file to tls.crt_file. Examples are now consistent with the actual Fluent Bit v4.1 configuration option.

Also applies to: 124-124, 141-141

pipeline/outputs/s3.md (1)

85-85: TLS certificate configuration parameter correctly renamed.

The parameter has been updated from tls.cert_file to tls.crt_file to align with Fluent Bit v4.1 and other output plugin documentation.

pipeline/outputs/azure_kusto.md (2)

108-108: TLS certificate configuration parameter correctly renamed.

The parameter has been updated from tls.cert_file to tls.crt_file to match Fluent Bit v4.1, consistent with other output plugin documentation.


60-60: Verify intent behind duplicate unify_tag entries with different defaults.

The configuration table appears to contain two entries for unify_tag (lines 60 and 120) with different default values: On (line 60) and true (line 120). The AI summary mentions updating this default, but it's unclear whether:

  1. Both entries should remain in the table, or
  2. The first entry (line 60) should have been updated or removed as part of this PR

Please verify this is intentional and correct the documentation if needed.

Also applies to: 120-120


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.

@alexakreizinger alexakreizinger merged commit 7b6b315 into master Nov 12, 2025
8 checks passed
@alexakreizinger alexakreizinger deleted the alexakreizinger/sc-154515/fix-typo-in-fb-otel-output-doc branch November 12, 2025 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Typo: tls.cert_file should be tls.crt_file in the Open Telemetry output docs

3 participants