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.
- You can see the plugin's build status here.
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()
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
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)
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
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
}
}
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.
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.