Jenkins plugin

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

Click the following link for additional content such as blogs, videos, use cases, and more:

Adding a data source

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.

Before you start

Will SquaredUp need to connect to this data source via a relay agent?
Configure the data source in SquaredUp

Will SquaredUp need to connect to this data source via a relay agent?

This plugin is a hybrid plugin, meaning it can connect to either a cloud or an on-prem data source.

If your data source is available on the internet, then you do not need to connect via a relay agent.
If your data source is on a private network and is not publicly accessible, then you will need to configure a relay agent before you configure the plugin. See Deploying a relay agent.

This feature is available with an Enterprise plan

Relay agents allow you to securely connect to data sources inside your own network (on-prem).

A relay agent is installed on a server on your internal network, and has access to your data source.

When a plugin uses a relay agent it means that you don't need to open your firewall to allow SquaredUp access to the data source.

If you have already created a relay agent in SquaredUp that can access this data source, then you can skip this step and choose Connect via relay agent when Configuring the data source.

Configuring the data source

Display name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.
Connect via relay agent
If you are connecting to an on-prem data source then select this toggle, so you can use a relay agent to connect securely.
Agent group:
Select the Agent Group that contains the agent(s) you want to use. Agent groups are managed from Settings > Relay Agents
Jenkins server URL:
Enter the URL to the Jenkins API.
Username:
Enter the username for your Jenkins account.
Password:
Enter the password for your Jenkins account.
Restrict access to this data source:
Optionally, enable this toggle if you only want certain users/groups to have access to the data source, or those with the permission to link it to new workspaces. See data source access control for more information.
Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.
- 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 data source configurations at any time from Settings > Data Sources.

Testing and troubleshooting

If you encounter an error refer to the guidance or contact our support team in-app or via SquaredUp Support

Error	What to do
The connection to Jenkins failed, please verify the URL and credentials.	Check the Jenkins server URL, the username, and the password are correct.

Next steps

Dashboards

A single pre-built 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

You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.

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").

See Data Streams for more information.

The following data streams are installed with this plugin.