Skip to content

Docs: dmesg enricher actions + fix pod_dmesg_enricher log message - #2146

Open
gitanshulbisht wants to merge 1 commit into
robusta-dev:masterfrom
gitanshulbisht:feat/dmesg-enricher-docs
Open

Docs: dmesg enricher actions + fix pod_dmesg_enricher log message#2146
gitanshulbisht wants to merge 1 commit into
robusta-dev:masterfrom
gitanshulbisht:feat/dmesg-enricher-docs

Conversation

@gitanshulbisht

Copy link
Copy Markdown

Fixes #549

The dmesg enricher was already implemented (node_dmesg_enricher, pod_dmesg_enricher), but was never surfaced in the docs and pod_dmesg_enricher had a copy-paste bug in its error log. This PR:

  • Adds .. robusta-action:: directives for node_dmesg_enricher and pod_dmesg_enricher in event-enrichment.rst so they appear in the docs site
  • Improves both docstrings to describe what the actions do (kernel ring buffer output attached as dmesg.log)
  • Fixes pod_dmesg_enricher's error message (was referencing pod_node_graph_enricher)
  • Adds pod_dmesg_enricher to lightActions in the Helm chart, matching node_dmesg_enricher

@coderabbitai

coderabbitai Bot commented Aug 14, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1b6c3c86-e8bc-4e0f-a040-0f77494264a9

📥 Commits

Reviewing files that changed from the base of the PR and between 4847afb and 2057960.

📒 Files selected for processing (4)
  • docs/playbook-reference/actions/event-enrichment.rst
  • helm/robusta/values.yaml
  • playbooks/robusta_playbooks/node_enrichments.py
  • playbooks/robusta_playbooks/pod_enrichments.py

Walkthrough

The change documents node and pod dmesg enrichment behavior, corrects the pod enricher’s missing-pod error text, adds both actions to the event enrichment reference, and enables pod_dmesg_enricher as a light action.

Changes

Dmesg enrichment

Layer / File(s) Summary
Document dmesg action behavior
playbooks/robusta_playbooks/node_enrichments.py, playbooks/robusta_playbooks/pod_enrichments.py
The enrichers document node-based kernel message retrieval and dmesg.log output. The pod enricher uses the correct missing-pod error identifier.
Register and expose dmesg actions
docs/playbook-reference/actions/event-enrichment.rst, helm/robusta/values.yaml
The reference lists both dmesg enrichers. Helm enables pod_dmesg_enricher as a light action.

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

Merge Risk: ⚪ Minimal · up to 20579

The PR documents existing dmesg enrichment actions, corrects a misleading pod error message, and aligns the Helm action list. No actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: avi-robusta

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the documentation additions and the pod enricher log-message fix.
Description check ✅ Passed The description accurately explains the documentation, docstring, error-message, and Helm configuration changes.
Linked Issues check ✅ Passed The changes support issue #549 by surfacing the existing dmesg enrichers, documenting their node output, and enabling the pod action as a light action.
Out of Scope Changes check ✅ Passed All changes relate directly to documenting, configuring, and correcting the dmesg enrichment actions.
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

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.

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.

Dmesg enricher (action)

1 participant