Add Logz.io support #74
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright 2017 Red Hat inc, and individual contributors | ||
| * | ||
| * 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 jenkins.plugins.logstash; | ||
|
|
||
| import net.sf.json.JSONObject; | ||
|
|
||
| /** | ||
| * Interface describing processors of persisted payload. | ||
| */ | ||
| public interface LogstashPayloadProcessor { | ||
| /** | ||
| * Modifies a JSON payload compatible with the Logstash schema. | ||
| * | ||
| * @param payload the JSON payload that has been constructed so far. | ||
| * @return The formatted JSON object, can be null to ignore this payload. | ||
| */ | ||
| JSONObject process(JSONObject payload) throws Exception; | ||
|
There was a problem hiding this comment. I think we actually only need the finish() method, not process().
Author
There was a problem hiding this comment. @jakub-bochenski There was a problem hiding this comment. AFAIR finish only uses process to call it with null arg. Anyhow check the comment above (#74 (comment)) it might make this point moot |
||
|
|
||
| /** | ||
| * Finalizes any operations, for example returns cashed lines at end of build. | ||
| * | ||
| * @return A formatted JSON object, can be null when it has nothing. | ||
| */ | ||
| JSONObject finish() throws Exception; | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright 2017 Red Hat inc. and individual contributors | ||
| * | ||
| * 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 jenkins.plugins.logstash; | ||
|
|
||
| import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; | ||
| import groovy.lang.Binding; | ||
| import jenkins.model.Jenkins; | ||
| import net.sf.json.JSONObject; | ||
| import org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript; | ||
| import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import java.io.IOException; | ||
| import java.io.OutputStream; | ||
|
|
||
| /** | ||
| * This class is handling custom groovy script processing of JSON payload. | ||
| * Each call to process executes the script provided in job configuration. | ||
| * Script is executed under the same binding each time so that it has ability | ||
| * to persist data during build execution if desired by script author. | ||
| * When build is finished, script will receive null as the payload and can | ||
| * return any cached but non-sent data back for persisting. | ||
| * The return value of script is the payload to be persisted unless null. | ||
| */ | ||
| public class LogstashScriptProcessor implements LogstashPayloadProcessor{ | ||
|
There was a problem hiding this comment. I don't think you need this implmentation, just the interface There was a problem hiding this comment. Even the interface is not needed. Actually the complete #71 should be taken out of here. There was a problem hiding this comment. We need a close hook for the build. It's not available on master, so I suggested to use the same approach as #71 There was a problem hiding this comment. What helps an interface when there is no implementation?
Author
There was a problem hiding this comment. How do you suggest we should continue with this? There was a problem hiding this comment. Let me try to explain again. Maybe at this point the best way to proceed is to forget about #71 and just add a way to notify the There was a problem hiding this comment. #71 added a feature to close the LogstashWriter, which is specific to a build but it is not interacting with the Dao as the scriptprocessor is only used in the writer. There was a problem hiding this comment. Sorry, I think I meant the LogstashWriter instead of IndexerDao On a different note: I'm rather busy lately and don't want to block it. I would be happy to accept whatever solution you and @idohalevi can agree on
Author
There was a problem hiding this comment. @jakub-bochenski @mwinter69 |
||
| @Nonnull | ||
| private final SecureGroovyScript script; | ||
|
|
||
| @Nonnull | ||
| private final OutputStream consoleOut; | ||
|
|
||
| /** Groovy binding for script execution */ | ||
| @Nonnull | ||
| private final Binding binding; | ||
|
|
||
| /** Classloader for script execution */ | ||
| @Nonnull | ||
| private final ClassLoader classLoader; | ||
|
|
||
| public LogstashScriptProcessor(SecureGroovyScript script, OutputStream consoleOut) { | ||
| this.script = script; | ||
| this.consoleOut = consoleOut; | ||
|
|
||
| // TODO: should we put variables in the binding like manager, job, etc.? | ||
| binding = new Binding(); | ||
| binding.setVariable("console", new BuildConsoleWrapper()); | ||
|
|
||
| // not sure what the diff is compared to getClass().getClassLoader(); | ||
| final Jenkins jenkins = Jenkins.getInstance(); | ||
| classLoader = jenkins.getPluginManager().uberClassLoader; | ||
| } | ||
|
|
||
| /** | ||
| * Helper method to allow logging to build console. | ||
| */ | ||
| @SuppressFBWarnings( | ||
| value="DM_DEFAULT_ENCODING", | ||
| justification="TODO: not sure how to fix this") | ||
| private void buildLogPrintln(Object o) throws IOException { | ||
| consoleOut.write(o.toString().getBytes()); | ||
| consoleOut.write("\n".getBytes()); | ||
| consoleOut.flush(); | ||
| } | ||
|
|
||
| @Override | ||
| public JSONObject process(JSONObject payload) throws Exception { | ||
| binding.setVariable("payload", payload); | ||
| script.evaluate(classLoader, binding); | ||
| return (JSONObject) binding.getVariable("payload"); | ||
| } | ||
|
|
||
| @Override | ||
| public JSONObject finish() throws Exception { | ||
| buildLogPrintln("Tearing down Script Log Processor.."); | ||
| return process(null); | ||
| } | ||
|
|
||
| /** | ||
| * Helper to allow access from sandboxed script to output messages to console. | ||
| */ | ||
| private class BuildConsoleWrapper { | ||
| @Whitelisted | ||
| public void println(Object o) throws IOException { | ||
| buildLogPrintln(o); | ||
| } | ||
| } | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.