The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

OverOps Query Plugin

OverOpsQuery: OverOps Quality Report

  • applicationName : String (optional)
    (Optional) Application Name as specified in OverOps.
    • If populated, the plugin will filter the data for the specific application in OverOps.
    • If blank, no application filter will be applied in query.
  • checkCriticalErrors (optional)
    Use this Gate to detect specific critical errors in the current build.
    • Type: class net.sf.json.JSONObject
  • checkNewErrors (optional)
    Use this Gate if you want to check for any new errors in the current build.
    • Type: class net.sf.json.JSONObject
  • checkResurfacedErrors (optional)
    Use this Gate if you want to check for any errors that have resurfaced and are occurring in the current build after being marked as resolved in OverOps.
    • Type: class net.sf.json.JSONObject
  • checkUniqueErrors (optional)
    Use this Gate to limit the number of allowable Unique Errors in the current build.
    • Type: class net.sf.json.JSONObject
  • checkVolumeErrors (optional)
    Use this Gate to limit the Total number of allowable Errors in the current build.
    • Type: class net.sf.json.JSONObject
  • criticalExceptionTypes : String (optional)
    A comma delimited list of exception types that are deemed as severe regardless of their volume. If events of any exceptions listed have a count greater than zero, the build will be marked as unstable.

    Example: NullPointerException,IndexOutOfBoundsException

  • debug : boolean (optional)
    If checked, all queries with results will be displayed in the OverOps reliability report. For debugging purposes only.
  • deploymentName : String (optional)
    (Optional) Deployment Name as specified in OverOps or use Jenkins environment variables.

    Example: ${BUILD_NUMBER} or ${JOB_NAME}-${BUILD_NUMBER}

    • If populated, the plugin will filter the data for the specific deployment name in OverOps
      Note: If using Jenkins environment variables, they must be added to the build’s manifest file for OverOps to use. See this link for details.
    • If blank, no deployment filter will be applied in the query.
  • errorSuccess : boolean (optional)
    If checked, the build will be marked Success if unable to generate a Quality Report. By default, the build will be marked Not Built if unable to generate a Quality Report.
  • linkReport : boolean (optional)
    Set true if you want to simply generate a link to the report to view later.
    Note: Setting this to true will not fail the build as the quality report has not been generated yet.
  • markUnstable : boolean (optional)
    If checked the build will be marked unstable if any of the five gates are met.
  • maxErrorVolume : int (optional)
    Set the max total error volume allowed. If exceeded the build will be marked as unstable.
  • maxUniqueErrors : int (optional)
    Set the max unique error count allowed. If the target volume is exceeded the build will be marked as unstable.
  • newEvents : boolean (optional)
    Check if the current build has any new errors.
  • printTopIssues : int (optional)
    Displays the top X events (as provided by this parameter) with the highest volume of errors detected in the current build. This is used in conjunction with Max Error Volume and Unique Errors to limit the result set to the top errors which caused a build to fail.
  • regexFilter : String (optional)
    A way to filter out specific event types from affecting the outcome of the OverOps Reliability report. Event types include: Uncaught Exception, Caught Exception, Swallowed Exception, Logged Error, Logged Warning, Timer. This filter enables the removal of one or more of these event types from the final results.

    Example filter expression with pipe separated list: "type":"s*(Logged Error|Logged Warning|Timer)"

  • resurfacedErrors : boolean (optional)
    Check if the current build has any errors that have resurfaced since being marked as resolved in OverOps.
  • serviceId : String (optional)
    The OverOps environment identifier (e.g S4567) to inspect data for this build. If no value is provided here, the value provided in the global Jenkins plugin settings will be used.
  • showPassedGateEvents : boolean (optional)

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.