Correcting 404 links per report #2322
Conversation
Signed-off-by: Lynette Miles <[email protected]>
📝 WalkthroughWalkthroughThis PR updates Fluent Bit documentation with HTTP-to-HTTPS protocol upgrades, external link URL corrections (Azure, AWS, GitHub, documentation sites), internal documentation path adjustments reflecting structural reorganization, and minor formatting refinements. All changes are documentation-only with no impact on code functionality. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
Signed-off-by: Lynette Miles <[email protected]>
Signed-off-by: Lynette Miles <[email protected]>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
administration/configuring-fluent-bit/yaml/parsers-section.md (1)
50-82: Inconsistent example filename.The documentation updates the example filename from
my-parsers.yamltocustom-parsers.yamlin lines 50 and 53, but line 82 still referencesmy-parsers.yamlin the configuration example. This inconsistency could confuse users following the tutorial.📝 Proposed fix for consistency
service: - parsers_file: my-parsers.yaml + parsers_file: custom-parsers.yaml
🤖 Fix all issues with AI agents
In @administration/configuring-fluent-bit/classic-mode/configuration-file.md:
- Around line 163-164: The wording uses "file path" which violates the FluentBit
word list; update the sentence in the "includes section" line so it reads
"Environment variables aren't supported in includes section. The path must be
specified as a literal string." — replace "file path" with "path" to comply with
style guidelines and update any other occurrences of "file path" within the same
document or the includes-section paragraph to "path".
In @pipeline/filters/aws-metadata.md:
- Line 20: The Requirements section still uses the old awscli.amazonaws.com URL
for the instance-metadata-tags reference; replace both occurrences (the two
links referenced in the Requirements section / line 113) with the canonical AWS
docs URL used for `tags_enabled`
(https://docs.aws.amazon.com/.../modify-instance-metadata-options.html) so both
links point to the official docs.aws.amazon.com location for consistency.
In @pipeline/inputs/windows-exporter-metrics.md:
- Line 104: Update the three curl examples that currently use HTTPS to use plain
HTTP instead: change "https://127.0.0.1:2021/metrics" (occurrences in the curl
examples at lines 104, 133, and 157) to "http://127.0.0.1:2021/metrics"; if TLS
is required, add a brief note to use a reverse proxy/sidecar TLS terminator or
switch to prometheus_remote_write instead.
In @pipeline/outputs/kafka-rest-proxy.md:
- Line 3: Update the outdated Confluent docs link used in the kafka-rest plugin
docs: replace the current URL string
"https://docs.confluent.io/current/kafka-rest/docs/index.html" with the
redirected canonical URL
"https://docs.confluent.io/platform/current/kafka-rest/index.html" in the
kafka-rest documentation text so users are taken directly to the current Kafka
REST Proxy documentation without an extra redirect.
In @pipeline/outputs/splunk.md:
- Line 9: The Markdown link target for "Splunk / Use the HTTP Event Collector"
points to a versioned URL that returns 403; update that link URL to the
version-agnostic endpoint
https://docs.splunk.com/Documentation/SplunkCloud/latest/Data/UsetheHTTPEventCollector
so the documentation resolves reliably.
In @README.md:
- Line 42: The README contains a Fluentd link using https://fluentd.org which
causes SSL errors; update the markdown link text "Fluentd" to point to the
official domain https://www.fluentd.org so the link becomes
[Fluentd](https://www.fluentd.org), ensuring the HTTPS URL includes the www
subdomain.
🧹 Nitpick comments (4)
README.md (1)
9-9: Consider rewording to improve readability.Static analysis detected three successive sentences beginning with "Fluent Bit". While not a blocker, varying sentence structure would improve readability.
✍️ Suggested rewording
-[Fluent Bit](https://fluentbit.io) is a fast and lightweight telemetry agent for logs, metrics, and traces for Linux, macOS, Windows, and BSD family operating systems. Fluent Bit has been made with a strong focus on performance to allow the collection and processing of telemetry data from different sources without complexity. +[Fluent Bit](https://fluentbit.io) is a fast and lightweight telemetry agent for logs, metrics, and traces for Linux, macOS, Windows, and BSD family operating systems. It has been made with a strong focus on performance to allow the collection and processing of telemetry data from different sources without complexity.pipeline/filters/tensorflow.md (1)
5-5: Optional: Consider hyphenating "open source" when used as a compound adjective.The phrase "lightweight open source deep learning framework" would be more grammatically precise as "lightweight open-source deep learning framework" when the compound modifier precedes the noun.
📝 Suggested grammatical refinement
-Tensorflow Lite is a lightweight open source deep learning framework used for mobile and IoT applications. +Tensorflow Lite is a lightweight open-source deep learning framework used for mobile and IoT applications.pipeline/filters/ecs-metadata.md (1)
13-14: LGTM! Good conversion to relative documentation paths.The updates appropriately convert external links to relative internal paths, improving documentation maintainability.
Based on learnings from static analysis, consider adding a hyphen for the compound adjective:
✍️ Optional grammar improvement
-ECS_Tag_Prefix` option in the [Kubernetes filter](../filters/kubernetes.md) and performs the same function. The full log tag should be prefixed with this string and after the prefix the filter must find the next characters in the tag to be the Docker Container Short ID (the first 12 characters of the full container ID). The filter uses this to identify which container the log came from so it can find which task it's a part of. See the design section for more information. If not specified, it defaults to empty string, meaning that the tag must be prefixed with the 12 character container short ID. If you want to attach cluster metadata to system or OS logs from processes that don't run as part of containers or ECS Tasks, don't set this parameter and enable the `Cluster_Metadata_Only` option +ECS_Tag_Prefix` option in the [Kubernetes filter](../filters/kubernetes.md) and performs the same function. The full log tag should be prefixed with this string and after the prefix the filter must find the next characters in the tag to be the Docker Container Short ID (the first 12 characters of the full container ID). The filter uses this to identify which container the log came from so it can find which task it's a part of. See the design section for more information. If not specified, it defaults to empty string, meaning that the tag must be prefixed with the 12-character container short ID. If you want to attach cluster metadata to system or OS logs from processes that don't run as part of containers or ECS Tasks, don't set this parameter and enable the `Cluster_Metadata_Only` optionadministration/troubleshooting.md (1)
395-397: Table formatting adjusted for consistency.The Sub-entry column adjustments improve table structure consistency.
As per the static analysis hint, consider using "whether" instead of "if" for a more formal tone: "this entry will report whether the plugin is over the limit or not". However, this is a minor stylistic preference.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (49)
CONTRIBUTING.mdREADME.mdabout/fluentd-and-fluent-bit.mdadministration/aws-credentials.mdadministration/configuring-fluent-bit.mdadministration/configuring-fluent-bit/classic-mode/configuration-file.mdadministration/configuring-fluent-bit/classic-mode/upstream-servers.mdadministration/configuring-fluent-bit/yaml/multiline-parsers-section.mdadministration/configuring-fluent-bit/yaml/parsers-section.mdadministration/configuring-fluent-bit/yaml/service-section.mdadministration/configuring-fluent-bit/yaml/upstream-servers-section.mdadministration/http-proxy.mdadministration/memory-management.mdadministration/monitoring.mdadministration/troubleshooting.mdinstallation/downloads/aws-container.mdinstallation/downloads/docker.mdinstallation/downloads/kubernetes.mdinstallation/downloads/macos.mdinstallation/downloads/source/build-and-install.mdinstallation/upgrade-notes.mdpipeline/filters/aws-metadata.mdpipeline/filters/ecs-metadata.mdpipeline/filters/geoip2-filter.mdpipeline/filters/kubernetes.mdpipeline/filters/multiline-stacktrace.mdpipeline/filters/tensorflow.mdpipeline/inputs/cpu-metrics.mdpipeline/inputs/forward.mdpipeline/inputs/kafka.mdpipeline/inputs/nginx.mdpipeline/inputs/standard-input.mdpipeline/inputs/windows-exporter-metrics.mdpipeline/outputs/azure.mdpipeline/outputs/azure_blob.mdpipeline/outputs/azure_kusto.mdpipeline/outputs/azure_logs_ingestion.mdpipeline/outputs/elasticsearch.mdpipeline/outputs/forward.mdpipeline/outputs/http.mdpipeline/outputs/kafka-rest-proxy.mdpipeline/outputs/observe.mdpipeline/outputs/opensearch.mdpipeline/outputs/plot.mdpipeline/outputs/splunk.mdpipeline/outputs/treasure-data.mdpipeline/outputs/websocket.mdpipeline/parsers/configuring-parser.mdpipeline/parsers/multiline-parsing.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-12-12T14:30:18.461Z
Learnt from: kalavt
Repo: fluent/fluent-bit-docs PR: 2294
File: pipeline/inputs/kafka.md:147-168
Timestamp: 2025-12-12T14:30:18.461Z
Learning: In Fluent Bit v4.0.4+, when using AWS MSK IAM authentication (rdkafka.sasl.mechanism: aws_msk_iam), the rdkafka.security.protocol is automatically set to SASL_SSL and the AWS region is auto-detected from the broker hostname for standard MSK endpoints. The aws_msk_iam_cluster_arn parameter was removed - users only need to set rdkafka.sasl.mechanism: aws_msk_iam (and optionally aws_region for custom DNS/PrivateLink).
Applied to files:
pipeline/inputs/kafka.md
🪛 GitHub Actions: Lint PRs
administration/configuring-fluent-bit/classic-mode/configuration-file.md
[error] 163-163: [FluentBit.WordList] Use 'path' instead of 'file path'.
🪛 GitHub Check: runner / vale
administration/configuring-fluent-bit/classic-mode/configuration-file.md
[warning] 163-163:
[vale] reported by reviewdog 🐶
[FluentBit.WordList] Use 'path' instead of 'file path'.
Raw Output:
{"message": "[FluentBit.WordList] Use 'path' instead of 'file path'.", "location": {"path": "administration/configuring-fluent-bit/classic-mode/configuration-file.md", "range": {"start": {"line": 163, "column": 65}}}, "severity": "INFO"}
🪛 LanguageTool
README.md
[style] ~9-~9: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...dows, and BSD family operating systems. Fluent Bit has been made with a strong focus o...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
pipeline/filters/ecs-metadata.md
[grammar] ~14-~14: Use a hyphen to join words.
Context: ...hat the tag must be prefixed with the 12 character container short ID. If you wan...
(QB_NEW_EN_HYPHEN)
pipeline/filters/tensorflow.md
[grammar] ~5-~5: Use a hyphen to join words.
Context: .... Tensorflow Lite is a lightweight open source deep learning framework used for ...
(QB_NEW_EN_HYPHEN)
pipeline/outputs/azure_kusto.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ft-fabric/) cluster in Microsoft Fabric Real Time Analytics. ## Ingest into Azure Data E...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
administration/troubleshooting.md
[style] ~395-~395: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ...ackpressure.md), this entry will report if the plugin is over the limit or not at ...
(IF_WHETHER)
🔇 Additional comments (64)
administration/aws-credentials.md (2)
24-24: Good fix for markdown table formatting.The table separator now correctly matches the 3-column header structure with proper markdown syntax.
36-36: The updated documentation link is valid and accessible.The URL returns HTTP 200 and correctly points to the Amazon ECS task IAM role documentation.
installation/downloads/aws-container.md (1)
10-10: LGTM! Link updates align with PR objectives.The conversion of external Fluent Bit documentation links to relative internal paths is consistent and well-structured. All target documentation files exist at the specified relative paths (cloudwatch.md, firehose.md, kinesis.md, and s3.md in pipeline/outputs/).
Also applies to: 13-13, 16-16, 23-23
installation/downloads/macos.md (3)
39-133: LGTM! Shell command formatting improvements enhance readability.The reformatting of shell code blocks by removing prompt indicators (
$) and organizing commands into discrete, numbered steps makes the documentation clearer and more user-friendly. Commands are now easier to copy and execute.
180-180: LGTM! Clear instructions for users.The text provides clear guidance on how to halt the process, with proper formatting for the keyboard shortcut.
166-166: The relative link to the Dummy input plugin is valid. The filepipeline/inputs/dummy.mdexists and the path../../pipeline/inputs/dummyfrominstallation/downloads/macos.mdresolves correctly.installation/downloads/source/build-and-install.md (4)
147-156: LGTM! Table formatting improvements.The table reformatting enhances consistency and readability without altering any content.
Also applies to: 159-162
243-267: LGTM! Filter plugins table formatting standardized.The table reformatting improves visual consistency with other tables in the document without modifying any plugin links or descriptions.
3-3: File is newly created, not upgraded from HTTP. This is a new documentation file with HTTPS URLs already in place from the start—not a migration from HTTP. Thefluentbit.ioandcmake.orgURLs are properly formatted with HTTPS, and both are accessible (HTTP/2 200 and HTTP/1.1 200 OK respectively).Likely an incorrect or invalid review comment.
289-289: HTTPS upgrade for Fluentd link is correct.The URL has been properly updated to
https://www.fluentd.org, which is the official Fluentd website. This aligns with security best practices for external documentation links.installation/downloads/docker.md (1)
52-52: The link removal is correct—the v4.1.2 announcement page returns HTTP 404.The hyperlink to
https://fluentbit.io/announcements/v4.1.2/genuinely returns a 404, while all other release announcement pages (v4.1.1, v4.2.2, v4.1.0, etc.) return HTTP 200. Removing the broken link aligns with the PR's stated purpose of fixing 404 links and prevents users from encountering dead links. No changes needed.pipeline/outputs/observe.md (1)
3-3: LGTM! Consistent HTTPS upgrade.The HTTP to HTTPS upgrade for msgpack.org is consistent with the same update in
pipeline/outputs/websocket.md.pipeline/outputs/websocket.md (1)
3-3: The external links already use HTTPS and are properly configured.Both MessagePack (line 3) and Fluent Bit (line 140) are already using HTTPS in the file. The verification confirms both domains are accessible via HTTPS with successful responses. No HTTP to HTTPS upgrades appear to have been made in this change—the links were already secure.
pipeline/outputs/plot.md (1)
7-7: The review comment's premise is incorrect. This is a new file creation, not an HTTP to HTTPS upgrade. Additionally, the HTTPS URL for gnuplot.info has SSL certificate verification issues (curl returns exit code 60), indicating the link may not be reliably accessible.Consider whether the gnuplot.info HTTPS endpoint is stable or if an alternative reference should be used.
Likely an incorrect or invalid review comment.
pipeline/filters/geoip2-filter.md (1)
9-9: MaxMind GeoLite2 URL is correct and accessible.The URL
https://dev.maxmind.com/geoip/geolite2-free-geolocation-data/returns HTTP 200 and matches MaxMind's official developer portal documentation. The path update is accurate.about/fluentd-and-fluent-bit.md (1)
29-29: LGTM! Security improvement with HTTP→HTTPS upgrade.The Apache License links have been correctly updated to use HTTPS and the canonical
apache.orgdomain (without www), improving security for users following the documentation. The link is accessible and returns HTTP 200.pipeline/outputs/http.md (1)
3-3: MessagePack link correctly uses HTTPS and is accessible.The file was newly created with the HTTPS link already in place. The
https://msgpack.orglink is accessible and properly formatted.Likely an incorrect or invalid review comment.
administration/memory-management.md (1)
21-21: The jemalloc documentation section was newly added with HTTPS, not upgraded from HTTP.The git history shows commit c395b08 "Updating a bunch more links" added this entire section to the file for the first time. The link
https://jemalloc.net/is correctly using HTTPS and is accessible, but the change was not an upgrade—it was a new addition. The review comment's characterization of this as an "HTTP→HTTPS upgrade" is inaccurate.Likely an incorrect or invalid review comment.
README.md (1)
9-9: [Your rewritten review comment text here]
[Exactly ONE classification tag]administration/configuring-fluent-bit/yaml/upstream-servers-section.md (1)
3-3: LGTM! Improved internal documentation linking.Converting external URLs to internal relative paths improves documentation maintainability and ensures links remain valid across different documentation versions.
pipeline/outputs/treasure-data.md (1)
3-3: LGTM! Protocol upgraded to HTTPS.The HTTP to HTTPS upgrade aligns with security best practices for external link references.
pipeline/inputs/standard-input.md (1)
50-50: LGTM! Protocol upgraded to HTTPS.Both Fluent Bit website references correctly updated from HTTP to HTTPS.
Also applies to: 63-63
pipeline/inputs/kafka.md (1)
21-21: LGTM! Updated to official Confluent-maintained repository.The librdkafka project is now officially maintained by Confluent. Updating the documentation reference from
edenhill/librdkafkatoconfluentinc/librdkafkaensures users access the current, actively maintained configuration documentation.pipeline/outputs/azure_blob.md (1)
7-7: URL path correctly updated to current Microsoft documentation structure.The Azure Blob Storage URL has been updated to the current
/products/path and is accessible. The change aligns with Microsoft's site reorganization.pipeline/outputs/opensearch.md (1)
35-35: LGTM! Protocol upgrade to HTTPS.The update from HTTP to HTTPS for the man7.org strftime documentation link is appropriate and improves security.
pipeline/parsers/configuring-parser.md (2)
33-33: LGTM! Protocol upgrade to HTTPS.The update from HTTP to HTTPS for the man7.org strftime documentation link is appropriate.
7-7: The internal documentation links are valid.The target file
administration/configuring-fluent-bit/yaml/parsers-section.mdexists and contains the referenced sections about theparserssection and standalone parser files. The link paths are correctly updated.pipeline/outputs/azure_kusto.md (1)
7-7: LGTM! Microsoft Learn documentation links updated.The updates to Microsoft Learn URLs are appropriate and align with Microsoft's documentation platform migration. The links follow the current documentation structure.
Also applies to: 14-14
pipeline/inputs/cpu-metrics.md (1)
57-57: LGTM! Protocol upgrades to HTTPS.The updates from HTTP to HTTPS for Fluentd and Elasticsearch links are appropriate and improve security.
pipeline/inputs/nginx.md (1)
191-191: The repository path change is correct and reflects the official migration from thenginxincorganization to thenginxorganization. The old path (nginxinc/nginx-prometheus-exporter) permanently redirects to the new location (nginx/nginx-prometheus-exporter), and the updated documentation link is accurate.pipeline/outputs/elasticsearch.md (1)
7-7: LGTM! HTTP to HTTPS protocol upgrades.The updates to use HTTPS for both the Elasticsearch product link and the strftime documentation improve security and align with modern best practices.
Also applies to: 39-39
CONTRIBUTING.md (2)
69-69: No changes required. The updated GitBook URL (gitbook.com/docs/) is the correct current documentation URL. The old URL (docs.gitbook.com) remains functional with a 302 redirect to the new location, confirming the URL change is accurate.
8-8: The documentation URL is correctly pointing to the canonical Fluent Bit manual.The
/manual/path is the proper location for the Fluent Bit documentation library. This update accurately reflects the full canonical URL and improves clarity in the CONTRIBUTING.md file.pipeline/filters/tensorflow.md (1)
3-3: The updated TensorFlow Lite documentation URLs athttps://ai.google.dev/edge/litertare valid and resolve correctly.pipeline/outputs/azure.md (1)
7-7: Azure URLs are correct and accessible.Both updated Azure URLs are working properly. The product URL (
/products/monitor/) and documentation URL (learn.microsoft.com) both return HTTP 200. The legacy service URL correctly redirects to the new product page.administration/monitoring.md (1)
461-461: The Grafana dashboard URL reference is correct. Dashboard ID 7752 is the confirmed "Logging Dashboard" by Banzai Cloud for the logging-operator. Adding the slug suffix (logging-dashboard) to the URL is valid and follows standard Grafana practices—the slug is optional but improves readability and can be included without affecting resolution. No action required.administration/http-proxy.md (1)
32-32: LGTM! Good conversion to relative paths and HTTPS.The changes appropriately convert the external documentation link to a relative internal path and upgrade the MDN reference to HTTPS, aligning with the PR's objective to fix redirects and broken links.
administration/configuring-fluent-bit/yaml/parsers-section.md (1)
3-3: LGTM! Relative path updates align with documentation reorganization.The updated relative paths correctly reflect the file's location in the documentation structure.
Also applies to: 38-38
pipeline/filters/kubernetes.md (1)
57-57: LGTM! Minor formatting improvements.The changes normalize whitespace and formatting in the documentation table without altering any content or semantics.
Also applies to: 66-68, 77-77, 595-597
installation/upgrade-notes.md (2)
54-60: LGTM! Formatting standardization.The code block formatting changes improve consistency across the documentation without altering content.
Also applies to: 68-75, 79-87, 99-133
27-27: Google Cloud documentation URLs are all accessible.All three URLs return HTTP 200 and are properly accessible. The updated documentation links are valid.
pipeline/filters/ecs-metadata.md (1)
29-29: LGTM! Consistent relative path usage.The relative paths are correctly updated throughout the file.
Also applies to: 206-206
installation/downloads/kubernetes.md (3)
7-7: LGTM: Protocol upgrade to HTTPS.Good security practice to upgrade the Fluent Bit homepage link from HTTP to HTTPS.
49-49: LGTM: Updated to the main branch.Good practice to update the GitHub link from the
masterbranch to themainbranch, aligning with GitHub's current default branch naming convention.
17-17: The Kubernetes filter plugin documentation path is correct.The link
../../pipeline/filters/kubernetesfrominstallation/downloads/kubernetes.mdcorrectly resolves topipeline/filters/kubernetes.md, which exists and contains valid Kubernetes filter documentation.pipeline/outputs/azure_logs_ingestion.md (2)
26-36: LGTM: Table formatting refinement.The table formatting has been adjusted for consistency. No content changes detected.
21-21: Update the Azure Logs Ingestion API documentation link to the correct URL.The URL currently points to the general Azure Monitor overview page instead of the Azure Logs Ingestion API documentation. Update line 21 to use:
https://learn.microsoft.com/azure/azure-monitor/logs/logs-ingestion-api-overviewLikely an incorrect or invalid review comment.
administration/configuring-fluent-bit/classic-mode/configuration-file.md (1)
55-55: The link to../../../pipeline/inputs.mdis correctly updated and the target file exists. No issues found.administration/configuring-fluent-bit.md (1)
10-10: Path verification passed. The Tail input plugin documentation exists at the updated locationpipeline/inputs/tail.md. The documentation reorganization fromdata-pipelinetopipelineis correctly implemented.administration/configuring-fluent-bit/yaml/service-section.md (1)
13-15: Verify the updated internal documentation link targets exist.The internal link paths reference target files that are documented in the Fluent Bit project (parsers-section.md, stream-processing/overview.md). However, the relative path resolution cannot be definitively confirmed without direct access to the repository structure. The review should verify:
- The relative paths
../yaml/parsers-section.md#standalone-parsers-files,../yaml/plugins-section.md, and../../../stream-processing/overview.mdresolve correctly fromadministration/configuring-fluent-bit/yaml/service-section.md- All three target files exist at their resolved locations in the documentation structure
administration/configuring-fluent-bit/classic-mode/upstream-servers.md (2)
3-3: LGTM! Link target corrected with proper file extension.Adding the
.mdextension makes the cross-reference more explicit and ensures proper rendering in documentation systems.
63-65: LGTM! Text reformatted for readability.The reformatting across multiple lines improves readability while preserving the original meaning.
administration/troubleshooting.md (2)
286-286: LGTM! Converted external URL to internal relative path.Using a relative path instead of an external URL improves documentation maintainability and ensures links remain valid during version changes.
420-426: LGTM! Table structure refined.The formatting adjustments to the chunks-related entries improve table consistency and readability.
pipeline/outputs/forward.md (2)
3-3: LGTM! Protocol upgraded to HTTPS.Updating links to use HTTPS instead of HTTP improves security and avoids unnecessary redirects. This aligns with modern web standards.
Also applies to: 5-5
52-52: LGTM! Fluentd installation link upgraded to HTTPS.The protocol upgrade ensures secure access to the Fluentd installation documentation.
pipeline/parsers/multiline-parsing.md (1)
35-35: LGTM! Cross-reference path correctly updated.The relative path correctly navigates from
pipeline/parsers/to the configuration documentation atadministration/configuring-fluent-bit/yaml/multiline-parsers-section.md. This creates proper bidirectional linking between the multiline parsing documentation and its configuration reference.administration/configuring-fluent-bit/yaml/multiline-parsers-section.md (1)
3-3: Relative path corrected and verified.The path depth has been corrected from
../../to../../../to properly navigate fromadministration/configuring-fluent-bit/yaml/to the root, then down topipeline/parsers/multiline-parsing.md. The target file exists at the expected location, and both lines 3 and 37 use the correct relative path.pipeline/inputs/forward.md (4)
3-3: LGTM! Protocol upgrade to HTTPS.The URLs for Fluent Bit and Fluentd have been correctly updated to use HTTPS.
9-23: AI summary incorrectly claims these are new additions.The AI summary states that configuration options (listen, port, security.users, self_hostname, shared_key, tag, tag_prefix, threaded, unix_path, unix_perm) were "added" to this file. However, these lines are not marked with
~, indicating they already existed before this PR. The actual changes in this file are limited to HTTP→HTTPS URL updates.
191-191: LGTM! Protocol upgrade to HTTPS.The Fluentd documentation URL has been correctly updated to use HTTPS.
203-203: LGTM! Protocol upgrade to HTTPS.The Fluent Bit URL has been correctly updated to use HTTPS.
pipeline/filters/multiline-stacktrace.md (2)
318-318: LGTM! Protocol upgrade to HTTPS and URL correction.The Docker documentation URL has been correctly updated to use HTTPS and points to the current Fluentd logging driver documentation.
18-18: No changes needed — the relative path is correct.The file
pipeline/parsers/multiline-parsing.mdexists and the relative path../../pipeline/parsers/multiline-parsing.mdcorrectly resolves frompipeline/filters/multiline-stacktrace.md.
| Environment variables aren't supported in includes section. The file path must be | ||
| specified as a literal string. |
There was a problem hiding this comment.
Fix the terminology to comply with style guidelines.
The pipeline failure and static analysis indicate that "file path" should be "path" per FluentBit word list.
📝 Proposed fix
-Environment variables aren't supported in includes section. The file path must be
-specified as a literal string.
+Environment variables aren't supported in includes section. The path must be
+specified as a literal string.🧰 Tools
🪛 GitHub Actions: Lint PRs
[error] 163-163: [FluentBit.WordList] Use 'path' instead of 'file path'.
🪛 GitHub Check: runner / vale
[warning] 163-163:
[vale] reported by reviewdog 🐶
[FluentBit.WordList] Use 'path' instead of 'file path'.
Raw Output:
{"message": "[FluentBit.WordList] Use 'path' instead of 'file path'.", "location": {"path": "administration/configuring-fluent-bit/classic-mode/configuration-file.md", "range": {"start": {"line": 163, "column": 65}}}, "severity": "INFO"}
🤖 Prompt for AI Agents
In @administration/configuring-fluent-bit/classic-mode/configuration-file.md
around lines 163 - 164, The wording uses "file path" which violates the
FluentBit word list; update the sentence in the "includes section" line so it
reads "Environment variables aren't supported in includes section. The path must
be specified as a literal string." — replace "file path" with "path" to comply
with style guidelines and update any other occurrences of "file path" within the
same document or the includes-section paragraph to "path".
| | `hostname` | The hostname for the current EC2 instance. | `false` | | ||
| | `vpc_id` | The VPC ID for the current EC2 instance. | `false` | | ||
| | `tags_enabled` | Specifies whether to attach EC2 instance tags. The EC2 instance must have the [`instance-metadata-tags`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-metadata-options.html) option enabled, which is disabled by default. | `false` | | ||
| | `tags_enabled` | Specifies whether to attach EC2 instance tags. The EC2 instance must have the [`instance-metadata-tags`](https://docs.aws.amazon.com/cli/latest/reference/ec2/modify-instance-metadata-options.html) option enabled, which is disabled by default. | `false` | |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, check if the file exists and examine the relevant lines
if [ -f "pipeline/filters/aws-metadata.md" ]; then
echo "=== File exists. Checking line 20 ==="
sed -n '20p' pipeline/filters/aws-metadata.md
echo ""
echo "=== Checking line 113 ==="
sed -n '113p' pipeline/filters/aws-metadata.md
echo ""
echo "=== Context around line 113 (lines 110-115) ==="
sed -n '110,115p' pipeline/filters/aws-metadata.md
else
echo "File not found at pipeline/filters/aws-metadata.md"
# Try searching for it
find . -name "aws-metadata.md" -type f
fiRepository: fluent/fluent-bit-docs
Length of output: 2031
🏁 Script executed:
# Test both URLs for accessibility
echo "=== Testing docs.aws.amazon.com URL (line 20) ==="
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" \
"https://docs.aws.amazon.com/cli/latest/reference/ec2/modify-instance-metadata-options.html"
echo ""
echo "=== Testing awscli.amazonaws.com URL (line 113) ==="
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" \
"https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-metadata-options.html"Repository: fluent/fluent-bit-docs
Length of output: 202
Update line 113 to use the official AWS documentation URL for consistency.
Line 113 still references instance-metadata-tags using awscli.amazonaws.com (which returns a 301 redirect), while line 20 was correctly updated to use docs.aws.amazon.com (HTTP 200). Line 113 appears twice in the Requirements section and should be updated to match the official AWS documentation link from line 20.
🤖 Prompt for AI Agents
In @pipeline/filters/aws-metadata.md at line 20, The Requirements section still
uses the old awscli.amazonaws.com URL for the instance-metadata-tags reference;
replace both occurrences (the two links referenced in the Requirements section /
line 113) with the canonical AWS docs URL used for `tags_enabled`
(https://docs.aws.amazon.com/.../modify-instance-metadata-options.html) so both
links point to the official docs.aws.amazon.com location for consistency.
| # After starting the service try it with: | ||
| # | ||
| # $ curl http://127.0.0.1:2021/metrics | ||
| # $ curl https://127.0.0.1:2021/metrics |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, check if the file exists and read the relevant lines
if [ -f "pipeline/inputs/windows-exporter-metrics.md" ]; then
echo "=== Checking lines around 104, 133, 157 ==="
echo "--- Lines 100-110 ---"
sed -n '100,110p' pipeline/inputs/windows-exporter-metrics.md
echo ""
echo "--- Lines 130-140 ---"
sed -n '130,140p' pipeline/inputs/windows-exporter-metrics.md
echo ""
echo "--- Lines 155-165 ---"
sed -n '155,165p' pipeline/inputs/windows-exporter-metrics.md
else
echo "File not found"
fiRepository: fluent/fluent-bit-docs
Length of output: 798
🌐 Web query:
Fluent Bit prometheus_exporter output plugin HTTPS TLS SSL configuration support
💡 Result:
Short answer: The prometheus_exporter output in Fluent Bit only exposes an HTTP endpoint (host/port) and does not include built‑in TLS/HTTPS configuration options. Use an external TLS terminator (reverse proxy / sidecar) or use the prometheus_remote_write output (which has TLS options) if you need encrypted transport.
Sources:
- prometheus_exporter plugin docs (shows host/port only; no TLS options). [1]
- prometheus_remote_write docs (lists tls/tls.verify and other TLS settings). [2]
References:
[1] Fluent Bit — Prometheus exporter documentation.
[2] Fluent Bit — Prometheus remote write documentation.
Critical: HTTPS protocol not supported by prometheus_exporter plugin.
The curl examples use HTTPS, but the prometheus_exporter output plugin only supports HTTP endpoints and has no built-in TLS/SSL configuration options. Users following these examples will encounter SSL connection failures.
Revert all three curl commands to HTTP:
Fix
-# $ curl https://127.0.0.1:2021/metrics
+# $ curl http://127.0.0.1:2021/metricsApply the same change at lines 104, 133, and 157.
If HTTPS is required, use a reverse proxy or sidecar TLS terminator in front of the prometheus_exporter endpoint, or switch to the prometheus_remote_write output plugin which has native TLS support.
Also applies to: 133-133, 157-157
🤖 Prompt for AI Agents
In @pipeline/inputs/windows-exporter-metrics.md at line 104, Update the three
curl examples that currently use HTTPS to use plain HTTP instead: change
"https://127.0.0.1:2021/metrics" (occurrences in the curl examples at lines 104,
133, and 157) to "http://127.0.0.1:2021/metrics"; if TLS is required, add a
brief note to use a reverse proxy/sidecar TLS terminator or switch to
prometheus_remote_write instead.
pipeline/outputs/kafka-rest-proxy.md
Outdated
| # Kafka REST proxy | ||
|
|
||
| The _Kafka rest_ (`kafka-rest`) output plugin lets you flush your records into a [Kafka REST Proxy](http://docs.confluent.io/current/kafka-rest/docs/index.html) server. The following instructions assume you have an operational Kafka REST Proxy and Kafka services running in your environment. | ||
| The _Kafka rest_ (`kafka-rest`) output plugin lets you flush your records into a [Kafka REST Proxy](https://docs.confluent.io/current/kafka-rest/docs/index.html) server. The following instructions assume you have an operational Kafka REST Proxy and Kafka services running in your environment. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Check if file exists and examine its content around line 3
if [ -f "pipeline/outputs/kafka-rest-proxy.md" ]; then
echo "=== File exists. Content around line 3: ==="
sed -n '1,10p' "pipeline/outputs/kafka-rest-proxy.md"
echo ""
echo "=== Line count ==="
wc -l "pipeline/outputs/kafka-rest-proxy.md"
else
echo "File not found at pipeline/outputs/kafka-rest-proxy.md"
# Try to find similar files
find . -name "*kafka*rest*" -type f 2>/dev/null | head -20
fiRepository: fluent/fluent-bit-docs
Length of output: 615
🏁 Script executed:
# Verify the HTTPS link is accessible
curl -I -L --max-time 10 https://docs.confluent.io/current/kafka-rest/docs/index.html 2>&1 | head -20Repository: fluent/fluent-bit-docs
Length of output: 1062
The HTTPS URL is accessible but may be outdated.
The documented link (https://docs.confluent.io/current/kafka-rest/docs/index.html) is reachable via HTTPS and returns a 200 response; however, it redirects to https://docs.confluent.io/platform/current/kafka-rest/index.html, suggesting the URL path in the documentation may be stale. Consider updating to the redirect target for better user experience and to avoid unnecessary redirects.
🤖 Prompt for AI Agents
In @pipeline/outputs/kafka-rest-proxy.md at line 3, Update the outdated
Confluent docs link used in the kafka-rest plugin docs: replace the current URL
string "https://docs.confluent.io/current/kafka-rest/docs/index.html" with the
redirected canonical URL
"https://docs.confluent.io/platform/current/kafka-rest/index.html" in the
kafka-rest documentation text so users are taken directly to the current Kafka
REST Proxy documentation without an extra redirect.
pipeline/outputs/splunk.md
Outdated
| The _Splunk_ output plugin lets you ingest your records into a [Splunk Enterprise](https://www.splunk.com/en_us/products/splunk-enterprise.html) service through the HTTP Event Collector (HEC) interface. | ||
|
|
||
| To learn how to set up the HEC in Splunk, refer to [Splunk / Use the HTTP Event Collector](http://docs.splunk.com/Documentation/Splunk/7.0.3/Data/UsetheHTTPEventCollector). | ||
| To learn how to set up the HEC in Splunk, refer to [Splunk / Use the HTTP Event Collector](https://docs.splunk.com/Documentation/Splunk/7.0.3/Data/UsetheHTTPEventCollector). |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify HTTPS is available for Splunk docs URL
curl -I -L -s -o /dev/null -w "Splunk docs: %{http_code}\n" "https://docs.splunk.com/Documentation/Splunk/7.0.3/Data/UsetheHTTPEventCollector"Repository: fluent/fluent-bit-docs
Length of output: 82
🌐 Web query:
Splunk HTTP Event Collector documentation current version
💡 Result:
The current Splunk HTTP Event Collector (HEC) documentation is on Splunk Docs (Splunk Cloud and Splunk Enterprise). Key pages and their last-modified dates:
- "Set up and use HTTP Event Collector" — Splunk Docs (last modified April 14, 2025). (docs.splunk.com)
- "Set up and use HTTP Event Collector" — Splunk Help (Splunk Enterprise page, updated ~3 weeks ago). (help.splunk.com)
If you want a specific page (examples, format, troubleshooting), tell me which and I’ll fetch that exact doc.
Citations:
- 1: https://docs.splunk.com/Documentation/SplunkCloud/latest/Data/UsetheHTTPEventCollector?utm_source=openai
- 2: https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/9.1/get-data-with-http-event-collector/set-up-and-use-http-event-collector-in-splunk-web?utm_source=openai
Update the Splunk HEC documentation link to use version-agnostic URL.
The current link to version 7.0.3 documentation returns HTTP 403 (Forbidden). Use https://docs.splunk.com/Documentation/SplunkCloud/latest/Data/UsetheHTTPEventCollector instead, which provides version-agnostic access to the latest documentation and is maintained more reliably.
🤖 Prompt for AI Agents
In @pipeline/outputs/splunk.md at line 9, The Markdown link target for "Splunk /
Use the HTTP Event Collector" points to a versioned URL that returns 403; update
that link URL to the version-agnostic endpoint
https://docs.splunk.com/Documentation/SplunkCloud/latest/Data/UsetheHTTPEventCollector
so the documentation resolves reliably.
README.md
Outdated
| ## Fluent Bit, Fluentd, and CNCF | ||
|
|
||
| Fluent Bit is a [CNCF](https://cncf.io) graduated sub-project under the umbrella of [Fluentd](http://fluentd.org). | ||
| Fluent Bit is a [CNCF](https://cncf.io) graduated sub-project under the umbrella of [Fluentd](https://fluentd.org). |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Check the current state of line 42 in README.md
head -45 README.md | tail -5Repository: fluent/fluent-bit-docs
Length of output: 425
🏁 Script executed:
# Check git history for changes to README.md
git log --oneline -20 README.mdRepository: fluent/fluent-bit-docs
Length of output: 101
🏁 Script executed:
# Get the actual diff to see what changed in README.md
git diff HEAD~1 README.mdRepository: fluent/fluent-bit-docs
Length of output: 254
🏁 Script executed:
# Show the commit details that updated links
git show c395b08 --statRepository: fluent/fluent-bit-docs
Length of output: 19139
🏁 Script executed:
# Check if there are more commits available
git log --oneline -10Repository: fluent/fluent-bit-docs
Length of output: 101
🏁 Script executed:
# Test HTTPS link accessibility
curl -I -L --max-time 10 https://fluentd.org 2>&1 | head -20Repository: fluent/fluent-bit-docs
Length of output: 465
🏁 Script executed:
# Try curl with different parameters
curl -s -o /dev/null -w "%{http_code}\n" https://fluentd.orgRepository: fluent/fluent-bit-docs
Length of output: 70
🌐 Web query:
Fluentd official website HTTPS domain
💡 Result:
The official Fluentd HTTPS domain is: https://www.fluentd.org. [1][2]
Sources:
[1] Fluentd official site.
[2] Fluentd GitHub README (links to official site).
🏁 Script executed:
# Check if maybe there's a parent commit or branch info
git show-refRepository: fluent/fluent-bit-docs
Length of output: 326
🏁 Script executed:
# Check master branch README.md line 42
git show master:README.md | head -45 | tail -5Repository: fluent/fluent-bit-docs
Length of output: 424
🏁 Script executed:
# Compare the two versions
echo "=== Current branch (coderabbit_2322) ===" && \
git show coderabbit_2322:README.md | sed -n '42p' && \
echo "=== Master branch ===" && \
git show master:README.md | sed -n '42p'Repository: fluent/fluent-bit-docs
Length of output: 359
Update Fluentd link to use correct domain with www subdomain.
The HTTPS upgrade improves security, but the link https://fluentd.org fails with SSL errors. The official Fluentd domain is https://www.fluentd.org (with www), so the link should be updated to:
[Fluentd](https://www.fluentd.org)
🤖 Prompt for AI Agents
In @README.md at line 42, The README contains a Fluentd link using
https://fluentd.org which causes SSL errors; update the markdown link text
"Fluentd" to point to the official domain https://www.fluentd.org so the link
becomes [Fluentd](https://www.fluentd.org), ensuring the HTTPS URL includes the
www subdomain.
alexakreizinger
left a comment
alexakreizinger
left a comment
There was a problem hiding this comment.
heeding some of coderabbit's suggestions (I'm not sure that it's correct about the windows exporter plugin only supporting HTTP, but I do think it's probably for the best to not mess with the example snippets)... otherwise LGTM!
administration/configuring-fluent-bit/classic-mode/configuration-file.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Alexa Kreizinger <[email protected]> Signed-off-by: Lynette Miles <[email protected]>
esmerel
deleted the
lynettemiles/sc-159782/fb-broken-links-report-for-january-2026
branch
Correcting 404s for Jan 2026
Also correcting a whole lot of redirects, though these are less critical. Many redirects were http -> https so I just blanket corrected these through the docs where appropriate (ie, not in code samples, and not on the one place I found a non-https site)
At this point, I've spent a lot of time already.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.