Concourse Overops Resource
Quick Set Up
Assuming there is already an instance of Concourse up, the next step is to attatch the OverOps Resource to your existing pipeline. Configure the example
overops-resource.yml and then run
fly -t OO-example set-pipeline -c pipeline.yml -p oo-test to add it into your Build. Please replace the
OO-example with your own names and make sure the configuration is the correct yml file.
example file name:
resource_types: - name: overops-resource type: docker-image source: repository: overops/concourse-resource tag: latest resources: - name: overops-check type: overops-resource source: overOpsURL: https://api.overops.com overOpsSID: S111111 overOpsAPIKey: ((overOpsAPIKey)) applicationName: App1 deploymentName: Dep1 markUnstable: false activeTimespan: 2d baselineTimespan: 14d newEvents: true resurfacedErrors: true debug: false jobs: - name: test plan: - get: overops-check params: # override some optional source parameters on the job level debug: true markUnstable: true
|overOpsURL||true||---||The OverOps API Endpoint(Saas: https://api.overops.com)|
|overOpsSID||true||---||The OverOps environment identifier (e.g S4567) to inspect data for this build|
|overOpsAPIKey||true||---||API Key for interaction with OverOps API|
|applicationName||true||---||Application Name as specified in OverOps|
|deploymentName||true||---||Deployment Name as specified in OverOps|
|regexFilter||false||A way to filter out specific event types from affecting the outcome of the OverOps Reliability report.|
|markUnstable||false||false||If set to
|printTopIssues||false||5||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|
|newEvents||false||false||If any new errors is detected, the build will be marked as failed|
|resurfacedErrors||false||false||If any resurfaced errors is detected, the build will be marked as failed|
|maxErrorVolume||false||0||Set the max total error volume allowed. If exceeded the build will be marked as failed|
|maxUniqueErrors||false||0||Set the max total error volume allowed. If exceeded the build will be marked as failed|
|criticalExceptionTypes||false||A comma delimited list of exception types that are deemed as severe regardless of their volume.
- If any events of any exceptions listed have a count greater than zero, the build will be marked as unstable. Blank to skip this test.
|activeTimespan||false||0||The time window inspected to search for new issues and regressions. Set to zero to use the Deployment Name (which would be the current build).
|baselineTimespan||false||0||The time window against which events in the active window are compared to test for regressions. If this gate is used, baseline time window is required.
|minVolumeThreshold||false||0||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.
|minErrorRateThreshold||false||0||Value in range
- 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.
|regressionDelta||false||0||Value in range
- 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.
|criticalRegressionDelta||false||0||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.
|applySeasonality||false||false||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.|
|debug||false||false||For advanced debugging purposes only|
This parameters need to be provided in the
source configuration of your
however non-required parameters can be overwriten on the get step
for more details see example below.
The ARC Links inside of the UI display after a build with the OverOps resource are not clickable they must be copy and pasted to be used.
Checks for the OverOps events associted given application deployment. Returns a list of associated event ids.
Generates the report based on OverOps events, if
markUnstable is set to
true then fails the build, until reported issues are fixed.