Visitar URL original
Regenerate integrations docs by netdatabot · Pull Request #24194 · netdata/netdata · GitHub
Skip to content

Regenerate integrations docs - #24194

Merged
ilyam8 merged 1 commit into
masterfrom
integrations-regen
Oct 9, 2026
Merged

Regenerate integrations docs#24194
ilyam8 merged 1 commit into
masterfrom
integrations-regen

Conversation

@netdatabot

@netdatabot netdatabot commented Oct 8, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Regenerate the integrations docs based on the
latest metadata yaml code.

This PR was auto-generated by
.github/workflows/generate-integrations.yml.

Summary by CodeRabbit

  • Documentation
    • Clarified how to provision optional geography databases for RUM, check their status, and understand lookup availability and troubleshooting details. Geography collection can continue when lookup data is unavailable.
    • Updated NVIDIA Jetson documentation to include supported power-rail readings, their coverage, and troubleshooting guidance.
    • Expanded IPMI guidance to cover local collection and remote IPMI 1.5/2.0 setup, permissions, connection options, and job examples.

@netdatabot
netdatabot requested a review from Ancairon as a code owner October 8, 2026 05:57
@github-actions github-actions Bot added area/docs area/collectors Everything related to data collection collectors/go.d area/go labels Oct 8, 2026
@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 081d8e0c-269e-4080-bced-9c41ee7fea77
📥 Commits

Reviewing files that changed from the base of the PR and between 7fb586b and 9b40a25.

📒 Files selected for processing (3)
  • src/collectors/COLLECTORS.md
  • src/go/plugin/go.d/collector/jetson/integrations/nvidia_jetson.md
  • src/go/plugin/ipmi/collector/ipmi/integrations/ipmi_experimental_go_collector.md
 _______________________________________________
< Finding your faults 10 times faster than Mom. >
 -----------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 3d9d8d34-5561-4e80-becd-630787936d2c
📥 Commits

Reviewing files that changed from the base of the PR and between a38f9e7 and 1ee17bb.

📒 Files selected for processing (1)
  • src/go/plugin/dem/collector/receiver/integrations/rum_receiver.md

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

📝 Walkthrough

Walkthrough

The RUM receiver documentation now covers optional geography database setup, source selection and refresh, and troubleshooting geography availability and lookup status.

Changes

RUM geography documentation

Layer / File(s) Summary
Provisioning and source selection
src/go/plugin/dem/collector/receiver/integrations/rum_receiver.md		 Documents supported MMDB files, atomic updates, geoip_db source selection, periodic checks, and collection when geography is unavailable.
Status and troubleshooting
src/go/plugin/dem/collector/receiver/integrations/rum_receiver.md		 Explains geography status values, source failure details, snapshot reuse, mapped-memory faults, and lookup_errors counting behavior.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 1ee17

The geography guidance matches the documented receiver behavior; no issue identified here needs resolution before merge.

Architecture Summary

Architecture risk: 🔵 Low · up to 1ee17

The change affects 1 system.

Changed systems: src

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — src (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in src/go/plugin/dem/collector/receiver/integrations/rum_receiver.md: Added optional geography setup instructions: provision a supported MMDB readable by the Netdata service account; ASN and other unsupported types are rejected. Country databases provide no city coordinates, and accepted types may lack address coverage. Updates must use a complete temporary file followed by atomic rename; verify provisioning in rum-sites.
  • observed — Modified behavior in src/go/plugin/dem/collector/receiver/integrations/rum_receiver.md: Expanded geoip_db documentation. With no explicit path, DEM tries the Agent cache before the stock IP intelligence database, and a rejected cache file does not prevent trying the stock file. An explicit path disables fallback. Sources are checked at startup and every 60 seconds, and later provisioning or atomic replacement is adopted without restart; unavailable geography does not stop collection.
  • observed — Modified behavior in src/go/plugin/dem/collector/receiver/integrations/rum_receiver.md: Added troubleshooting guidance for missing or unexpected geography. It documents capture-policy and database-related causes, explains that loaded does not guarantee record validation or coverage, that using_previous retains a usable snapshot after candidate failures until confirmed source removal, and that unavailable does not stop browser collection. It directs operators to reason and logs, requires atomic replacement for supported readable MMDBs, and clarifies that mapped-memory-fault snapshots are not reused. lookup_errors counts active-generation errors rather than unmatched addresses or missing fields; refresh and fault changes publish through the receiver worker, while lookup counts upda
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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 accurately describes the documentation regeneration that produced the RUM receiver updates. It is concise and related to the main change.
✨ Finishing Touches
🧪 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[bot]
cubic-dev-ai Bot reviewed Oct 8, 2026
View reviewed changes

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

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.

No issues found across 1 file

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.
Architecture diagram 
sequenceDiagram
    participant Workflow as CI Workflow
    participant GenScript as Generate Docs Script
    participant Metadata as Metadata YAML Files
    participant Docs as RUM Receiver Docs
    participant Reviewer as PR Reviewer

    Note over Workflow,Docs: Documentation Regeneration Flow

    Workflow->>Workflow: Trigger on schedule/manual
    Workflow->>GenScript: Run generate-integrations.yml
    GenScript->>Metadata: Read latest metadata yaml
    Metadata-->>GenScript: Raw metadata content
    GenScript->>GenScript: Parse and transform metadata
    GenScript->>Docs: Write regenerated markdown
    
    Note over Docs,Reviewer: PR Review Flow (Implied)

    Docs->>Reviewer: Present PR with changes
    Reviewer->>Docs: Inspect diff

    Note over Docs: New sections in docs
    Docs->>Docs: Geography provisioning details
    Docs->>Docs: geoip_db option reference
    Docs->>Docs: Troubleshooting: Missing geography

    Note over Reviewer: Validate documentation accuracy
    Reviewer->>Docs: Check metadata alignment
    Reviewer->>Docs: Verify example correctness
Loading

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

@sonarqubecloud

sonarqubecloud Bot commented Oct 9, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@ilyam8
ilyam8 merged commit a946566 into master Oct 9, 2026
157 of 158 checks passed
@ilyam8
ilyam8 deleted the integrations-regen branch October 9, 2026 07:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cubic-dev-ai cubic-dev-ai[bot] cubic-dev-ai[bot] left review comments
@ilyam8 ilyam8 ilyam8 approved these changes
@Ancairon Ancairon Awaiting requested review from Ancairon Ancairon is a code owner

Assignees

No one assigned

Labels

area/collectors Everything related to data collection area/docs area/go collectors/go.d integrations-update

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@netdatabot @ilyam8