Skip to content

Finish the DCstat legacy-route catalogue migration - #3126

Merged
ktsaou merged 1 commit into
masterfrom
fix/finish-ebpf-dcstat-catalogue-migration
Oct 10, 2026
Merged

ktsaou merged 1 commit into
masterfrom
fix/finish-ebpf-dcstat-catalogue-migration

Conversation

@ktsaou

@ktsaou ktsaou commented Oct 8, 2026 •

Copy link
Copy Markdown
Member

DCstat moved from the C collector to the Go collector, but the canonical catalogue entry still names the obsolete producer. A second published C slug also needs a retained destination before that producer is removed.

Map all five DCstat catalogue routes to the Go source, including the canonical route and the suffixed legacy slug. Keep the fail-closed catalogue gate and reviewed-retirement policy unchanged. The existing migration test now names the complete route set.

Validation: 30 catalogue tests and 13 cleanup tests passed. Normal Agent generation followed by full Learn ingestion passed; the result has one DCstat page and one card per collector grid. The exact Node 22.23.2 production build passed the title, heading, redirect, rendered-link, indexability, Cloudflare RUM and static-site gates. A source-only compatibility check also passed against the currently published C and Go mappings.

Merge this catalogue change before removing the Agent preservation and CI-only deletion workaround. Generated documentation and redirects remain owned by the normal ingestion workflow and are not included in this source change.


Summary by cubic

Completes the DCstat legacy-route catalogue migration so all five DCstat documentation routes resolve against the Go collector source instead of the obsolete C producer.

The canonical ebpf-dcstat route now maps to the Go integration file, and the suffixed -ebpf-plugin legacy slug is retained against the same source. The migration test now asserts the complete route set instead of counting three routes.

Written for commit 4566b28. Summary will update on new commits.

View guided diff Turn on auto-fix

Summary by CodeRabbit

  • Bug Fixes
    • Updated the eBPF dcstat documentation redirect to the current integration page and added an alternate URL alias.
    • Adjusted redirect validation to account for the expanded set of routes.

@netlify

netlify Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for netdata-docusaurus ready!

Name Link
🔨 Latest commit 4566b28
🔍 Latest deploy log https://app.netlify.com/projects/netdata-docusaurus/deploys/6ac81ed62dc5d80008e968c1
😎 Deploy Preview https://deploy-preview-3126--netdata-docusaurus.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b6dab3de-7360-4510-9074-4da1c39e6d60

📥 Commits

Reviewing files that changed from the base of the PR and between 3e846ee and 4566b28.


📒 Files selected for processing (2)
  • LegacyLearnCorrelateLinksWithGHURLs.json
  • ingest/test_legacy_redirect_gate.py

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.



📝 Walkthrough

Walkthrough

The ebpf-dcstat mapping now points to the ebpfgo.plugin integration page. A second alias uses the same destination. The catalogue test expects five routes and retains its route-resolution and canonical-route checks.

Changes

eBPF dcstat redirects

Layer / File(s) Summary
Update dcstat redirect mapping and test
LegacyLearnCorrelateLinksWithGHURLs.json, ingest/test_legacy_redirect_gate.py
The ebpf-dcstat mapping points to the ebpfgo.plugin integration page, and the ebpf-dcstat-ebpf-plugin alias points to the same page. The test expects five routes and continues to check route resolution and canonical-route absence.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Bug fix

Suggested reviewers: ilyam8


Merge Risk | ⚪ Minimal · up to 4566b

Merge Risk: ⚪ Minimal · up to 4566b

The DCstat catalogue now directs the existing route and a new alias to the Go integration page, with the route test updated for the expanded set. No actionable merge-blocking issue is established by the supplied evidence.

Security Architecture Review

Security architecture risk: ⚪ Minimal · up to 4566b

The change consolidates five documentation routes onto the Go collector source without adding a new trust boundary or weakening redirect safeguards. Existing controls preserve live destinations, prevent redirects from shadowing published pages, and reject unclassified routes before output is written.

Retained concerns
No architecture-level concerns identified.

Security review details

Security Blast Radius

  • inferred — The changed exposure is bounded to navigation for the five DCstat documentation routes. The inspected change provides no new request handler, credential authority, tenant access, or collector execution capability; the repository and generator authority remain unchanged.

Trust Boundaries and Controls

  • observed — The existing gate rejects unclassified entries, requires retained tracked destinations to be active, and restricts reviewed retirement to matching route and source identities. Active-page cleanup prevents generated redirects from overriding published pages. Human-owned static rules remain an existing policy exception, not a new bypass introduced here.

Resilience and Maintainability Implications

  • observed — Gate rejection contains failure before output mutation. Existing lifecycle tests cover pending and completed source moves, dead retained targets, moved-entry ordering, and rejection without persistent changes; the PR leaves that failure-containment behavior intact.

Pre-merge checks | Passed 4 | Failed 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (1 skipped: 1 … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: completing the DCstat legacy-route catalogue migration.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (1 skipped: 1 unsupported.)


  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Commit to this branch
  • Create a new PR

🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 2 files

Architecture diagram
sequenceDiagram
    participant IG as Ingest Pipeline
    participant Cat as Catalogue Service
    participant Gate as Redirect Gate
    participant Test as Test Suite
    participant Source as Go Collector Source

    Note over IG,Source: DCstat Catalogue Route Migration (Current State)

    IG->>IG: Run catalogue ingestion workflow
    IG->>Cat: Query DCstat catalogue entries
    Cat->>Cat: Resolve canonical + legacy routes
    
    alt Canonical route (ebpf-dcstat)
        Cat->>Source: Map to Go collector integration
        Source-->>Cat: ebpf_dcstat.md (Go source)
    else Legacy slug (ebpf-dcstat-ebpf-plugin)
        Cat->>Source: Map to Go collector integration
        Source-->>Cat: ebpf_dcstat.md (Go source)
    end
    
    Cat->>Gate: Submit route set for validation
    Gate->>Gate: Check fail-closed gate conditions
    Gate->>Test: Run redirect validation
    
    Test->>Test: Verify complete route set (5 routes)
    Test-->>Gate: Validation results
    
    alt All routes resolved or retained
        Gate-->>Cat: Pass - routes valid
        Cat->>Cat: Generate documentation + redirects
    else Missing route(s)
        Gate-->>Cat: Fail - gate stays closed
        Cat->>Cat: Retain C source fallback
    end

    Note over IG,Source: Supported Routes:
    Note over IG,Source: 1. /docs/data-collection/ebpf/ebpf-dcstat
    Note over IG,Source: 2. /docs/collecting-metrics/ebpf/ebpf-dcstat
    Note over IG,Source: 3. /docs/collecting-metrics/operating-systems/ebpf-dcstat
    Note over IG,Source: 4. /docs/collecting-metrics/collectors/operating-systems/ebpf-dcstat
    Note over IG,Source: 5. .../ebpf-dcstat-ebpf-plugin (legacy slug)
Loading

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread LegacyLearnCorrelateLinksWithGHURLs.json
@ktsaou
ktsaou marked this pull request as draft October 9, 2026 09:36
@ktsaou
ktsaou marked this pull request as ready for review October 10, 2026 12:23
@ktsaou
ktsaou merged commit 4c54e85 into master Oct 10, 2026
14 checks passed
@ktsaou
ktsaou deleted the fix/finish-ebpf-dcstat-catalogue-migration branch October 10, 2026 14:24
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.

3 participants