Using Artifactory 6.x ?
JFrog Artifactory 6.x User Guide
Have a question? Want to report an issue? Contact JFrog support
Overview
Artifactory provides several facilities allowing you to maintain your system for optimal performance.
To configure your global system maintenance, in the Admin module select Advanced | Maintenance.
Artifactory SaaS Users
JFrog manages regular maintenance operations for all instances of Artifactory SaaS. If you are an Artifactory SaaS user, the features described on this page are all monitored and optimally managed for you by JFrog Artifactory SaaS administrators.
Garbage Collection
Artifactory uses checksum-based storage to ensure that each binary file is only stored once.
When a new file is deployed, Artifactory checks if a binary with the same checksum already exists and if so, links the repository path to this binary. Upon deletion of a repository path, Artifactory does not delete the binary since it may be used by other paths. However, once all paths pointing to a binary are deleted, the file is actually no longer being used. To make sure your system does not become clogged with unused binaries, Artifactory periodically runs a "Garbage Collection" to identify unused ("deleted") binaries and dispose of them from the datastore. By default, this is set to run every 4 hours and is controlled by a cron expression.
For example, to run garbage collection every 12 hours you should specify the following expression:
0 0 /12 * * ?
Cron Expression | Specifies the frequency in which garbage collection should be run automatically |
Next Run Time | Indicates the next automatic run of garbage collection according to the specified Cron Expression |
Run Now | Manually invokes garbage collection immediately |
Garbage collection frequency
Garbage collection is a resource intensive operation. Running it too frequently may compromise system performance.
Storage Quota Limits
Artifactory lets you set a limit on how much of your entire system disk space storage may be used to ensure that your server file system capacity is never used up. This helps to keep your system reliable and available.
Once disk space used for storage reaches the specified limit, any attempt to deploy a binary is rejected by Artifactory with a status code of 413 Request Entity Too Large and a "Datastore disk space is too high" error is displayed at the bottom of the Maintenance screen.
- When using filesystem storage, the partition checked is the one containing the
$ARTIFACTORY_HOME/data/filestore
directory. - When using database blob storage, the partition checked is the one containing the
$ARTIFACTORY_HOME/data/cache
directory.
- When using the S3 template, the cache-fs will be the checked partition, by default is the
$ARTIFACTORY_HOME/data/cache
directory.
To help you avoid reaching your disk space quota, Artifactory also allows you to specify a warning level. Once the specified percentage of disk space is used, Artifactory will log a warning in the $ARTIFACTORY_HOME/logs/artifactory.log
file and display a "Datastore disk space is too high" warning at the bottom of the Maintenance screen.
Enable Quota Control | When set, Artifactory will monitor disk space usage and issue warnings and errors according to the quotas specified in Storage Space Limit and Storage Space Warning |
Storage Space Limit | The percentage of available disk space that may be used for storage before Artifactory rejects deployments and issues errors |
Storage Space Warning | The percentage of available disk space that may be used for storage before Artifactory issues warnings |
Cleanup Unused Cached Artifacts
When configuring a remote repository, the Keep Unused Artifacts setting lets you specify how long a cached unused artifact from that repository should be kept before it is a candidate for cleanup. This setting does not immediately clean up the unused cached artifact, but merely marks it for clean up after the specified number of hours. The Cleanup Unused Cached Artifacts setting specifies when the cleanup operation should run, and only then unused, cached artifacts marked for cleanup are actually removed from the system.
The cleanup frequency is specified with a cron expression. For example, to run cleanup every 12 hours you should specify the following expression:
0 0 /12 * * ?
Cleanup Virtual Repositories
Virtual repositories use an internal cache to store aggregated metadata such as POM files. The Cleanup Virtual Repositories operation deletes cached POM files that are older than 168 hours (one week)
The cleanup frequency is specified with a cron expression. For example, to run cleanup every 12 hours you should specify the following expression:
0 0 /12 * * ?
Storage
Compress the Internal Database | Derby database only This feature is only relevant when using the internal Derby database A Derby database may typically contain unused allocated space when a large amount of data is deleted from a table or its indices are updated. By default, Derby does not return unused space to the operating system. For example, once a page has been allocated to a table or index, it is not automatically returned to the operating system until the table or index is destroyed. When you invoke this action, Artifactory reclaims unused and allocated space in a table and its indexes thereby compressing the internal database. We recommend running this when Artifactory activity is low, since compression may not be able to complete when storage is busy (in which case the storage will not be affected). |
Prune Unreferenced Data | Unreferenced binary files may occur due to running with wrong file system permissions on storage folders, or running out of storage space. When you invoke this action, Artifactory removes unreferenced binary files and empty folders present in the filestore or cache folders. Ensure complete shutdown To avoid such errors, we recommend that you always allow Artifactory to shut down completely |