StackStorm / StackStorm/st2

Buffer stdout and stderr on timeout in local and remote runner

Open
#2,007 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

complexity:medium enhancement
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

Right now if a timeout happens, we don't buffer stdout and stderr which was produced until the time out and include it in the result.

Not doing that makes debugging a lot of timeout related issues hard or impossible. We should update remote and local runner to include stdout and stderr which was produced until the timeout was reached in the result.

Doing it for the new remote runner should be relatively straight-forward, but doing it for a local runner will require some major changes (right now local runner doesn't communicate with the parent processes - it returns stdout and result when it successfully exits).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the local and new remote runner implementations and tracing timeout handling and result construction. Compare how each runner captures process output; done means stdout and stderr produced before a timeout are included in the returned result for both runners.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.