Plugin Usage

The CI Plugins usage dashboard provides visibility for all plugins installed across the organization’s CloudBees CI enterprise.

Plugins are the heart and soul of CloudBees CI and, hence, tracking the usage of plugins is a fundamental need. Large DevOps teams typically need hundreds of plugins to support their CI pipelines and application development teams. CloudBees CI administrators need to maintain and periodically clean-up their inventory of plugins to keep their CloudBees CI instances lean. This is considered best practice to ensure system stability and optimal performance. Fewer plugins also typically means less upgrade risk and less verification effort needed during an upgrade.

Accessing Plugin Usage

Follow these steps to access Plugin Usage analytics.

  1. Select Analytics from the CloudBees navigation. The analytics dashboard list is displayed. Dashboards in the list vary based on CloudBees Software Delivery Automation capabilities for which you have licenses.

    If Analytics is not active from the CloudBees navigation, click Learn more for licensing information.
  2. Now, select Plugin Usage from the list. The Plugin Usage dashboard displays.

plugin usage dash

Filters

Control the set of data used in visualizations with these filters:

1

Time range: The time range to use in analytic calculations. Defaults to past three months.

2

Controller: The list of controllers to use in analytic calculations. By default, data for all configured controllers is used.

3

Types of plugin usage: The types of plugins usage shown in the analytic calculations. By default, data for all types of plugin usage is considered.

  • Configuration: Plugin is mentioned in any stored Jenkins configuration files. This includes Freestyle jobs.

  • Dependency: Plugin is a dependency of another plugin.

  • Pipeline: Plugin is used in a Pipeline job.

4

Parameters: Time slice (days): Plugins not updated for more than the selected number of days are considered to be outdated in the metric calculations. Defaults to 180 days.

Visualizations

The visualizations on this dashboard correlate data based on filter settings.

Plugin use

Breakdown of installed plugins by usage. Plugins that are not directly mentioned in any stored configurations, do not contribute anything to jobs, and are not dependencies of any other plugin, for example security plugins such as active-directory and LDAP, are reported as Unused.

Plugin support by CloudBees

Breakdown of plugins usage by support. All tier 1 and tier 2 plugins are reported as Supported. See CloudBees plugin support policies for support details.

Update recency

Breakdown of installed plugins by update recency. If a plugin has not been updated in the last 180 days, it is reported as Outdated. This value can be changed using the Parameters > Time slice (days) filter above.

Plugins overview table

Tabulates installed plugins based on selected filters. Selectors at the top of each column allow you to sort by that column’s content.

Column name

Description

Plugin name

The plugin name.

Plugin ID

The plugin ID.

Plugin version

The plugin version. When there are different versions of the plugin installed on different controllers, the most recent version is shown in this column.

Supported by CloudBees

Whether the plugin is supported by CloudBees. See CloudBees plugin support policies for support details.

Detected usage

The number of times the plugin has been used. Multiple occurrences of the same usage in the same object are counted just once. For example, if a plugin is used in a pipeline, then this contributes to one usage count in this column, regardless of how many times the pipeline is run. If a plugin is used in multiple pipelines, then each pipeline where it’s used is counted as 1 detected usage. Refer to how to determine if a plugin is in use for more details.

Number of controllers

The number of controllers on which the plugin is installed.

Last Pipeline run

The last time the plugin was used in a pipeline run.

Plugin details table

Selecting a plugin in the plugins overview table opens up a popup with the plugin details table. It tabulates all the detected usages of the selected plugin. Selectors at the top of each column allow you to sort by that column’s content.

Column name

Description

Controller name

The name of the controller where the plugin is installed and where a usage is detected.

Type

The plugin usage type.

Details

Details about the plugin usage. Depending on the plugin usage type, this field provides more detail about the usage. * Configuration usage type shows the object name where the plugin is mentioned in its configuration. * Dependency usage type contains the name of the plugin that is dependent on the selected plugin. * Pipeline usage type contains the pipeline name.

Version number

The plugin version used.

Used at

Date of plugin usage.

Plugin usage data

The plugin usage data is captured from each controller using the CloudBees Plugin Usage Analyzer plugin.