Child pages
  • Jenkins Health Advisor by CloudBees

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Wiki Markup
{jenkins-plugin-info:pluginId=cloudbees-jenkins-advisor}

 

Note
titleDeprecated: This plugin has been removed from the Jenkins Update Centre

Thank you to everyone who used CloudBees Jenkins Advisor.

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

Info
titleNew Lower Jenkins Core Requirement

Now you can use CloudBees Jenkins Advisor if you are running on any Jenkins version 2.19.3 or higher.

 

 

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.

 

Widget Connector
url https://www.youtube.com/watch?v=X0yTs8SWWkQ

Usage Requirements 

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.

Image Removed

 

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.

...

Advanced Configurations

Configuring analyzed data

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.

Image Removed

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.3 (17 Nov. 2017)

Now supports 2.19.3+!

Connectivity indicator display on configuration page

Logging improvements

Additional test coverage

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.

 

 

Jenkins Health Advisor by CloudBeesImage Added

Jenkins Health Advisor by CloudBees (formerly known as "CloudBees Jenkins Advisor") proactively notifies you of problems with your Jenkins-based environment. Jenkins Health Advisor by CloudBees identifies numerous issues before they affect your users, including security vulnerabilities, performance problems, and plugin version issues. Best of all, Jenkins Health Advisor by CloudBees is constantly being improved by the CloudBees Support and Engineering teams to cover the most recent identified issues.

By default, you’ll receive a summary email whenever a new problem is identified in your Jenkins instance, and whenever one or more of the problems affecting your instance has been resolved. You can configure the email address Jenkins Health Advisor by CloudBees uses in the Configuration section.

Initially, Jenkins Health Advisor by CloudBees sends an initial report that lists everything it detects in your system. Subsequent reports will only report changes from the initial report. It’s important to note that Jenkins Health Advisor by CloudBees only emails you if it finds something wrong: if it doesn’t find any problem in your system, it won’t send you email.

Jenkins Health Advisor by CloudBees identifies problems by scanning a Support Bundle from your Jenkins master. The Support Bundle is generated on a daily basis by the plugin and submitted to servers hosted by CloudBees. For instructions on defining the types and kinds of data to include in the Support Bundle, see the Optional Configuration section in the documentation...

Image Added

Documentation

See https://go.cloudbees.com/docs/plugins/cloudbees-jenkins-advisor/

Troubleshooting

See Jenkins Health Advisor by CloudBees - Troubleshooting Guide

Changelog

See https://github.com/jenkinsci/cloudbees-jenkins-advisor-plugin/releases