Update bash_enrichments.py - add sshexecutor

[abdulgig]

This function allows to execute commands via SSH, usually when you have VMs or servers outside Kubernetes !

How to use ?

  - triggers:
      - on_prometheus_alert:
          alert_name: Solana-Service-Down
    actions:
      - generic_bash_enricher:
          bash_command:
            - ssh
            - -i
            - /mnt/ssh/id_rsa
            - -o
            - StrictHostKeyChecking=no
            - root@your-remote-ip
            - ls /tmp```

[coderabbitai[bot]]

Walkthrough

A new function, generic_bash_enricher, was introduced to execute arbitrary bash commands on the runner environment. The function processes a parameter dictionary, executes the specified command, captures the output, and enriches the triggering event with the results or any errors encountered.

Changes

Cohort / File(s)	Change Summary
Bash Command Enrichment playbooks/robusta_playbooks/bash_enrichments.py	Added generic_bash_enricher function to run arbitrary bash commands, handle input validation, capture output, and enrich events. Also imported subprocess to support command execution.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant generic_bash_enricher
    participant subprocess
    participant Event

    User->>generic_bash_enricher: Trigger with event and params
    generic_bash_enricher->>generic_bash_enricher: Validate params for bash_command
    alt bash_command missing
        generic_bash_enricher->>Event: Add warning enrichment
        generic_bash_enricher-->>User: Return early
    else bash_command present
        generic_bash_enricher->>subprocess: Run bash_command
        subprocess-->>generic_bash_enricher: Return stdout, stderr, returncode
        generic_bash_enricher->>Event: Add enrichment with command results
        generic_bash_enricher-->>User: Return
    end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

[!NOTE]

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 00f4862df55620f6b1cc077a6ec0d71a5bf65944 and 0cbfb0a0bb7c65d91a770b8ffe15d03475e51931.

📒 Files selected for processing (1)

• playbooks/robusta_playbooks/bash_enrichments.py (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• playbooks/robusta_playbooks/bash_enrichments.py

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

🧪 Generate unit tests

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[CLAassistant]

All committers have signed the CLA.