Giter VIP home page Giter VIP logo

cloudbees-jenkins-advisor-plugin-1's Introduction

Jenkins Health Advisor by CloudBees

This jenkins plugin periodically uploads support bundles for processing by Jenkins Health Advisor by CloudBees. Jenkins Health Advisor by CloudBees analyse these bundles and send in return an email when it detects a new known issue referenced by the CloudBees Support team.

To configure the plugin go into Manage Jenkins > `Manage Jenkins Health Advisor by CloudBees.

Project Tracking

Build Job

  • You can see the plugin's build status here.

Configuration

Configure Programmatically

import com.cloudbees.jenkins.plugins.advisor.*

def config = AdvisorGlobalConfiguration.instance
  
config.email = "[email protected]"
config.cc = "[email protected]" // optional
config.isValid = true
config.nagDisabled = true
config.acceptToS = true

config.save()

System Properties

Upload Recurrence Period

Cannot be overridden at runtime. Requires restart to take effect. Defaults to 24hrs.

Overriding with Java System Property:

-Dcom.cloudbees.jenkins.plugins.advisor.BundleUpload.recurrencePeriodHours=1

Upload Timeout

Available properties:

Property Default Unit Description
com.cloudbees.jenkins.plugins.advisor.client.AdvisorClientConfig.advisorUploadTimeoutMinutes 60 minutes The maximum time to wait for a response
com.cloudbees.jenkins.plugins.advisor.client.AdvisorClientConfig.advisorUploadIdleTimeoutMinutes 60 minutes The maximum time an upload request can stay idle

Can be overridden dynamically at runtime, via Script Console:

System.setProperty("com.cloudbees.jenkins.plugins.advisor.client.AdvisorClientConfig.advisorUploadTimeoutMinutes", "120");

Settings are lost after restart.

Can be permanently added by amending Jenkins Java System Properties:

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

Defaults to 60 (minutes)

Upload Initial Delay

Cannot be overridden at runtime. Requires restart to take effect. Defaults to 5mins.

Overriding with Java System Property:

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

Troubleshooting

Manual upload launch

The following can be run from the Script Console to manually trigger an upload:

import hudson.model.*
import hudson.triggers.*
import jenkins.util.Timer;


for(trigger in PeriodicWork.all()) {
  if(trigger.class.name == "com.cloudbees.jenkins.plugins.advisor.BundleUpload"){
    trigger.run()
    return
  }
}

Idle timeout

Bundle uploads fail with:

SEVERE: Issue while uploading file to bundle upload service: java.util.concurrent.TimeoutException: Request reached idle time out of 120000 ms after 120483 ms

Try adjusting the idle timeout period.

See the Upload Timeout section for how to do that.

File is not a normal file.

Bundle uploads fail with:

Jenkins Health Advisor by CloudBees failed to upload a bundle: ERROR: Issue while uploading file to bundle upload service: An error occurred while checking server status during bundle upload. 
Message: com.cloudbees.jenkins.plugins.advisor.client.AdvisorClient$InsightsUploadFileException: Exception trying to upload support bundle. Message: File is not a normal file.

Check the logs as the cause should be printed as a SEVERE message along with the above message (File is not a normal file.) duplicated.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.