This plugin contributes a new view implementation that provides a dashboard / portal-like view for your Jenkins instance.
This plugin contributes a new view implementation that provides a dashboard / portal-like view for Jenkins.
On the Jenkins main page, click the + tab to start the new view wizard (If you do not see a +, it is likely you do not have permission to create a new view). On the create new view page, give your view a name and select the Dashboard type and click ok.
The configuration is done in 2 parts, selecting the Jenkins jobs to include in the view, and selecting which dashboard portlets to have included in the view. The jobs that you select are used for all the portlets to draw their information from.
Select the list of jobs to include in the dashboard. This is exactly the same process as the standard list view that comes with Jenkins.
Also a regular expression can be used to specify the jobs to include in the view.
Configure which portlets you want to see on the top and on the left and the right column. Each portlet may have its own configuration but at a minimum it requires a name to be given to it.
The dashboard view supports a layout with rows spanning the entire view with 2 columns.
The dashboard view comes with a number of portlets that you can configure your view with (New portlets can be contributed to Jenkins via other plugins, even your own).
This portlet shows a row for each job showing the standard columns configured in Jenkins. All the configured portlets are displayed below this list.
The jobs grid portlet displays a 3 column table with the current status and a clickable link to the job. This offers a more compressed presentation of your jobs than the standard 1 row per job view, albeit at the cost of some job information.
This portlet lists the unstable jobs within the view. Note, this does not necessarily list all of Jenkins' unstable jobs, but only looks at jobs configured for this view.
The test statistics grid shows detailed test data for the configured jobs. This is useful to get an aggregated count of tests across the jobs in your view.
This is a pie chart of the tests in the configured jobs. It shows the passing, failing, and skipped jobs with the total # and percentages.
This is a chart that shows your tests over time in aggregate. The logic is that for every day since the first job in the view was built, it shows the total number of passing, skipped and failing tests in aggregate across the build. It assumes that if a build did not occur on a given day, that the previous day's build results (or the previous-previous day, etc.) will be used.
Shows statistics based on jobs health.
Shows statistics based on build status.
Much of the benefit of this plugin will be realized when other plugins that enhance Jenkins offer support for it.
Add support in your plugin:
It is possible to define custom parameters for the DashboardPortlet. The displayName is always required. To add new parameters:
Looking at the source code of this plugin will show a number of examples of doing this. The core portlets do the same thing that your plugin would do.
On your plugin Wiki page, add the label supports-dashboard-view so that it will show up in the list below.
WARNING: if upgrading from a previous release, all the dashboard views must be edited and saved (also without modifying anything) to correctly work with this version.
Skip to end of metadata Go to start of metadata