docs(postserveaction): document remote mode for long-lived post-serve…#1219
Open
scovl wants to merge 1 commit intoSpectoLabs:masterfrom
Open
docs(postserveaction): document remote mode for long-lived post-serve…#1219scovl wants to merge 1 commit intoSpectoLabs:masterfrom
scovl wants to merge 1 commit intoSpectoLabs:masterfrom
Conversation
… actions Add sections explaining the difference between local (subprocess per request) and remote (long-lived HTTP server) execution modes, including: - When to use each mode and why local does not scale under high load - Step-by-step guide: writing the server, payload format, configuring Hoverfly via flag and hoverctl, verifying registration via admin API - Minimal Python server example with inline comments - Docker Compose example with service hostname Closes SpectoLabs#1188
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add documentation for the remote execution mode of post-serve actions, explaining when and why to use it instead of the local (subprocess-per-request) mode.
The existing docs mentioned that a remote host could be configured, but provided no explanation of the trade-offs, no step-by-step setup guide, and no examples. This left users like @arseniycloud discovering the limitation only after hitting OOMKilled in production under load.
Validation
The documented behaviour was validated end-to-end using Docker Compose before merging:
-post-serve-action "remote-test http://action-server:8765 0"and a simulation JSON where the response referencespostServeAction: "remote-test"action-server)GET /api/v2/hoverfly/post-serve-action) that the remote action was registered correctly200 OK) and the action server logged the received payloadRemote post serve action invoked successfullyNo subprocess was spawned the action server process stayed alive and handled the call via a single HTTP POST, as documented.
Closes #1188