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: Query OverOps

  • applicationName
    (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.

    • Type: String
  • deploymentName
    (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.
    • Type: String
  • activeTimespan
    The time window (in minutes) inspected to search for new issues and regressions. Set to zero to use the Deployment Name (which would be the current build). Example: 1440 would be one day active time window.
    • Type: int
  • baselineTimespan
    The time window (in minutes) against which events in the active window are compared to test for regressions. Must be set to a non zero value Example: 20160 would be a two week baseline time window.
    • Type: int
  • criticalExceptionTypes
    A comma delimited list of exception types that are deemed as severe regardless of their volume. If new events of any exceptions listed have a count greater than zero, the build will be marked as unstable. Blank to skip this test.
    Example: NullPointerException,IndexOutOfBoundsException
    
    • Type: String
  • minVolumeThreshold
    The minimal number of times an event of a non-critical type (e.g. uncaught) must take place to be considered severe.
    
    
      
    - If a New event has a count greater than the set value, it will be evaluated as severe and could break the build if its event rate is above the Event Rate Threshold.
    - If an Existing event has a count greater than the set value, it will be evaluated as severe and could break the build if its event rate is above the Event Rate Threshold and the Critical Regression Threshold.
    - If any event has a count less than the set value, it will not be evaluated as severe and will not break the build.
    • Type: int
  • minErrorRateThreshold
    The minimum rate at which event of a non-critical type (e.g. uncaught) must take place to be considered severe. A rate of 0.1 means the events is allowed to take place <= 10% of the time.
    - If a New event has a rate greater than the set value, it will be evaluated as severe and could break the build if its event volume is above the Event Volume Threshold.
    - If an Existing event has a rate greater than the set value, it will be evaluated as severe and could break the build if its event volume is above the Event Volume Threshold and the Critical Regression Threshold.
    - If an event has a rate less than the set value, it will not be evaluated as severe and will not break the build.
    • Type: double
  • regressionDelta
    The change in percentage between an event's rate in the active time span compared to the baseline to be considered a regression. The active time span is the Active Time Window or the Deployment Name (whichever is populated). A rate of 0.1 means the events is allowed to take place <= 10% of the time.
    - If an Existing event has an error rate delta (active window compared to baseline) greater than the set value, it will be marked as a regression, but will not break the build.
    • Type: double
  • criticalRegressionDelta
    The change in percentage between an event's rate in the active time span compared to the baseline to be considered a critical regression. The active time span is the Active Time Window or the Deployment Name (whichever is populated). A rate of 0.1 means the events is allowed to take place <= 10% of the time.
    - If an Existing event has an error rate delta (active window compared to baseline) greater than the set value, it will be marked as a severe regression and will break the build.
    • Type: double
  • applySeasonality
    If peaks have been seen in baseline window, then this would be considered normal and not a regression. Should the plugin identify an equal or matching peak in the baseline time window, or two peaks of greater than 50% of the volume seen in the active window, the event will not be marked as a regression.
    • Type: boolean
  • markUnstable
    If checked the build will be marked unstable if any of the four gates are met.
    • Type: boolean
  • showResults
    If checked, all queries will be displayed in the OverOps reliability report. For debugging purposes only.
    • Type: boolean
  • printTopIssues
    Prints the top X events (as provided by this parameter) with the highest volume of errors detected within the active time window, This is useful when used in conjunction with Max Error Volume to identify the errors which caused a build to fail.
    • Type: int
  • maxErrorVolume
    Set the max total error volume allowed. If exceeded the build will be marked as unstable. Set to zero to to skip this test.
    • Type: int
  • maxUniqueErrors
    Set the max unique error count allowed. If the target volume is exceeded the build will be marked as unstable. Set to zero to to skip this test.
    • Type: int
  • regexFilter
    A way to filter out specific event types from affecting the outcome of the OverOps Reliability report. Sample list of event types, 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)

    • Type: String
  • verbose
    If checked, all query results will be displayed in the OverOps reliability report. For advanced debugging purposes only.
    • Type: boolean
  • serviceId
    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. Note: The 'S' must be capitalized.
    • Type: String
  • serverWait
    Delay time before querying OverOps (in seconds). This is meant to ensure analytics data has been transmitted to and analyzed by OverOps before the plugin performs a query.
    • Type: int

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.