For traditional platforms, you can collect CloudBees CD/RO logs and user-defined logs, such as for Apache or Oracle WebLogic, for all components in a CloudBees CD/RO standalone server and its agents or in a CloudBees CD/RO cluster.
| This article applies to CloudBees CD/RO installations on traditional, on-premise platforms. To collect logs in Kubernetes, refer to KBEC-00173 - Default locations and use scenarios for CloudBees CD/RO (CloudBees Flow) log files. |
For traditional platforms, you can collect CloudBees CD/RO logs as well as user-defined logs (such as for Apache or Oracle WebLogic) for all components in a CloudBees CD/RO standalone server and its agents or in a CloudBees CD/RO cluster. These logs are as follows:
-
CloudBees CD/RO server logs
-
CloudBees CD/RO agent logs
-
CloudBees CD/RO repository server logs
-
CloudBees CD/RO job logs
-
CloudBees CD/RO installer logs
-
Apache (web server) logs
-
User-defined logs
-
NLS: Insight Server logs
CloudBees CD/RO technical support might ask you for one or more these logs to troubleshoot issues. You can use one of three methods to collect logs:
The first two methods let you collect logs automatically from a standalone CloudBees CD/RO server and one or more of its agents or a cluster of two or more CloudBees CD/RO servers and one or more agents on each server. In the third method, you collect the log files individually from each server or agent system.
Prerequisites and limitations for CloudBees CD/RO log collection
For CloudBees CD/RO server prerequisites, prerequisites for collecting logs from all cluster nodes, as well as limitations, refer to Flow Log Collector plugin.
Collecting logs by using the logs collection Self-Service Catalog item
Collecting the logs via the Self-Service Catalog
To collect logs via the Self-Service Catalog:
-
Open the home page of the CloudBees CD/RO web UI by browsing to
https://<cloudbees-cd-server>/flow/. -
Select Service Catalog on the upper-most banner of the CloudBees CD/RO UI to display the service catalog.
For more information, refer to Service catalog.
-
Select the All Catalogs list menu and choose Utility to filter the selection to items in the utility category. The resulting list is filtered to display only the utility catalog.
-
On the Logs Collection tile, select Collect Logs to display the Logs Collection dialog box.
-
(Optional) Enter any additional parameters into the Logs Collection dialog box.
The required parameters are Log Collector Resource and Log Target Resources. These parameters are defaulted to
localanddefaultrespectively. All other parameters are optional and do not require values to produce a basic set of logs.For descriptions of all parameters (such as how they are chosen, limitations, and pre-requisites) for this procedure, refer to Flow Log Collector plugin.
-
Select OK.
The catalog item produces a .zip file of the individual logs. This file displays on the resulting Job Details page.
-
Right-click to save the .zip file to your system.
-
Either unzip the file to view the individual logs or send it to CloudBees technical support for analysis via an existing support ticket.
Collecting logs by running the EC-FlowLogCollector plugin procedure directly
The log collection functionality is based on the underlying EC-FlowLogCollector plugin. This plugin is bundled with CloudBees CD/RO and performs the actual collection of logs from CloudBees CD/RO servers and agents.
| You can download the Flow Log Collector plugin from the CloudBees CD/RO plugin catalog. |
An alternative to collecting logs via the Logs Collection Self-Service Catalog item is to run the plugin’s Collect Logs procedure directly in the Automation Platform.
To collect logs via the Automation Platform:
-
Go to
https://<cloudbees-cd-server>/commander/. -
Navigate to Administration > Plugins and select EC-FlowLogCollector. The Project Details page for the EC-FlowLogCollector plugin displays.
-
Select
for the Collect Logs procedure in the plugin. The Collect Logs page displays. -
(Optional) Enter any additional parameters into the Logs Collection dialog box.
The required parameters are Log Collector Resource and Log Target Resources and are defaulted to
localanddefaultrespectively. All other parameters are optional and do not require values to produce a basic set of logs.For descriptions of all parameters (such as how they are chosen, limitations, and pre-requisites) for this procedure, refer to Flow Log Collector plugin.
-
Select Run. The procedure generates a .zip file on the resulting Job Details page.
-
Right-click to save the .zip file to your system.
-
Either unzip the file to view the individual logs or send it to CloudBees technical support for analysis via an existing support ticket.
For an explanation of these logs, refer to Log File Contents.
Collecting logs manually
You collect logs manually from individual systems from the locations listed below. The following information is for default run-time log locations.
Agent logs
| Platform | Default Path |
|---|---|
Windows |
|
Linux or UNIX |
|
Agent logs “roll over” periodically so individual logs do not grow too large, and older logs are deleted. Roll-over parameters are configurable in conf/logback.xml and conf/agent.conf.
Server logs
| Platform | Default Path |
|---|---|
Windows |
|
Linux or UNIX |
|
Server logs “roll over” periodically so individual logs do not grow too large and older logs are deleted. Roll-over parameters are configurable in conf/logback.xml and conf/agent.conf.
Web server logs
| Platform | Default Path |
|---|---|
Windows |
|
Linux or UNIX |
|