JFrog Artifactory plugin
We'd love to hear your feedback on this plugin, contact [email protected] with any suggestions or queries.
For more information about what this plugin does and the data streams it retrieves, see:
Monitor the Artifacts and repositories from your Artifactory environment. The data source is available as a Cloud data source and also as an on-prem data source.
An on-prem data source connects a service running in your internal network to SquaredUp. They require an agent installed on a machine that has access to your internal network.
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
You will only need to configure and deploy an agent if you adding the Artifactory on-prem data source. If you want to add the Artifactory Cloud data source, you only need to configure the data source.
Configuring and deploying an agent
If you have already created an agent in SquaredUp that you can use for this data source, 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.- 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 Access control for more information.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:
See Access control for more information.
Install Sample Dashboards:
Select whether you would like to install sample dashboards with the data source. By default, this is set to on.You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.
Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method. If this process fails, see Testing and troubleshooting for assistance with the corresponding errors.
Next Steps
Data streams
The following data streams are installed with this plugin.
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 Artifact Storage Summary data stream retrieves a collection of your Artifactory artifacts as objects. Each artifact object contains information such as the name of the object, the repository it belongs to, the size and the last downloaded information.
The Artifact User Downloads data stream retrieves a collection of your Artifactory artifacts as objects. Each artifact object contains additional download information, such as the number of remote downloads and each user that has downloaded it.
The Artifact User Information data stream retrieves a collection of your Artifactory users as objects. Each user object contains information related to that user, such as the name, email address and status.
This data stream calls an API endpoint to query your Artifactory instance, and allows you to enter a custom query.
- In the tile editor, filter by the Artifactory Enterprise data source, select the AQL data stream and then click Next.
You can either select the scoped AQL data stream or the global AQL data stream.
- If you selected the scoped AQL data stream, select the objects you want to use and then click Next.
You do not need to do this if you have selected the global AQL data stream.
- Enter the AQL Query you want to use.
See the JFrog Artifactory documentation for more information about AQL queries.
The Builds data stream retrieves a collection of your Artifactory builds as objects. Each build object contains information related to that build, such as the name, version, started time and URL.
The List Artifactory Repositories data stream retrieves a list of your Artifactory builds.
The Projects data stream retrieves a collection of your Artifactory projects as objects. Each project object contains information related to that project.
The Server Health data stream retrieves your Artifactory server as an object with a health state, which can then be monitored.
Monitoring can be switched on from the Monitoring tab when editing a data tile. The Preview box shows the tile's state color and value for the current configuration while you are changing settings.
You can then choose the type of monitoring you need:
State monitors
Threshold monitors
The Storage Information data stream retrieves data about your Artifactory storage capacity, such as the total number of binaries and artifacts.
The on-prem instance of the plugin displays more information for this data stream than the cloud version, as it delivers more details through the API.
The Users With Access data stream retrieves a collection of your Artifactory repositories as objects. Each repository object contains access information such as the repository name and the list of engineers with access to that repository.