This documentation is unreleased and still in development. It may describe features which are not yet released in DSpace.
Looking for another version? See all documentation
Checksum Checker is program that can run to verify the checksum of every item within DSpace. Checksum Checker was designed with the idea that most System Administrators will run it from the cron. Depending on the size of the repository choose the options wisely.
Arguments short and (long) forms):
Loop continuously through the bitstreams
Specify a handle to check
Space separated list of bitstream IDs
Calls online help
Loop once through bitstreams
Prune old results (optionally using specified properties file for configuration
Report all processing
There are three aspects of the Checksum Checker's operation that can be configured:
- the execution mode
- the logging output
- the policy for removing old checksum results from the database
The user should refer to Chapter 5. Configuration for specific configuration beys in the dspace.cfg file.
Checker Execution Mode
Execution mode can be configured using command line options. Information on the options are found in the previous table above. The different modes are described below.
Unless a particular bitstream or handle is specified, the Checksum Checker will always check bitstreams in order of the least recently checked bitstream. (Note that this means that the most recently ingested bitstreams will be the last ones checked by the Checksum Checker.)
Available command line options
- Limited-count mode:
[dspace]/bin/dspace checker -cTo check a specific number of bitstreams. The -c option if followed by an integer, the number of bitstreams to check. Example:
[dspace/bin/dspace checker -c 10This is particularly useful for checking that the checker is executing properly. The Checksum Checker's default execution mode is to check a single bitstream, as if the option was -c 1
[dspace]/bin/dspace checker -dTo run the Check for a specific period of time with a time argument. You may use any of the time arguments below: Example:
[dspace/bin/dspace checker -d 2h(Checker will run for 2 hours)
The checker will keep starting new bitstream checks for the specific durations, so actual execution duration will be slightly longer than the specified duration. Bear this in mind when scheduling checks.
- Specific Bitstream mode:
[dspace]/bin/dspace checker -bChecker will only look at the internal bitstream IDs. Example:
[dspace]/bin/dspace checker -b 112 113 4567Checker will only check bitstream IDs 112, 113 and 4567.
- Specific Handle mode:
[dspace]/bin/dspace checker -aChecker will only check bitstreams within the Community, Community or the item itself. Example:
[dspace]/bin/dspace checker -a 123456/999Checker will only check this handle. If it is a Collection or Community, it will run through the entire Collection or Community.
- Looping mode:
[dspace]/bin/dspace checker -lor
[dspace]/bin/dspace checker -LThere are two modes. The lowercase 'el' (-l) specifies to check every bitstream in the repository once. This is recommended for smaller repositories who are able to loop through all their content in just a few hours maximum. An uppercase 'L' (-L) specifies to continuously loops through the repository. This is not recommended for most repository systems. Cron Jobs. For large repositories that cannot be completely checked in a couple of hours, we recommend the -d option in cron.
- Pruning mode:
[dspace]/bin/dspace checker -pThe Checksum Checker will store the result of every check in the checksum_history table. By default, successful checksum matches that are eight weeks old or older will be deleted when the -p option is used. (Unsuccessful ones will be retained indefinitely). Without this option, the retention settings are ignored and the database table may grow rather large!
Checker Results Pruning
As stated above in "Pruning mode", the checksum_history table can get rather large, and that running the checker with the -p assists in the size of the checksum_history being kept manageable. The amount of time for which results are retained in the checksum_history table can be modified by one of two methods:
- Editing the retention policies in
[dspace]/config/dspace.cfgSee Chapter 5 Configuration for the property keys. OR
Pass in a properties file containing retention policies when using the -p option.To do this, create a file with the following two property keys:
You can use the table above for your time units. At the command line:
[dspace]/bin/dspace checker -p retention_file_name <ENTER>
Checksum Checker uses log4j to report its results. By default it will report to a log called
[dspace]/log/checker.log, and it will report only on bitstreams for which the newly calculated checksum does not match the stored checksum. To report on all bitstreams checked regardless of outcome, use the -v (verbose) command line option:
[dspace]/bin/dspace checker -l -v (This will loop through the repository once and report in detail about every bitstream checked.
To change the location of the log, or to modify the prefix used on each line of output, edit the
[dspace]/config/templates/log4j.properties file and run
Cron or Automatic Execution of Checksum Checker
You should schedule the Checksum Checker to run automatically, based on how frequently you backup your DSpace instance (and how long you keep those backups). The size of your repository is also a factor. For very large repositories, you may need to schedule it to run for an hour (e.g.
-d 1h option) each evening to ensure it makes it through your entire repository within a week or so. Smaller repositories can likely get by with just running it weekly.
Unix, Linux, or MAC OS. You can schedule it by adding a cron entry similar to the following to the crontab for the user who installed DSpace:
The above cron entry would schedule the checker to run the checker every Sunday at 400 (4:00 a.m.) for 2 hours. It also specifies to 'prune' the database based on the retention settings in dspace.cfg.
Windows OS. You will be unable to use the checker shell script. Instead, you should use Windows Schedule Tasks to schedule the following command to run at the appropriate times:
(This command should appear on a single line).
Automated Checksum Checkers' Results
Optionally, you may choose to receive automated emails listing the Checksum Checkers' results to the email address specified in the
mail.admin configuration property. Schedule it to run after the Checksum Checker has completed its processing (otherwise the email may not contain all the results). As of DSpace 4.1, an email is only generated if the selected report contains at least one bitstream needing attention.
Arguments short and (long) forms):
Send all the results (everything specified below)
Send E-mail report for all bitstreams set as deleted for today.
Send E-mail report for all bitstreams not found in assetstore for today.
Send E-mail report for all bitstreams where checksum has been changed for today.
Send the Unchecked bitstream report.
Send E-mail report for all bitstreams set to longer be processed for today.
You can also combine options (e.g.
-m -c) for combined reports.
Cron. Follow the same steps above as you would running checker in cron. Change the time but match the regularity. Remember to schedule this after Checksum Checker has run. For an example cron setup, see Scheduled Tasks via Cron.
A query like the following can be used to check the results of the checker (Postgres):
Example of a more detailed query: