[JEP-210] Log handling rewrite #27
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,134 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright (c) 2015, 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 org.jenkinsci.plugins.workflow.job.console; | ||
|
|
||
| import hudson.Extension; | ||
| import hudson.MarkupText; | ||
| import hudson.Util; | ||
| import hudson.console.ConsoleAnnotationDescriptor; | ||
| import hudson.console.ConsoleAnnotator; | ||
| import hudson.console.ConsoleNote; | ||
| import hudson.model.TaskListener; | ||
| import java.io.IOException; | ||
| import java.io.PrintStream; | ||
| import java.util.Iterator; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import javax.annotation.CheckForNull; | ||
| import javax.annotation.Nonnull; | ||
| import org.jenkinsci.plugins.workflow.actions.LabelAction; | ||
| import org.jenkinsci.plugins.workflow.flow.FlowExecution; | ||
| import org.jenkinsci.plugins.workflow.graph.BlockEndNode; | ||
| import org.jenkinsci.plugins.workflow.graph.BlockStartNode; | ||
| import org.jenkinsci.plugins.workflow.graph.FlowNode; | ||
| import org.jenkinsci.plugins.workflow.job.WorkflowRun; | ||
| import org.jenkinsci.plugins.workflow.log.LogStorage; | ||
| import org.kohsuke.accmod.Restricted; | ||
| import org.kohsuke.accmod.restrictions.NoExternalUse; | ||
|
|
||
| /** | ||
| * Console line with note printed when a new {@link FlowNode} is added to the graph. | ||
| * Defines the {@code pipeline-new-node} CSS class and several attributes which may be used to control subsequent behavior: | ||
| * <ul> | ||
| * <li>{@code nodeId} for {@link FlowNode#getId} | ||
| * <li>{@code startId} {@link FlowNode#getId} for {@link BlockStartNode}, else {@link BlockEndNode#getStartNode}, else absent | ||
| * <li>{@code enclosingId} the immediately enclosing {@link BlockStartNode}, if any | ||
| * <li>{@code label} for {@link LabelAction} if present | ||
| * </ul> | ||
| * @see LogStorage#startStep | ||
| */ | ||
| @Restricted(NoExternalUse.class) | ||
| public class NewNodeConsoleNote extends ConsoleNote<WorkflowRun> { | ||
|
|
||
| private static final Logger LOGGER = Logger.getLogger(NewNodeConsoleNote.class.getName()); | ||
|
|
||
| /** | ||
| * Prefix used in metadata lines. | ||
| */ | ||
| private static final String CONSOLE_NOTE_PREFIX = "[Pipeline] "; | ||
|
|
||
| public static void print(FlowNode node, TaskListener listener) { | ||
| PrintStream logger = listener.getLogger(); | ||
| synchronized (logger) { | ||
| try { | ||
| listener.annotate(new NewNodeConsoleNote(node)); | ||
| } catch (IOException x) { | ||
| LOGGER.log(Level.WARNING, null, x); | ||
| } | ||
| logger.println(CONSOLE_NOTE_PREFIX + node.getDisplayFunctionName()); // note that StepAtomNode will never have a LabelAction at this point | ||
| } | ||
| } | ||
|
|
||
| private final @Nonnull String id; | ||
| private final @CheckForNull String enclosing; | ||
| private final @CheckForNull String start; | ||
|
|
||
| private NewNodeConsoleNote(FlowNode node) { | ||
| id = node.getId(); | ||
| if (node instanceof BlockEndNode) { | ||
| enclosing = null; | ||
| start = ((BlockEndNode) node).getStartNode().getId(); | ||
| } else { | ||
| Iterator<BlockStartNode> it = node.iterateEnclosingBlocks().iterator(); | ||
| enclosing = it.hasNext() ? it.next().getId() : null; | ||
| start = node instanceof BlockStartNode ? node.getId() : null; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public ConsoleAnnotator<?> annotate(WorkflowRun context, MarkupText text, int charPos) { | ||
| StringBuilder startTag = new StringBuilder("<span class=\"pipeline-new-node\" nodeId=\"").append(id); | ||
dwnusbaum marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (start != null) { | ||
| startTag.append("\" startId=\"").append(start); | ||
| } | ||
| if (enclosing != null) { | ||
| startTag.append("\" enclosingId=\"").append(enclosing); | ||
| } | ||
| FlowExecution execution = context.getExecution(); | ||
| if (execution != null) { | ||
| try { | ||
| FlowNode node = execution.getNode(id); | ||
| if (node != null) { | ||
| LabelAction a = node.getAction(LabelAction.class); | ||
| if (a != null) { | ||
| String displayName = a.getDisplayName(); | ||
| assert displayName != null; | ||
| startTag.append("\" label=\"").append(Util.escape(displayName)); // TODO is there some better way to escape for attribute values? | ||
|
There was a problem hiding this comment. Noting here for future review/integration that this appears to be how we propose to deal with rendering of branch labels -- however it requires rich rendering of annotation content by the UI to be useful (i.e. not visible in plaintext logs). Is that the right decision? Not sure, the mechanism seems more straightforward in some ways. Edit: note that the other approach (prefixes) also required some rendering but didn't rely on the browser JS as much. I think this one seems somewhat more sane though. There was a problem hiding this comment. Right, this keeps the HTML leaner and does more of the fanciness on the client side. |
||
| } | ||
| } | ||
| } catch (IOException x) { | ||
| Logger.getLogger(NewNodeConsoleNote.class.getName()).log(Level.WARNING, null, x); | ||
| } | ||
| } | ||
| startTag.append("\">"); | ||
| text.addMarkup(0, text.length(), startTag.toString(), "</span>"); | ||
| return null; | ||
| } | ||
|
|
||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| @Extension public static final class DescriptorImpl extends ConsoleAnnotationDescriptor {} | ||
|
|
||
| } | ||
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -31,7 +31,17 @@ | |
| <l:task icon="images/24x24/up.png" href="${rootURL}/${it.parent.url}" title="${%Back to Project}" contextMenu="false"/> | ||
| <l:task icon="images/24x24/search.png" href="${buildUrl.baseUrl}/" title="${%Status}" contextMenu="false"/> | ||
| <l:task icon="images/24x24/notepad.png" href="${buildUrl.baseUrl}/changes" title="${%Changes}"/> | ||
| <j:choose> <!-- TODO <p:console-link/> may not currently be used as it calls getLogFile --> | ||
| <j:when test="${it.logText.length() > 200000}"> | ||
|
There was a problem hiding this comment. Perhaps default int approximateLogLines(@Nonnull FlowExecutionOwner.Executable build) {
return overallLog(build, false).length() / 80;
}which could be overridden by external implementations to make an API call. Of course there is the broader goal of JENKINS-17406 to use paginated display. There was a problem hiding this comment. Specifically:
There was a problem hiding this comment. Ick, well okay, I'll let you deal with what that does to the fluentd-cloudwatch logging. There was a problem hiding this comment. Needs to be revisited when resuming work on external log sinks. I am no longer working on that. |
||
| <l:task href="${buildUrl.baseUrl}/console" icon="icon-terminal icon-md" title="${%Console Output}"/> | ||
| <l:task href="${buildUrl.baseUrl}/consoleText" icon="icon-document icon-md" title="${%View as plain text}"/> | ||
| </j:when> | ||
| <j:otherwise> | ||
| <l:task icon="images/24x24/terminal.png" href="${buildUrl.baseUrl}/console" title="${%Console Output}"> | ||
| <l:task href="${buildUrl.baseUrl}/consoleText" icon="icon-document icon-md" title="${%View as plain text}"/> | ||
| </l:task> | ||
| </j:otherwise> | ||
| </j:choose> | ||
| <l:task icon="images/24x24/notepad.png" href="${buildUrl.baseUrl}/configure" title="${h.hasPermission(it,it.UPDATE)?'%Edit Build Information':'%View Build Information'}"/> | ||
| <st:include page="delete.jelly"/> | ||
| <j:if test="${it.hasAllowTerm()}"> | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.