Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Update bash_enrichments.py - add sshexecutor#1887

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.

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

Already on GitHub?Sign in to your account

Open
abdulgig wants to merge4 commits intorobusta-dev:master
base:master
Choose a base branch
Loading
fromabdulgig:patch-1

Conversation

@abdulgig
Copy link

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```

This function allows to execute commands via SSH, usually when you have VMs or servers outside Kubernetes
@coderabbitai
Copy link

coderabbitaibot commentedAug 1, 2025•
edited
Loading

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		Addedgeneric_bash_enricher function to run arbitrary bash commands, handle input validation, capture output, and enrich events. Also importedsubprocess 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
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn morehere, 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 between00f4862 and0cbfb0a.

📒 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
🪧 Tips

Chat

There are 3 ways to chat withCodeRabbit:

  • 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 oursupport 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 togenerate 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 theconfiguration 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 ourDocumentation for detailed information on how to use CodeRabbit.
  • Join ourDiscord Community to get help, request features, and share feedback.
  • Follow us onX/Twitter for updates and announcements.

@CLAassistant
Copy link

CLAassistant commentedAug 1, 2025•
edited
Loading

CLA assistant check
All committers have signed the CLA.

Copy link

@coderabbitaicoderabbitaibot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
playbooks/robusta_playbooks/bash_enrichments.py (2)

46-46:Add type annotation for theparams parameter.

Consider adding a type annotation for better code documentation and IDE support.

-def generic_bash_enricher(event: ExecutionBaseEvent, params):+def generic_bash_enricher(event: ExecutionBaseEvent, params: dict):

45-78:Security consideration: Arbitrary command execution capability.

This function enables execution of arbitrary bash commands on the runner environment, including SSH to remote hosts as intended. While this provides powerful functionality for the use case described in the PR objectives, ensure that:

  1. Access to this enricher is properly restricted in production environments
  2. Users understand the security implications of running arbitrary commands
  3. Consider logging executed commands for audit purposes

The implementation correctly handles both string and list command formats, includes comprehensive error handling, and provides clear output formatting.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between3e8d9da and00f4862.

📒 Files selected for processing (1)
  • playbooks/robusta_playbooks/bash_enrichments.py (2 hunks)
🧰 Additional context used
🪛 Ruff (0.12.2)
playbooks/robusta_playbooks/bash_enrichments.py

46-46: Undefined nameExecutionBaseEvent

(F821)

🪛 Flake8 (7.2.0)
playbooks/robusta_playbooks/bash_enrichments.py

[error] 46-46: undefined name 'ExecutionBaseEvent'

(F821)

🔇 Additional comments (3)
playbooks/robusta_playbooks/bash_enrichments.py (3)

1-1:LGTM!

The addition ofsubprocess import is necessary for the newgeneric_bash_enricher function and follows proper Python import conventions.

57-68:LGTM! Robust error handling and command execution.

The error handling correctly:

  • Differentiates between string commands (usingshell=True) and list commands
  • Captures both stdout and stderr with proper text handling
  • Handles exceptions gracefully by setting appropriate error status
  • Usescapture_output=True andtext=True for clean output processing

70-78:LGTM! Comprehensive output formatting.

The markdown formatting provides clear, structured output that includes all relevant information:

  • Command executed
  • Return code for success/failure indication
  • Separated stdout and stderr in code blocks for readability

@arikalon1arikalon1 self-requested a reviewAugust 12, 2025 07:23
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments

@arikalon1arikalon1Awaiting requested review from arikalon1

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@abdulgig@CLAassistant
[8]ページ先頭
©2009-2025 Movatter.jp