Skip to main content

Jenkins plugin

Documentation Team
  • Updated

Jenkins plugin

This plugin allows you to add a data source that exposes the basic and core Jenkins components for users to visualize. You are able to index:

  • Projects (formally Jobs)

  • Controller

  • Plugins

  • Views

  • Folders

How to add a Jenkins data source

  1. To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

  2. Display Name:

    Enter a name for your data source. This helps you to identify this data source in the list of your data sources.

  3. Jenkins Server URL:

    Enter the URL to the Jenkins API.

  4. Username:

    Enter the username for your Jenkins account.

    The account must have API access.

  5. Password:

    Enter the password for your Jenkins account.

  6. Install Sample Dashboards:

    Select whether you would like to install sample dashboards with the data source. By default, this is set to on.

  7. Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

    The term data source here really means data source instance. For example, a user may configure two instances of the AWS data source, one for their development environment and one for production. In that case, each data source instance has its own access control settings.

    By default, Restrict access to this data source is set to off. The data source can be viewed, edited and administered by anyone. If you would like to control who has access to this data source, switch Restrict access to this data source to on.

    Use the Restrict access to this data source dropdown to control who has access to the workspace:

    • By default, the user setting the permissions for the data source will be given Full Control and the Everyone group will be given Link to workspace permissions.

    • Tailor access to the data source, as required, by selecting individual users or user groups from the dropdown and giving them Link to workspace or Full Control permissions.

    • If the user is not available from the dropdown, you are able to invite them to the data source by typing in their email address and then clicking Add. The new user will then receive an email inviting them to create an account on SquaredUp. Once the account has been created, they will gain access to the organization.

    • At least one user or group must be given Full Control.

    • Admin users can edit the configuration, modify the Access Control List (ACL) and delete the data source, regardless of the ACL chosen.

    Access Level:

    Link to workspace

    • User can link the data source to any workspace they have at least Editor permissions for.
    • Data from the data source can then be viewed by anyone with any access to the workspace.

    • User can share the data source data with anyone they want.

    • User cannot configure the data source in any way, or delete it.

    Full Control
    • User can change the data source configuration, ACL, and delete the data source.

    See Access control for more information.

  8. Click Test and add to validate the data source configuration.

    • Testing passed – a success message will be displayed and then the configuration will be saved.

    • Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.

    • Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.

    You can edit any data source configurations at any time from Settings > Data Sources.

    You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.

Using the Jenkins data streams

Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format. While creating a tile you can tweak data streams by grouping or aggregating specific columns. Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.

Data streams can be either global or scoped:

  • Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").

  • A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").

A single sample dashboard is included which utilizes all data streams included with the data source. It is titled Jenkins Activity and shows the status of the builds, data sources, and nodes.

Data streams are installed with the data source:

Plugin Status

  • Targets the Controller for all installed data sources

  • Plugins needing updates will be orange

Folder Status (Advanced)

  • Targets one or more Folders

  • Can be configured to run a tree query or return selected properties from all available properties

    • Great for custom properties

Project Status (Simple)

  • Targets one of more Projects for the status of the project

  • Returns status of the project, and details about the most recent builds

  • State matches the underlying project ‘color’

Project Status (Advanced)

  • Targets one or more Projects

  • Can be configured to run a tree query or return selected properties from all available properties

    • Great for custom properties

Build Status (Simple)

  • Targets one or more Projects/Folders for the status of builds

Build Status (Advanced)

  • Targets one or more Projects (though targeting more than one is not advised)

  • Can be configured to run a tree query or return selected properties from all available properties

    • Great for custom properties and/or very large data sets

  • Timestamp is always returned along with any other properties you query

Node Status

  • Targets the Controller to return all nodes and state

  • Nodes reporting as offline will be orange

Stage Status

  • Targets pipeline based Projects

  • Returns completed and in-progress builds

  • Returns list of stages and their status

Step Status

  • Targets pipeline based Projects

  • Returns completed and in-progress builds

  • Returns list of stage steps and their status

Controller Version

  • Targets the Controller

  • Returns controller version, current stable version, and latest version

  • Returns a health state showing whether the controller is out of date compared to a specific version

Weather Report

  • Targets one or more Projects/Folders

  • Returns weather reports where configured

  • Health is based on score

View Status (Advanced)

  • Targets one or more Views

  • Can be configured to run a tree query or return selected properties from all available properties

    • Great for custom properties