Skip to end of metadata
Go to start of metadata

      

The plugin provides a mechanism for querying OverOps data as a post build step to ensure continuous reliability. The plugin provides the ability to mark a build unstable if OverOps has detected "new" errors since the previous build.




Visit overops.com to learn more about OverOps.

Installation

Pre-requisites

  • Jenkins 2.43 or later running on Java 1.8 or later

Global Configuration

Select Manage Jenkins -> Configure Plugin scroll down to OverOps Query Plugin

OverOps URL: The complete url including port of the OverOps e.g. http://localhost:8080 or for SaaS https://api.overops.com

OverOps Service ID OverOps Service ID (begins with S such as S12355)

OverOps API Key.   When using an API key User and Password fields are ignored.

Test connection would show you a count of available metrics. If the count shows 0 measurements, credentials are correct but database may be wrong. If credentials are incorrect you will receive an authentication error.

Job Post Build Configuration

Application Name OverOps Application Name to match in Query

Deployment Name OverOps Deployment Name to match in Query. Can make use of Jenkins Build Variables such as ${BUILD_NUMBER}.

Active Time Window The time window (in minutes) inspected to seach for new issues and regressions.'

Baseline Time Window The time window in minutes against which events in the active window are compared to test for regressions.

Critical Exception types A comma delimited list of exception types that are deemed as severe regardless of their volume.

Apply Seasonality Set whether the active time window is compared against matching historical spikes to avoid false positives.

Environment ID The OverOps environment identifier (e.g S4567) to inspect data for this build.  Overrides global config.

Mark Build Unstable Check if we should mark the build unstable if the Max Event Count or Max New Event Count is exceeded.

Show Query Results Check if we should should display the REST API query results in the Jenkins console.

Verbose Mode Check if we should output the regression comparison in the Jenkins console.