Package com.splunk.splunkjenkins.utils

Class LogEventHelper

java.lang.Object
com.splunk.splunkjenkins.utils.LogEventHelper
public class LogEventHelper extends Object

  • Field Details

  • Constructor Details

    • LogEventHelper

      public LogEventHelper()

  • Method Details

    • buildPost

      public static shaded.splk.org.apache.http.client.methods.HttpPost buildPost(EventRecord record, SplunkJenkinsInstallation config)

    • verifyHttpInput

      public static FormValidation verifyHttpInput(SplunkJenkinsInstallation config)

    • nonEmpty

      public static boolean nonEmpty(String value)

    • getUserName

      public static String getUserName()
      This method may trigger load user operations.
      Returns:
      User display name

    • getMasterStats

      public static Map<String,Object> getMasterStats()
      Returns:
      Jenkins master statistics with timestamp

    • sendFiles

      public static int sendFiles(Run build, FilePath ws, Map<String,String> envVars, TaskListener listener, String includes, String excludes, boolean sendFromSlave, long maxFileSize)

    • parseFileSize

      public static long parseFileSize(String size)

    • getTriggerUserName

      public static String getTriggerUserName(Run run)
      Parameters:
      run - Jenkins Run
      Returns:
      the user who triggered the build or upstream build

    • getComputerStatus

      public static Map<String,Object> getComputerStatus(Computer computer)

    • getRunningJob

      public static List<Map> getRunningJob()

    • getSlaveStats

      public static Map<String,Map<String,Object>> getSlaveStats()
      Returns:
      a map with slave name as key and monitor result as value monitor result is a map with monitor name as key, monitor data as value

    • getEnvironment

      public static EnvVars getEnvironment(Run run)
      Parameters:
      run - the build
      Returns:
      build env with masked password variables

    • getBuildVariables

      public static Map<String,Object> getBuildVariables(Run run, boolean completed)
      Parameters:
      run - the build
      completed - the task is completed to compute scm info
      Returns:
      build variables with password masked

    • getBuildVariables

      public static Map<String,Object> getBuildVariables(Run run)
      Parameters:
      run - the build
      Returns:
      build variables with password masked

    • logUserAction

      public static void logUserAction(String user, String message)

    • updateSlaveInfoAsync

      public static void updateSlaveInfoAsync(String nodeName)

    • getRelativeJenkinsHomePath

      public static String getRelativeJenkinsHomePath(String configPath)
      Parameters:
      configPath - the absolute path
      Returns:
      the relative path to JENKINS_HOME directory

    • getDefaultDslScript

      public static String getDefaultDslScript()

    • validateGroovyScript

      public static FormValidation validateGroovyScript(String script)
      Parameters:
      script - user input script to validate
      Returns:
      error message if there is any

    • hasPublisherName

      public static boolean hasPublisherName(String shortClassName, Run build)
      check if the project has publisher
      Parameters:
      shortClassName - common used publishers are
      build - jenkins build
      Returns:
      true if the publisher is defined, false otherwise

    • getRunDuration

      public static float getRunDuration(Run run)
      Parameters:
      run - an execution of job
      Returns:
      job duration

    • appendScm

      public static void appendScm(Map eventToAppend, Run run)

    • getScmInfo

      public static Map<String,Object> getScmInfo(Run build)

    • getScmInfo

      public static Map<String,Object> getScmInfo(String scmName, EnvVars envVars)
      Parameters:
      scmName - scm class name
      envVars - environment variables
      Returns:
      scm information, we only support git,svn and p4

    • getScmURL

      public static String getScmURL(EnvVars envVars, String prefix)
      Parameters:
      envVars - environment variables
      prefix - scm prefix, such as GIT_URL, SVN_URL
      Returns:
      parsed scm urls from build env, e.g. GIT_URL_1, GIT_URL_2, ... GIT_URL_10 or GIT_URL

    • toJson

      public static String toJson(EventRecord record)

    • getBuildVersion

      public static String getBuildVersion()

    • getBuildCauses

      public static String getBuildCauses(Run run)
      Parameters:
      run - Jenkins job run
      Returns:
      causes separated by comma