Skip to content

Add --write-log-init-timeout option to allow specifying a timeout to retry writing logs to stdout #698

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

Merged
oleg-nenashev merged 6 commits into from
Aug 6, 2023
Merged

Add --write-log-init-timeout option to allow specifying a timeout to retry writing logs to stdout #698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
37c35a9
Add --write-log-retry-count option
romanisb Jun 19, 2023
8d4afe2
Replace retry counter by duration
syurevich Jun 21, 2023
707e44e
Set default to 1sec and improve description.
syurevich Jun 26, 2023
512f3f0
Fix description
syurevich Jun 26, 2023
1354cec
Change option name and update description
syurevich Jun 28, 2023
c5eec75
Use renamed option in Runner.java
syurevich Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions ...ap/src/main/java/io/jenkins/jenkinsfile/runner/bootstrap/commands/PipelineRunOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,10 @@ public class PipelineRunOptions extends PipelineOptions {
description = "Disable writing build logs to stdout. " +
"Plugins that handle build logs will process them as usual")
public boolean noBuildLogs = false;

@CommandLine.Option(names = { "-wlit", "--write-log-init-timeout" },
description = "Initializing build log forwarding to stdout may fail if the build log has not been created yet. " +
" This option defines the maximum time (in seconds) to wait for build log creation." +
" Defaults to 1 second.")
public int writeLogInitTimeoutSeconds = 1;
}
15 changes: 7 additions & 8 deletions payload/src/main/java/io/jenkins/jenkinsfile/runner/Runner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public int run(PipelineRunOptions runOptions) throws Exception {
b = f.getStartCondition().get();

if (!runOptions.noBuildLogs) {
writeLogTo(System.out);
writeLogTo(System.out, runOptions.writeLogInitTimeoutSeconds);
}

f.get(); // wait for the completion
Expand Down Expand Up @@ -156,24 +156,23 @@ private CauseAction createCauseAction(String cause) {
return new CauseAction(c);
}

private void writeLogTo(PrintStream out) throws IOException, InterruptedException {
final int retryCnt = 10;

// read output in a retry loop, by default try only once
private void writeLogTo(PrintStream out, int timeoutSeconds) throws IOException, InterruptedException {
// read output in a retry loop,
// writeWholeLogTo may fail with FileNotFound
// exception on a slow/busy machine, if it takes
// longish to create the log file
int retryInterval = 100;
for (int i=0;i<=retryCnt;) {
long timeoutMillis = timeoutSeconds * 1000;
long startTime = System.currentTimeMillis();
while (true) {
try {
b.writeWholeLogTo(out);
break;
}
catch (FileNotFoundException | NoSuchFileException e) {
if ( i == retryCnt ) {
if ( System.currentTimeMillis() - startTime > timeoutMillis ) {
throw e;
}
i++;
Thread.sleep(retryInterval);
}
}
Expand Down