We'd love to hear your feedback on this plugin, contact email@example.com with any suggestions or queries.
Visit our website to see the data that you can access if you use this plugin to add the data source to SquaredUp:
Monitor the Artifacts and repositories from your Artifactory environment. The data source is available as a Cloud data source and also as an on-premises data source.
An on-premises 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.
How to add an Artifactory data source
You will only need to configure and deploy an agent if you adding the Artifactory on-premises data source. If you want to add the Artifactory Cloud data source, you only need to follow the steps detailed in Add an Artifactory data source to SquaredUp.
Configure and deploy 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 adding the data source.
Create a unique API key for your agent and add the agent to an agent group in SquaredUp.
You create an API key by creating an agent in SquaredUp:
Go to Settings > Relay and add an Agent.
Give the new agent a name and a description that helps you identify where the agent is installed. For example:
Description: Test server in production domain
Choose the Agent Group for this agent:
If you already have agent groups, assign it to an existing group and click create.
If you don't have any agent groups yet or want to assign the new agent to a new group, leave the Agent Groups field empty and click create. Then create the agent group by clicking on Add Agent Group and select the new agent in the Agents field for the new group.
After you created the agent, the API key for this agent will be shown to you. Copy the key and store it until you inserted the key into the configuration of the agent you want to deploy on your machine.
The API key will only be displayed to you once. If you lose this API key, you need to generate a new one (by creating a new agent) and any references to the old API key in the configuration of the agent you deployed on your machine will need to be updated.
- The agent status will show as gray until the next stage of configuring the service is completed successfully.
Deploy the agent on a machine that has access to the service the data source connects to.
Running the agent as a domain service account
Download the latest release of the SquaredUp agent zip file, by clicking the download icon under Options next to the agent you have just added.Prerequisites for agents
The agent needs to run on a Windows machine that has access to the entry point for the on-premises data source.
Make sure the agent is able to make outbound connections on port 443 to SquaredUp (api.squaredup.com / eu.api.squaredup.com, depending on your region), *.amazonaws.com and Microsoft Azure Relay (*.servicebus.windows.net) - this may include firewall rules and proxy server allow lists.
If a Proxy is required, set a system environment variable named ALL_PROXY with the location of the proxy server, as modern .Net applications do not use the proxy as shown in netsh.
The proxy server may be a hostname or IP address (optionally followed by a colon and port number) or it may be a http URL (optionally including a username and password for proxy authentication). A proxy URL must be started with http, not https, and cannot include any text after the hostname, IP, or port. If the agent is running as a service, you will need to restart it, and may need to restart the server itself in some cases in order to apply the environment variable.
For information about Relay Agent versions see Release Notes - Relay Agent
On a Windows machine, with access to the entry point your data source needs to use, extract the downloaded zip file.
In the folder of the extracted zip file, open PowerShell as an administrator and run the following command:Copy
./Install-SQUPAgent.ps1 -ApiKey "key" -AsService -ServiceSuffix "name" -ServiceAccount domain\username
Parameters to replace:
keywith the API key you created for the agent in SquaredUp
Recommended Run the agent as a service on the machine
Optional To change the default service name of squpagent replace
namewith your new service name.
Optional To run the agent as a domain service account (for example, for the SCOM data source), provide the username as
domain\usernameand it will prompt for the password when it sets up the service
Optional Specify a folder location for where the agent will be installed. If this is not specified then the agent will be installed in the folder where the zip file is extracted.
Consider restricting access to the folder where the agent is installed to prevent anyone from updating or viewing the configuration files.
Configure a domain service account using the installation script, for example:
./Install-SQUPAgent.ps1 -ApiKey "key" -AsService -ServiceAccount domain\username
keyis the API key, and
domain\usernameis the domain service account
Alternatively, in Services > SquaredUp Cloud Agent > Properties select the account on the Log On tab.
Use a dedicated user account for the agent's service identity. Create a special service account for this domain service account, do not use an existing user account.
The account (typically a service account) needs to have the log on as a service permission.
Adjust any permissions for the service and start the service.How to start the agent service
You can start the agent service from Services > SquaredUp Cloud Agent, or using PowerShell using either:
Start-Service -Name <ServiceName>
<ServiceName>should be replaced with the service name shown in brackets in the upgrade script output (or Properties of the service).
Start-Service -Name squpagent
Start-Service -DisplayName <DisplayName>
<DisplayName>should be replaced with the service name shown before the brackets in the upgrade script output (or Properties of the service).How to find the agent folder location or Service name in Properties
Look at the Properties of the SquaredUp Cloud Agent service:
On the server running the agent, open Services
Scroll down to the SquaredUp Cloud Agent in the list
Right-click on the SquaredUp Cloud Agent service and then Properties
Here you can see the Service name, Display name and Path to the agent folder.
You can also start or stop the service from here.
- Check the agent status in SquaredUp Settings > Relay
By default, the SquaredUp agent service uses the local system identity, but this can be changed to a domain service account if required, for example for the SCOM 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.
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.
Enter the URL of your Artifactory instance.
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.
Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.Restrict access to this data source
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:
Data source access levels
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.
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.
- User can change the data source configuration, ACL, and delete the data source.
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.
Click Test and add to validate the data source configuration.Testing outcomes
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 Artifactory 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.
Data streams are installed with this data source. You can also create a data stream using the AQL configurable data stream, see AQL Query.
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||This will use a state field from the tile to determine the monitoring status.|
This allows you to configure monitoring for yourself based on threshold levels you determine, for example, over 5 show as Error.
|script||Use your own custom script to determine the monitoring status. See Scripts.|
Select the column that contains the state information. This will use a state field from the tile to determine the monitoring status and convert it into one of 3 levels: Success, Warning or Error.
|frequency||How often (in minutes) you want the data to be checked for changes.|
Select which value to monitor:
Top - uses the latest data point, the top value
Sum - adds the data points
Mean - the average of all the data points
Count - a count of the number of data points
|Timeframe||The time period for which to aggregate data.|
|Column||The data column that will determine the threshold.|
|For example, for Pingdom you might set Error to greater than 700, and the status will show as red when the Average Response is greater than 700ms.|
|Frequency||How often (in minutes) you want the data to be checked for changes.|
The Storage Information data stream retrieves data about your Artifactory storage capacity, such as the total number of binaries and artifacts.
The on-premise 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.