JFrog Artifactory plugin

Monitor the artifacts and repositories from your Artifactory environment.

We'd love to hear your feedback on this plugin, and any suggestions or queries.

Contact our support team in-app or via SquaredUp Support

For more information about what this plugin does and the data streams it retrieves, see:

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.

You can also add a data source by clicking Add data source on the Settings > Data Sources page, but pre-built dashboards are not added when using this method.

Before you start

The Artifactory plugin is a "hybrid" plugin, meaning it is available in both cloud and on-prem versions.

Use the cloud plugin to access an Artifactory environment available over the internet.
Use the on-prem plugin to access an Artifactory environment on a server on-prem. You will need to configure a relay agent before you configure the on-prem plugin.
An on-prem data source uses a relay agent to connect SquaredUp to a data source running on your internal network.
A relay agent is installed on a server on your internal network, and has access to your data source.
Using a relay agent means that you don't need to open your firewall to allow access.

Configuring and deploying an agent

For an on-prem plugin you will need a relay agent that can access the server hosting your on-prem data source. You do not need a relay agent for cloud plugins.

If you have already created a relay agent in SquaredUp that can access this data source, then you can skip this step and choose the agent group you want to use while Configuring the data source.

See one of the following, depending on your platform type:

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.
Agent Group:
Select the Agent Group that contains the agent(s) you want to use.
This field will only appear if you are adding the on-prem plugin.
Artifactory Url:
Enter the URL of your Artifactory instance.
Authentication:
Select one of the following authentication types:
- Token: You must enter the API authentication token in the API Token field.
- Username and Password: You must enter a Username and Password in the corresponding fields.
Ignore Certificate errors:
If you activate this checkbox the data source will ignore certificate errors when accessing the server. This is useful if you have self-signed certificates.
Restrict access to this data source:
You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.
Install Dashboards:
Select whether you would like to install pre-built dashboards and perspectives with the data source. By default, this is set to on.
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 any data source configurations at any time from Settings > Data Sources.

Next Steps

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

See Data Streams for more information.

The following data streams are installed with this plugin.

Data stream	Description
Artifact Storage Summary	Returns downloads and last downloaded for each artifact in the selected scope
Artifact User Downloads	Returns users who downloaded each artifact in the selected scope
Artifactory User Information	Gets Artifactory user information
Builds	Returns Build information for each build in the selected collection
List Artifactory Repositories	Returns a full list of repositories in Artifactory
Projects	Lists each project in Artifactory and details about it
Repositories	Returns Repository information for each repository in the selected scope
Server Health	Displays the health of the Artifactory server
Storage Information	Lists the status of the Artifactory storage
Users With Access	For each repository in the selected collection, lists the users with access to it
Users With Access	For each artifact in the selected collection, lists the users with access to it

Configurable data streams

The following data streams have configurable Parameters.

Data stream	Description	Parameters
AQL Query	This data stream fetches data from your Artifactory instance using a custom query.	AQL Query: Specify an AQL Query to fetch data for. See the JFrog Artifactory documentation for more information about writing AQL queries.

Was this article helpful?

Have more questions or facing an issue?

Submit a ticket