esnet/iperf

Allow both JSON and human-readable output at the same time

Open

#456 opened on Sep 13, 2016

View on GitHub
 (3 comments) (2 reactions) (0 assignees)C (4,946 stars) (1,083 forks)batch import
Help Wantedenhancementfeat:outputs

Description

From @bltierney : It'd be nice to be able to see the human-readable output of a test while it's running, but also have the JSON output saved to a file.

Contributor guide

Tech stack
c
Domain
cliperformance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C programmingiperf codebase structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
To implement this feature, one would need to modify the output handling in iperf. The relevant files are likely src/iperf output.c and src/iperf api.c. A new command line flag (e.g., json to file) could be added to write JSON output to a file while still printing human readable output to stdout. The implementation should parse the existing JSON output function and write to a file descriptor instead of stdout when the flag is set.