Skip to content

feat(client): Support body placeholder for SSH endpoints #1286

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat(client): Support body placeholder for SSH endpoints #1286

wants to merge 4 commits into from
+111 −8

Conversation

yansh97
Copy link

@yansh97 yansh97 commented Sep 23, 2025

Summary

#1285

  • Add BODY placeholder support for SSH endpoints to capture stdout output from remote commands
  • Enable use of existing Gatus condition features (JSONPath, pattern matching, functions) with SSH command outputs
  • Maintain backward compatibility with existing SSH endpoint configurations

Checklist

  • Tested and/or added tests to validate that the changes work as intended, if applicable.
  • Updated documentation in README.md, if applicable.

@yansh97
feat(ssh): Add BODY placeholder support for SSH endpoints
25d1e10 
- Modify ExecuteSSHCommand to capture stdout output
- Update SSH endpoint handling to use needsToReadBody() mechanism
- Add comprehensive test cases for SSH BODY functionality
- Support basic body content, pattern matching, JSONPath, and functions
- Maintain backward compatibility with existing SSH endpoints
@yansh97
docs: Add SSH BODY placeholder examples to README
ae93e38 
- Add [BODY] placeholder to supported SSH placeholders list
- Add comprehensive examples showing various SSH BODY conditions
- Include pattern matching, length checks, JSONPath expressions
- Demonstrate function wrappers (len, has, any) usage
@yansh97 yansh97 mentioned this pull request Sep 23, 2025
Open
@TwiN TwiN changed the title Feature/ssh body placeholder support feat(client): Support body placeholder for SSH endpoints Sep 23, 2025
TwiN
TwiN requested changes Sep 23, 2025
View reviewed changes
README.md Outdated
- "[STATUS] == 0"
```

You can also use the `[BODY]` placeholder to validate the command output:
Copy link
Owner

Choose a reason for hiding this comment

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

Please remove the two configuration examples you added, it's a bit excessive

Copy link
Author

Choose a reason for hiding this comment

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

Two examples have been removed

@yansh97
Copy link
Author

yansh97 commented Sep 24, 2025

@TwiN I've removed two configuration examples. Is there anything else that needs to be modified?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TwiN TwiN TwiN requested changes

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
@yansh97 @TwiN