[JENKINS-48344] Lightweight timestamp annotations #25
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| <extensions xmlns="http://maven.apache.org/EXTENSIONS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.0.0 http://maven.apache.org/xsd/core-extensions-1.0.0.xsd"> | ||
| <extension> | ||
| <groupId>io.jenkins.tools.incrementals</groupId> | ||
| <artifactId>git-changelist-maven-extension</artifactId> | ||
| <version>1.0-beta-7</version> | ||
| </extension> | ||
| </extensions> |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| -Pconsume-incrementals | ||
| -Pmight-produce-incrementals |
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright 2018 CloudBees, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
|
|
||
| package hudson.plugins.timestamper.pipeline; | ||
|
|
||
| import hudson.Extension; | ||
| import hudson.MarkupText; | ||
| import hudson.console.ConsoleAnnotator; | ||
| import hudson.console.ConsoleAnnotatorFactory; | ||
| import hudson.model.Run; | ||
| import hudson.plugins.timestamper.Timestamp; | ||
| import hudson.plugins.timestamper.format.TimestampFormat; | ||
| import hudson.plugins.timestamper.format.TimestampFormatProvider; | ||
| import java.text.ParsePosition; | ||
| import org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner; | ||
|
|
||
| /** | ||
| * Interprets marks added by {@link GlobalDecorator}. | ||
| */ | ||
| public final class GlobalAnnotator extends ConsoleAnnotator</* TODO pending https://github.com/jenkinsci/jenkins/pull/3662 */Object> { | ||
|
|
||
| private static final long serialVersionUID = 1; | ||
|
|
||
| @Override | ||
| public ConsoleAnnotator<Object> annotate(Object context, MarkupText text) { | ||
| if (!(context instanceof Run)) { | ||
| return null; | ||
| } | ||
| Run<?, ?> build = (Run<?, ?>) context; | ||
| long buildStartTime = build.getStartTimeInMillis(); | ||
| String html = text.toString(true); | ||
| int start; | ||
| if (html.startsWith("<span class=\"pipeline-new-node\" ")) { // cf. LogStorage.startStep | ||
|
There was a problem hiding this comment. Unpleasant that this is necessary. Not sure if it is solvable upstream. You would probably expect that the |
||
| start = html.indexOf('>') + 1; | ||
| } else { | ||
| start = 0; | ||
| } | ||
| if (html.startsWith("[", start)) { | ||
| int end = html.indexOf(']', start); | ||
| if (end != -1) { | ||
| long millisSinceEpoch = GlobalDecorator.UTC_MILLIS.get().parse(html, new ParsePosition(start + 1)).getTime(); | ||
| Timestamp timestamp = new Timestamp(millisSinceEpoch - buildStartTime, millisSinceEpoch); | ||
| TimestampFormat format = TimestampFormatProvider.get(); | ||
| format.markup(text, timestamp); | ||
| text.addMarkup(0, 26, "<span style=\"display: none\">", "</span>"); | ||
| } | ||
| } | ||
| return this; | ||
| } | ||
|
|
||
| @Extension | ||
| public static final class Factory extends ConsoleAnnotatorFactory<Object> { | ||
|
|
||
| @Override | ||
| public ConsoleAnnotator<Object> newInstance(Object context) { | ||
| if (context instanceof Run && context instanceof FlowExecutionOwner.Executable) { | ||
| return new GlobalAnnotator(); | ||
| } | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| } | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright 2018 CloudBees, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
|
|
||
| package hudson.plugins.timestamper.pipeline; | ||
|
|
||
| import hudson.Extension; | ||
| import hudson.console.LineTransformationOutputStream; | ||
| import hudson.model.Queue; | ||
| import hudson.model.Run; | ||
| import java.io.IOException; | ||
| import java.io.OutputStream; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.text.DateFormat; | ||
| import java.text.SimpleDateFormat; | ||
| import java.util.Date; | ||
| import java.util.TimeZone; | ||
| import java.util.function.Supplier; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner; | ||
| import org.jenkinsci.plugins.workflow.log.TaskListenerDecorator; | ||
|
|
||
| /** | ||
| * Applies plain-text timestamp prefixes to all Pipeline log lines. | ||
| */ | ||
| public final class GlobalDecorator extends TaskListenerDecorator { | ||
|
|
||
| private static final Logger LOGGER = Logger.getLogger(GlobalDecorator.class.getName()); | ||
|
|
||
| // TODO java.time is thread-safe but I got lost figuring out how to use it… https://stackoverflow.com/a/29626123/12916 + https://stackoverflow.com/a/26539985/12916 | ||
jglick marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| static Supplier<DateFormat> UTC_MILLIS = () -> { | ||
| DateFormat f = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"); // TODO java.time | ||
| f.setTimeZone(TimeZone.getTimeZone("UTC")); | ||
| return f; | ||
| }; | ||
|
|
||
| private static final long serialVersionUID = 1; | ||
|
|
||
| private GlobalDecorator() {} | ||
|
|
||
| @Override | ||
| public OutputStream decorate(final OutputStream logger) throws IOException, InterruptedException { | ||
| final DateFormat f = UTC_MILLIS.get(); | ||
| return new LineTransformationOutputStream() { | ||
| @Override | ||
| protected void eol(byte[] b, int len) throws IOException { | ||
| logger.write('['); | ||
| logger.write(f.format(new Date()).getBytes(StandardCharsets.US_ASCII)); | ||
jglick marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| logger.write(']'); | ||
| logger.write(' '); | ||
| logger.write(b, 0, len); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| @Extension | ||
| public static final class Factory implements TaskListenerDecorator.Factory { | ||
|
|
||
| @Override | ||
| public TaskListenerDecorator of(FlowExecutionOwner owner) { | ||
| // TODO check a GlobalConfiguration to see if this should be enabled or not | ||
| // (and if so, make TimestamperStep just print a warning and add no notes) | ||
| try { | ||
| Queue.Executable executable = owner.getExecutable(); | ||
| if (executable instanceof Run) { // we need at least getStartTimeInMillis | ||
| return new GlobalDecorator(); | ||
| } | ||
| } catch (IOException x) { | ||
| LOGGER.log(Level.WARNING, null, x); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quite a jump, although required for the JEP-210 updates. Here are stats for the plugin's usage by Jenkins core version: http://stats.jenkins.io/pluginversions/timestamper.html. According to those stats, 89.63% of users of timestamper-1.8.10 are on Jenkins 2.121.1 or newer, so this looks reasonable to me.