Skip to content

Fixed link url in stackdriver output plugin doc. Part of #2159. #2163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eschabell merged 1 commit into from
Nov 9, 2025
Merged

Fixed link url in stackdriver output plugin doc. Part of #2159. #2163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pipeline/outputs/stackdriver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,4 +295,4 @@ Check the following:

Stackdriver officially supports a [logging agent based on Fluentd](https://cloud.google.com/logging/docs/agent).

Fluent Bit plans to support some [special fields in structured payloads](https://cloud.google.com/logging/docs/agent/configuration#special-fields). For more information, see the documentation about [Stackdriver Special Fields](./stackdriver_special_fields.md#log-entry-fields).
Fluent Bit plans to support some [special fields in structured payloads](https://cloud.google.com/logging/docs/agent/configuration#special-fields). For more information, see the documentation about [Stackdriver Special Fields](stackdriver_special_fields.md#logentry-fields).

@coderabbitai coderabbitai Bot Nov 9, 2025

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.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify link consistency and anchor correctness.

The link update on line 298 changes from an absolute GitHub URL with anchor #log-entry-fields to a relative path with anchor #logentry-fields. This creates an inconsistency with similar references on lines 31 and 258, which both use absolute GitHub URLs with the #log-entry-fields anchor.

Before merging, verify:

  1. Whether the stackdriver_special_fields.md file uses #logentry-fields or #log-entry-fields as the anchor
  2. Whether the relative path resolves correctly in the documentation system, or if absolute URLs should be used consistently
  3. Whether lines 31 and 258 should also be updated to use #logentry-fields, or if line 298 should match them

🏁 Script executed:

#!/bin/bash
# Description: Verify the target file exists and check for correct anchor identifiers

# Search for the stackdriver_special_fields.md file
echo "=== Searching for stackdriver_special_fields.md ==="
fd stackdriver_special_fields.md

# If found, extract heading-like patterns that could generate anchors
echo -e "\n=== Checking for potential anchors in the file ==="
if fd stackdriver_special_fields.md -x cat {} \; 2>/dev/null | head -50; then
  fd stackdriver_special_fields.md -x cat {} \; 2>/dev/null | grep -E "^#+\s.*[Ll]og[- ]?[Ee]ntry|^#+\s.*[Ff]ield" | head -20
fi

# Show all links in the current stackdriver.md that reference stackdriver_special_fields
echo -e "\n=== All references to stackdriver_special_fields in stackdriver.md ==="
rg -n "stackdriver_special_fields" pipeline/outputs/stackdriver.md

Length of output: 5534

Update anchor identifiers on lines 31 and 258, and consider link path consistency.

The change on line 298 correctly updates the anchor from #log-entry-fields to #logentry-fields, which matches the actual heading in stackdriver_special_fields.md (## LogEntry fields). However, lines 31 and 258 still use the incorrect anchor #log-entry-fields and should be updated to #logentry-fields as well.

Additionally, consider standardizing the link format: line 298 uses a relative path while lines 31 and 258 use absolute GitHub URLs. Decide whether all references should use relative or absolute paths for consistency.

Changes needed:

  • Line 31: Change #log-entry-fields → #logentry-fields
  • Line 258: Change #log-entry-fields → #logentry-fields
  • Standardize path format across all three references (lines 31, 258, 298)
🤖 Prompt for AI Agents 
In pipeline/outputs/stackdriver.md around lines 31, 258 and 298, update the
anchor references so they consistently use #logentry-fields (not
#log-entry-fields) to match the actual heading in stackdriver_special_fields.md,
and make the link paths consistent across all three locations (choose either
relative paths like stackdriver_special_fields.md#logentry-fields or absolute
GitHub URLs and apply uniformly); modify lines 31 and 258 to replace
#log-entry-fields with #logentry-fields and adjust all three links to the chosen
consistent path format.