Skip to main content
Sumo Logic

Install the Jenkins App and view the Dashboards

Install the Sumo Logic App

Now that you have set up collection for Jenkins, install the Sumo Logic App for Jenkins to use the pre-configured searches and dashboards that provide visibility into your environment for real-time analysis of overall usage.

To install the app:

Locate and install the app you need from the App Catalog. If you want to see a preview of the dashboards included with the app before installing, click Preview Dashboards.

  1. From the App Catalog, search for and select the app. 
  2. To install the app, click Add to Library and complete the following fields.
    1. App Name. You can retain the existing name, or enter a name of your choice for the app.

    2. Data Source. Select either of these options for the data source.

      • Choose Source Category, and select a source category from the list.

      • Choose Enter a Custom Data Filter, and enter a custom source category beginning with an underscore. Example: (_sourceCategory=MyCategory).

    3. Advanced. Select the Location in Library (the default is the Personal folder in the library), or click New Folder to add a new folder.
    4. Click Add to Library.

Once an app is installed, it will appear in your Personal folder, or other folder that you specified. From here, you can share it with your organization. See Welcome to the New Library for information on working with the library in the new UI.

Panels will start to fill automatically. It's important to note that each panel slowly fills with data matching the time range query and received since the panel was created. Results won't immediately be available, but with a bit of time, you'll see full graphs and maps. 

Dashboards

This section describes the dashboards in the Sumo Logic App for Jenkins.

Overview

A summary of build results, including a breakdown of successes and failures, information about recent failure rates, and failure rates over time.

jenkins-overview.png


Build Result. A donut chart that shows the count and percentage of successful and failed builds over the last 24 hours.

Recent Failure. A table of recent job failures by build name over the last 24 hours.

Recent Failure.The count of job failures over the last 24 hours.

Top Slowest Failed Build. The five builds that ran the longest before failing over the last 24 hours.

Build Results Over Time. An area chart that shows the count of successful and failed builds over the last 7 days

Build Summary - One day Time Comparison. A table that shows build results comparison between today and yesterday. 

Top Slowest Successful Build. The successful build that took the longest to run over the last 24 hours.

Build Failure - Outlier. Shows the count of build failures per timeslice over the last 24 hours, using the outlier operator to identify timeslices where the failure count is statistically significant.

Top 20 failure percent. The 20 builds, listed by name, that had the highest percentage of build failures over the last 7 days, where percentage of build failures is calculated as (Number of Failed Builds / Total Builds ) X 100.

Build Success-Failure Rate. A stacked column chart that shows the count of successful and failed builds per timeslice over the last 7 days.

Metrics

Current build activity status, including the length of the build queue, current and average and maximum waiting time, the counts of executors and free executors, and associated trend information. 

jenkins-metrics.png

Builds in queue. Total number of builds currently waiting in the Jenkins build queue to be started.

Current Maximum Waiting Time. For the build that has been in the queue the longest, the length of time that build has been in the queue. 

Current Average Waiting Time. The average time the builds in the queue have been waiting over the last 15 minutes . 

Number of Executors. Total number of Jenkins executors.

Number of Free Executors. Number of available Jenkins executors.

Number of Slaves. Number of Jenkins slaves.

Number of Builds in Queue Over Time. A line chart that shows the number of builds in the build queue per timeslice over the last 7 days.

Average and Maximum Waiting Time. A line chart that shows the average and maximum waiting time for builds per timeslice over the last 7 days.

Number of Free Executors Over Time. A line chart that shows the number of free executors per timeslice over the last 7 days.

Build Summary

Details about build results, including failed and successful builds over time, tabular summaries of failed and successful builds, and details about the slowest and failed and successful builds over time.

jenkins-build-summary.png

Failed Builds Over Time. A line chart that shows the count of failed builds per timeslice over the last 7 days.

Failed Build Summary Table. A table that lists builds that failed over the last 24 hours, and for each, the start time of the build job, and how long it ran prior to the failure.

Failed Build - One day Time Comparison. A table that shows the count of build failures over the last 24 hours compared with the count of failures in the day prior to that.

Build Summary. A table that lists the count of successful and failed builds by name over the last 24 hours.

Build Summary - One day Time Comparison. A table that show the count of successful and failed builds by name over the last 24 hours compared with the count of failures in the day prior to that.

Successful Build Summary Table. A table that lists builds that succeeded over the last 24 hours, and for each, the start time of the build job,  and how long it ran prior to completion.

Top 5 Slowest Successful Builds by Name. The five builds that that took the longest time to run to completion.

Top 5 Slowest Failed Builds by Name. The five builds that that took the longest time to run tand completed successfully over the last 24 hours.

Successful Build Summary Over Time. A stacked column chart that shows the count of successful build by build name per timeslice over the last 7 days.