NatLabRockies / NatLabRockies/OpenStudio

Finer controls for Logging to determine what goes to stdout, to OSW or to both. Avoid capturing stdout twice

Open
#5,086 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component - logs and warnings Enhancement Request
Dominant language
C++
Stars
646
Forks
237
Avg merge
3d 11h
Merged PRs (30d)
10

Description

Enhancement Request

  • Determine what goes to stdout, to out OSW, or to both
  • Avoid having the same information going in the OSW as a log + as stdout / stderr key

Detailed Description

We capture stdout/stderr in the OSRunner and setStdOut/setStdErr on the WorkflowStepResult, which in turns is written to the final out OSW. We often end up seeing the same warnings/errors in the stdout key and in the step_warnings, step_errors, etc.

Possible Implementation

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 tracing the OSRunner stdout/stderr capture into WorkflowStepResult.setStdOut/setStdErr and the final OSW output. Determine how logging currently reaches stdout, stderr, OSW logs, and step_warnings or step_errors. Done means the routing can be controlled and identical messages are not captured twice.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.