CI Explorer¶
Guance supports visualizing the processes and results of CI built into GitLab/Jenkins. You can use the CI visualization feature of Guance to directly view CI results in GitLab/Jenkins, understand your CI performance, execution time trends, and failure reasons in real time. Through the CI flame graph, you can view the health status of the entire Pipeline chain during the CI process in real time, helping you provide code update assurance.
Data Query and Analysis¶
After CI process and result data is reported to the Guance Workspace, you can query and analyze Pipeline and Job success rates, failure reasons, specific failure stages, and more in the CI Explorer by selecting a time range, searching keywords, and filtering.
The distribution chart above the list counts by the status of the current Pipeline or Job by default. You can also switch to count-based statistics via Status Distribution Chart Preference to view the total number of records in each time period.
Time Widget¶
The CI Explorer displays data from the last 15 minutes by default. Using the "Time Widget" in the upper-right corner, you can select the time range for data display. For more details, see Time Widget.
Search and Filter¶
The CI Explorer search bar supports multiple search methods, including keyword search, wildcard search, correlation search, and JSON search. You can also filter values by Tags/Attributes, with support for positive filtering, reverse filtering, fuzzy matching, reverse fuzzy matching, exists, and does not exist, among other filtering methods. For more information about search and filtering, see Explorer Search and Filter.
Analysis Mode¶
In the CI Explorer analysis bar, you can perform multi-dimensional analysis and statistics based on 1-3 tags to reflect the distribution characteristics and trends of data across different dimensions and time periods. Guance supports multiple data chart analysis methods, including time series charts, top lists, pie charts, and treemaps. For more details, see Explorer Analysis Mode.
Quick Filter¶
In the CI Explorer, you can edit the Quick Filter and add new filter fields. After adding, you can select the field values for quick filtering.
Note:
- For "Duration" in the Quick Filter, the minimum and maximum values of the progress bar default to the minimum and maximum durations in the trace data list.
- You can drag the progress bar to adjust the maximum/minimum values, and the values in the input boxes update synchronously.
- You can manually enter the maximum/minimum values, then press "Enter" or click outside the input box to perform a filtered search.
- If the input is invalid, the input box turns red and no search is performed. The correct format is a plain "number" or "number+ns/μs/ms/s/min".
- If you search without entering a unit, "s" is appended directly after the entered number by default, and then the filtered search is performed.
- If you manually enter a unit, the search is performed directly.
For more information about quick filtering, see Quick Filter.
Customize Display Columns¶
In the Explorer list, you can use "Display Columns" to add, edit, delete, and drag display columns. When you hover over a display column in the Explorer, click the "Settings" button to sort ascending, sort descending, move the column left, move the column right, add a column to the left, add a column to the right, replace the column, add to Quick Filter, add to Group, or remove the column. For more information about customizing display columns, see Display Columns.
Data Export¶
In the Explorer list, you can first filter out the data you want, and then export it for viewing and analysis. You can click the small "Settings" icon to export to CSV files, dashboards, and notes.
GitLab¶
Pipeline Explorer¶
In the upper-left corner of the Explorer, you can switch to the "GitLab Pipeline" Explorer to query and analyze the CI Pipeline process, including Pipeline ID, name, duration, commit content, commit time, and more.
Pipeline Details Page¶
Click the data you want to view in the Pipeline list. The slide-out details page displays the details of the Pipeline and Job, including attributes, flame graph, Job list, content details, associated logs, and more.
When you click an attribute field, you can use "Filter Field Value", "Reverse Filter Field Value", "Add to Display Columns", and "Copy" to quickly filter and view.
- "Filter Field Value": adds the field to the Explorer to view all data related to that field.
- "Reverse Filter Field Value": adds the field to the Explorer to view data other than that field.
- "Add to Display Columns": adds the field to the Explorer list for viewing.
- "Copy": copies the field to the clipboard.
Flame Graph¶
The flame graph clearly shows the flow and execution time of each Job in the entire Pipeline chain during the CI process. You can view the corresponding service list and execution time proportion on the right side of the flame graph. Click a pipeline or job on the flame graph to view the corresponding JSON content in "Details".
Flame Graph Notes¶
CI visualization mainly collects data on Pipeline and Job during the CI process. The entire Pipeline process is divided into three stages: Build, Test, and Deploy, and each stage has different tasks (Jobs).
- When the tasks in each stage complete normally, the Pipeline is executed successfully. The flame graph lists the execution time of the entire Pipeline and the execution time of each Job.
- If an error occurs during task execution in the first stage, Build, the task failure and the cause of the error are displayed.
For ease of understanding, the following figure is an example of a GitLab CI Pipeline process. Comparing it with the flame graph above, we can clearly see the execution time of each Job and the total execution time of the entire Pipeline.
Job List¶
Displays all stages and their Job counts in the entire Pipeline chain, including "Resource Name", "Job Count", "Execution Time", and "Execution Time Proportion". Click any Job to view the corresponding JSON content in "Details". If there is an error, an error prompt is displayed before the Job.
Job Explorer¶
In the upper-left corner of the Explorer, you can switch to "GitLab Job" to query and analyze the Job process of the CI Pipeline, including Pipeline ID, Job name, duration, commit content, commit time, and more.
Job Details Page¶
Click the data you want to view in the Job list. The slide-out details page displays the details of the Pipeline and Job, including attributes, flame graph, Job list, content details, associated logs, and more.
Jenkins¶
Pipeline Explorer¶
In the upper-left corner of the Explorer, you can switch to the "Jenkins Pipeline" Explorer to query and analyze the CI Pipeline process, including Pipeline ID, name, duration, commit content, commit time, and more.
Pipeline Details Page¶
Click the data you want to view in the Pipeline list. The slide-out details page displays the details of the Pipeline and Job, including attributes, flame graph, Job list, content details, associated logs, and more.
Job Explorer¶
Using the data type filter bar in the upper-left corner, you can switch to the "jenkins_job" Explorer to query and analyze the Job process of the CI Pipeline, including Pipeline ID, Job name, duration, commit content, commit time, and more.
Job Details Page¶
Click the data you want to view in the Job list. The slide-out details page displays the details of the Pipeline and Job, including attributes, flame graph, Job list, content details, associated logs, and more.
