CloudBees Jenkins Advisor is a free diagnostics services which distills years of Jenkins expertise into recommendations tailored to your Jenkins environment.

This plugin periodically uploads support bundles to a diagnostics service hosted by CloudBees. Once an issue is detected, it advises you on solutions using CloudBees’ expansive knowledge base of common and known issues.

For more help with diagnosing your identified issues, check out the CloudBees Support Community and the CloudBees Jenkins Knowledge Base. 

This proactive approach support will help you to fix issues before they impact your software delivery process - increasing your team's uptime, performance and productivity.

Usage Requirements 

• Jenkins core 2.54+ and Java 8
• A CloudBees account → this account will be used by the Jenkins Plugin to connect to the diagnostics service.  Your credentials will have to be entered on the plugin page. 
• Required Dependencies:
  
  • Credentials Plugin v.2.1.13
  • Support Core Plugin v.2.41 

Getting started

To start, install the CloudBees Jenkins Advisor plugin from the Jenkins update center, sign up for a CloudBees account, and from the "Manage" page, select "Manage CloudBees Jenkins Advisor"

Now add your CloudBees account credentials and test to ensure your instance can connect successfully to the CloudBees Jenkins Advisor hosted service.

Once you have successfully connected your Jenkins instance, you will receive a confirmation email, followed shortly by your first diagnostics report if any issues are detected. Your instance will be re-scanned daily for new issues, as well as after each restart of your master.

You can configure what contents in your support bundle are sent to CloudBees by selecting the "Advanced Configuration" section, and selecting/unselecting the types of data that should or should no be uploaded.

There are a few command line/configuration file options to control when and how your data uploads to the CloudBees Jenkins Advisor service.

Setting custom upload intervals

To control how often your instance attempts to upload data for analysis, you can set a custom recurrence period. This setting cannot be overridden at runtime, and will require a restart to take effect. The default period is (60 * 24) (24hrs).

Override this setting by using a Java System Property:

-Dcom.cloudbees.jenkins.plugins.advisor.BundleUpload.recurrencePeriodMinutes=60

Setting custom upload timeout

To control how long your instance waits while attempting to connect and upload data to the Advisor service, you can set a custom advisor upload timeout. This can be changed dynamically and temporary at runtime via Jenkins Script Console:

System.setProperty("com.cloudbees.jenkins.plugins.advisor.client.AdvisorClientConfig.advisorUploadTimeoutMinutes", "120");Settings are lost after restart.

Or permanently by amending Jenkins Java System Properties:

-Dcom.cloudbees.jenkins.plugins.advisor.client.AdvisorClientConfig.advisorUploadTimeoutMinutes=120

This setting defaults to 60 (minutes)

Troubleshooting and Debugging

CloudBees Jenkins Advisor's tasks are AsyncPeriodicWork, so it stores its logs under  /logs/tasks

If you do not receive a welcome email soon after activating your connection, please check this folder errors in your logs. Errors can include:

• Upload size >200 mb - the CloudBees Jenkins Advisor service only supports scanning up to 200 mb of instance data. You can check whether the data upload size is too large by looking in the $JENKINS_HOME/support  folder and reviewing the size of the zip files within. If they are too large, use above-mentionedoned data configuration options to opt out of including some file types in your bundle.

Changelog

1.2 (5 Sept. 2017)

Fix for "Connect Now" error.

1.1 (25 Aug. 2017)

Change admin notification.

Security fixes.

1.0 (22 Aug. 2017)

First release.