The CloudBees Pipeline Explorer plugin offers a streamlined approach to troubleshoot pipelines and view logs. This plugin was developed with a focus on performance to improve your experience for log viewing, whether your log files are 5MB or 500MB.
The Pipeline Explorer can visualize the stages of your Pipelines in a tree view that lets you filter the logs by stages. The log viewport can be customized with user preferences for line numbers, displaying ANSI colors from the log text, word wrapping, and custom time formats for timestamps.
The Pipeline Explorer also provides a search feature, permitted through RBAC, so that users can search large files without leaving the Pipeline Explorer interface.
Installing the CloudBees Pipeline Explorer Plugin
-
To find the plugin, go to Manage Jenkins > Manage Plugins > Available Plugins and search for the CloudBees Pipeline Explorer.
-
Install the CloudBees Pipeline Explorer.
-
After the installation has completed, select
CloudBees Pipeline Explorerin the left navigation pane of Pipeline builds to access the new functionality.
|
The CloudBees Pipeline Explorer only supports Pipeline builds that start after the plugin is installed and enabled. |
Managing the CloudBees Pipeline Explorer
The following example shows the CloudBees Pipeline Explorer viewport. This displays the log information, the build information, and the preferences panel.
-
Page header that displays the build name and build status
-
Toolbar that displays the following information:
-
The navigation buttons that are used to navigate through the log and search output
-
The label that displays the number of lines
-
The download button that downloads the log
-
-
The build details line that displays the following information:
-
Duration of the build
-
Build start time
-
A Rebuild button that rebuilds the completed builds
-
A Replay button that replays the completed builds
-
An Abort button that aborts the in-progress builds
-
-
Search bar
-
Expands/collapses the tree view
-
Expands/collapses the user preferences view
-
Filter icon that filters the logs
-
Star icon that sets the drawer as favorite. Favorite drawer is open by default.
-
Closes the tree drawer
-
Console output
-
The customized log view panel (select the settings icon) that lets you personalize the view and behavior options, including the following user view preferences:
-
Display line numbers
-
Display ANSI colors
-
Wrap long lines
-
Display timestamps and their format
-
|
The ANSI coloring state is not preserved across line boundaries. |
-
The customized log view panel also includes the following behavior preferences:
-
Add a favorite drawer name that opens by default
-
Scroll to the last line on load
-
Scroll to the cause of the failure on load by default
-
Searching the logs
The CloudBees Pipeline Explorer can search the logs. To use the search feature, there are search permissions that must be enabled by the administrator through the Run > CloudBeesPipelineExplorerSearch RBAC permission.
The search feature is case insensitive. When you enter a term in the search bar and press Enter, the CloudBees Pipeline Explorer searches the entire log file for the search term and returns all of the matching lines with the search term highlighted in each result. The toolbar displays the total number of search results that were found.
You can also select the following search options:
-
Select the
link icon to copy a link for a specific line in the log to your clipboard -
Select the
goto icon to go to a specific line in the log in a new browser tab
The following example shows the search results with the Display colors preferences enabled.
For information about the CloudBees Pipeline Explorer plugin requirements and releases, refer to CloudBees Pipeline Explorer Plugin.