Tools and Utilities
Monitoring System Health
When DRAGEN runs, a daemon dragend is started that communcates with the FPGA card. This daemon will monitor FPGA temperature while DRAGEN is running and abort DRAGEN when the temperature exceeds a configured threshold.
To display the current temperature of the DRAGEN server FPGA, use the dragen_info -t command.
Logging
All hardware events are logged to /var/log/messages and /var/log/dragen_mond.log. The following shows an example in /var/log/messages of a temperature alarm:
By default, temperature is logged to /var/log/dragen_mond.log every hour:
If DRAGEN is executing when a thermal alarm is detected, the following is displayed in the terminal window of the DRAGEN process:
If you see this message, stop running the DRAGEN software. Do the following to alleviate the overheating condition on the card:
Be sure that there is ample air flow over the card. Consider moving the card to a slot where there is more air flow, adding another fan or increasing the fan speed.
Give the card more space in the box. If there are available PCIe slots, move the card so that it has empty slots on either side.
Contact Illumina Technical Support if you are having trouble resolving the thermal alarm on your system.
Hardware Alarms
The following table lists the hardware events logged by the monitor when an alarm is triggered:
| ID | Description | Monitor Action |
|---|---|---|
0 | Software overheating | Terminate usage until DRAGEN server FPGA cools to software minimum temperature. |
1 | Hardware overheating | Fatal. Aborts dragen software; system reboot required |
2 | Board SPD overheating | Logged as nonfatal |
3 | SODIMM overheating | Logged as nonfatal |
4 | Power 0 | Fatal. Aborts dragen software; system reboot required |
5 | Power 1 | Fatal. Aborts dragen software; system reboot required |
6 | DRAGEN server FPGA power | Logged as nonfatal |
7 | Fan 0 | Logged as nonfatal |
8 | Fan 1 | Logged as nonfatal |
9 | SE5338 | Fatal. Aborts dragen software; system reboot required |
10--30 | Undefined (Reserved) | Fatal. Aborts dragen software; system reboot required |
Fatal alarms prevent the DRAGEN host software from running and require a system reboot. When a software overheating alarm is triggered, the monitor looks for and aborts any running DRAGEN processes. The monitor continues to abort any new DRAGEN processes until the temperature decreases to the minimum threshold and the hardware clears the chip status alarm. When the software overheating alarm clears, DRAGEN jobs can resume executing.
Contact Illumina Technical Support with details from the log files if any of these alarms are triggered on your system.
Hardware-Accelerated Compression and Decompression
Gzip compression is ubiquitous in bioinformatics. FASTQ files are often gzipped, and the BAM format itself is a specialized version of gzip. For that reason, DRAGEN provides hardware support for accelerating compression and decompression of gzipped data. If your input files are gzipped, DRAGEN detects that and decompresses the files automatically. If your output is BAM files, then the files are automatically compressed.
DRAGEN provides standalone command-line utilities to enable you to compress or decompress arbitrary files. These utilities are analogous to the Linux gzip and gunzip commands, but are named dzip and dunzip (dragen zip and dragen unzip). Both utilities are able to accept as input a single file, and produce a single output file with the .gz file extension removed or added, as appropriate. For example:
Currently, dzip and dunzip have the following limitations and differences from gzip/gunzip:
Each invocation of these tools can handle only a single file. Additional file names (including those produced by a wildcard * character) are ignored.
They cannot be run at the same time as the DRAGEN host software.
They do not support the command line options found in gzip and gunzip (eg, --recursive, --fast, ‑‑best, ‑‑stdout).
Licensing and Usage
For a DRAGEN server, there are two tools provided during the install process to assist with licensing of the system.
dragen_lic - A command line tool which can be utilized to perform licensing actions by a user.
dragen_licd - A daemon running in the background which communicates once a day with an Illumina License Server to perform automated licensing actions.
Usage reporting is a key component of the DRAGEN Licensing infrastructure. When a license is installed, any unreported usage data will automatically be uploaded to Illumina's License server. Note that Communication to the Illumina server is secured by encryption over an HTTP connection. Usage data entails the following information for each individual run
run date
run duration
licensing quota consumed (number of bases) in that run
run status
software version used for the run.
dragen_lic command line tool
Used to perform licensing actions by a user via the command line. For versions lower than 4.3, this tool can be found at /opt/edico/bin/dragen_lic. For 4.3 and higher, it can be found at /usr/bin/dragen_lic
Common actions would be to view licensing information (expiration date and remaining quota) and installing licenses. Examples of these actions are shown below.
Viewing License Information
There are three options for viewing licesing information. Examples for each one are below.
Default Output (i.e. no additional arguments). This is the legacy method for retreiving license information, and prior to DRAGEN v4.3 this was the only method available. In general it is recommended to instead use one of the following two options.
Basic Output (i.e. using the -b flag). This is the recommended method to view license information by a human user as the output is simplified to be more readable.
JSON Output (i.e. using the -j flag). This is the recommended method to view license information by a machine user as the output is already in a machine readable format.
Basic mode (-b) will not show a license if it has been expired by more then 90 days.
Basic mode (-b) and JSON mode (-j) collapse the "DRAGEN Core" licenses into a single entry, as this is effectively how these licenses and bundled and sold.
Installing Licenses
To install licenses you must be running as a root user.
There are two options for installing licenses manually. Examples for each one are below.
Manual License File install (i.e. using the '-i <path to file>' argument). This can be used to install a license binary file (ending with the .bin extension).
Automatic License File install (i.e. using the '-i auto' argument). For DRAGEN servers which are connected to the internet, this will instruct the server to reach out to Illumina's License Server and download and automatically install the latest license file provided by Illumina. This is recommended method for installing a license.
dragen_licd background daemon
For DRAGEN servers which are connected to the internet, this background process self-activates daily to automatically retrieve and install the latest license files associated with this server from Illumina's License Server. As part of this process, any unreported usage data is also uploaded.
Last updated