This app provides a mechanism for applying OverOps severity assignment and regression analysis to new builds to allow application owners, DevOps engineers, and SREs to determine the quality of their code before promoting it into production.
Run this app as a post build step after all other testing is complete to generate a Quality Report that will determine the stability of the build. From the Quality Report you can drill down into each specific error using the OverOps Automated Root Cause analysis screen to solve the issue.
For more information about this app and quality gates, see the OverOps CI/CD Pipeline Integrations guide.
Navigate to Bamboo Administration → Manage apps. Click "Find New Apps" and search for "OverOps" to install the app from the Atlassian Marketplace. Alternatively, you may download the latest release and click "Upload app" to install the app directly.
After installing the app, configure it to connect to OverOps.
From Bamboo Administration, select "Settings" under "OverOps". Enter the API URL and your API Token. Optionally, you may also set the default Environment ID.
The complete URL of the OverOps API, including port. For example, https://api.overops.com for SaaS or http://host.domain.com:8080 for on prem.
The complete URL of the OverOps APP, including port. For example, https://app.overops.com for SaaS or http://host.domain.com:8080 for on prem.
The OverOps REST API token to use for authentication. This can be obtained from the OverOps dashboard under Settings → Account.
The default OverOps environment identifier (e.g. S12345) if none is specified in the Quality Report configuration for your project.
Click Test Connection to confirm connectivity to the API server. If an Environment ID is provided, this will also confirm the credentials provided have access to the environment.
Navigate to Plan Configuration → Tasks for your Bamboo project. Click "Add task" and search for the OverOps Quality Report.
The OverOps environment identifier (e.g S4567) If no value is provided here, the default value provided in the global configuration will be used.
(Optional) Application Name as specified in OverOps. Bamboo variables may be used in this field.
(Optional) Deployment Name as specified in OverOps. Bamboo variables may be used in this field.
Filter out specific event types from the OverOps Quality Report. Event types include: Uncaught Exception, Caught Exception, Swallowed Exception, Logged Error, Logged Warning, Timer
Example: "type":\"s*(Logged Error|Logged Warning|Timer)
Prints the top X events (as provided by this parameter) with the highest volume of errors detected in the build. This is used in conjunction with the Total Error Volume Gate and the Unique Error Volume Gate to identify the errors which caused a build to fail.
If checked the build will be marked failed if any quality gate did not pass.
If checked a link will be generated and displayed. The Quality Report can then be viewed by clicking the generated link. Note: If checked the Mark Unstable option is ignored.
If checked the quality report will list events for both passed and failed quality gates, otherwise only events for failed gates will be displayed.
Detect all new errors in the build.
Detect all resurfaced errors in the build.
Set the max total error volume allowed.
Set the max unique error volume allowed.
A comma delimited list of exception types that are deemed as critical.
Example: NullPointerException,IndexOutOfBoundsException
If checked, inability to run the OverOps reliability report will not fail the build.
If checked, all queries and results will be logged. For debugging purposes only.
For short-lived applications, we recommend using the -Dtakipi.shutdown.gracetime=20000 agent property.
Before building the app, you must install the Atlassian SDK for Windows, Linux or Mac. Verify that the SDK has been installed using the atlas-version command, which produces output similar to:
ATLAS Version: 8.0.16
ATLAS Home: /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec
ATLAS Scripts: /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec/bin
ATLAS Maven Home: /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec/apache-maven-3.5.4
AMPS Version: 8.0.2
--------
Executing: /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec/apache-maven-3.5.4/bin/mvn --version -gs /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec/apache-maven-3.5.4/conf/settings.xml
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T12:33:14-06:00)
Maven home: /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec/apache-maven-3.5.4
Java version: 1.8.0_191, vendor: Oracle Corporation, runtime: /Library/Java/JavaVirtualMachines/jdk1.8.0_191.jdk/Contents/Home/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "10.14.6", arch: "x86_64", family: "mac"After cloning this project, build the app with atlas-mvn clean package. The resulting jar and obr files can be found in the target/ directory.
Deploy the app by uploading the jar or obr on the Bamboo Administration Manage apps page.
Debug logs can be found in /var/atlassian/application-data/bamboo/logs/atlassian-bamboo.log