Genozip telemetry service
(compression logs)
What is Telemetry?
​
If the Genozip Telemetry Service is enabled, then when a file is compressed with genozip, a tiny record containing aggregate statistics regarding the performance of our compression methods and associated metadata is uploaded and logged on the Genozip server.
​​​
Our log record is tiny, and contains only the aggregate compression method statistics and metadata as specified below.
​​​
We use these logs primarily to catch problems with the quality of the compression, as well as to identify specific combinations of sequencing technologies, base callers, aligners, variant callers, and study types in which Genozip is not doing as well as it should.
​​
We also use these logs to provide technical support to you in case of technical issues.
​​
How to enable or disable Telemetry?
​
if you have a paid license, you will be asked to choose during license activation whether or not you permit telemetry. If you do choose to do so, it will greatly help us improve Genozip for your specific use case. You can always switch telemetry on or off by re-activating using genozip --activate.
​​
If telemetry is disabled, you can still send telemetry for a single compression by using genozip --telemetry.
​
If you are using a Student or Evaluation license, telemetry is always enabled.
​​​
Data collected
​​
The structure of a telemetry record is illustrated by the table below (one record per file compressed). This structure may continue to evolve over time as Genozip develops.
​
The precise record sent to Genozip can be seen by using the genozip --telemetry=FILE. This causes the telemetry record to be dumped to telemetry.json in the current directory.
​
Data retention policy
​
Telemetry logs may be retained indefinitely, or may be deleted if no longer needed, if required to do so by law or regulations, or if requested to do so by the user. To request deletion or to receive a copy of the records submitted under your license, please email support@genozip.com.
​​​
Troubleshooting
​
If you received the following error when trying to compress:
​​
LICENSE ERROR: Failed to upload a telemetry record to the Genozip server
​
It is because you are using Genozip Student which requires telemetry, but sending the log record failed, probably because you do not have Internet connectivity or telemetry is blocked by your organization's firewall. If this issue persists, you might want to consider switching to Genozip Research which does not mandate telemetry.
​​​​​​
Questions? support@genozip.com
Field name | Example | Notes |
|---|---|---|
contexts | DIVRQUAL,QUAL,27.8%,NONE,27.8%,N/A,0.0%,0,0.0%,; NONREF,SEQUENCE,5.9%,NONE,5.9%,N/A,0.0%,0,0.0%,; QUAL,QUAL,5.3%,NONE,5.2%,N/A,0.0%,1,0.0%,; SQBITMAP,SEQUENCE,4.8%,NONE,4.2%,RANB,0.6%,2,0.0%,; Q5NAME,QNAME,4.4%,BSC,0.0%,LZMA,4.0%,3536,0.4%,; Q6NAME,QNAME,4.0%,BSC,0.0%,BSC,3.7%,2304,0.3%,; DOMQRUNS,QUAL,18.5%,NONE,18.5%,N/A,0.0%,3,0.0%,; Q4NAME,QNAME,3.7%,BSC,0.0%,ARTw,3.6%,936,0.1%,; P2NEXT,PNEXT,3.0%,BSC,0.0%,BSC,2.9%,822,0.1%,; XS:i,XS:i,2.4%,NONE,2.4%,N/A,0.0%,1,0.0%,; CIGAR,CIGAR,2.3%,BSC,0.6%,BSC,1.5%,853,0.1%,; AS:i,AS:i,1.5%,NONE,0.6%,ARTb,0.9%,9,0.0%,; TLEN,TLEN,1.2%,ARTB,0.2%,ARTB,1.0%,16,0.0%,; P0OS0,POS,1.1%,BZ2,0.0%,ARTW,1.1%,170,0.0%,; Q2NAME,QNAME,0.8%,ARTB,0.0%,RANB,0.8%,5,0.0%,; Q1NAME,QNAME,0.8%,NONE,0.8%,N/A,0.0%,0,0.0%,; Q3NAME,QNAME,0.7%,NONE,0.7%,N/A,0.0%,0,0.0%,; QNAME,QNAME,0.6%,ARTB,0.0%,RANB,0.6%,3,0.0%,; F0LAG0,FLAG,0.6%,ARTB,0.0%,ARTB,0.5%,26,0.0%,; | Aggregate statistics of contexts. For each context: its name, parent name, % of genozip file, codec of local data, % of genozip file of local data, codec and % of genozip file of b250 of b250 data, number of words in dictionary, % of genozip file of dictionary |
data_type | BAM | |
environment | OS=Windows_10.0.22000; cores=8; physical_GB=16; runtime=0h1'23"; dist=conda; n_files=3; remote=0.0.0.0; local=174.22.10.11; glibc=2.27; filesystem=NTFS | Compute environment, distribution, genozip runtime, and number of files compressed in this execution,local and remote IP addresses |
features (--make-reference) | VBs=2998 X 1.0 MB; num_contigs=24; num_bases=3145129148; | Features of the file |
features (BED) | columns=10;sorted; | Features of the file that affect compression. |
features (FASTA) | Nucleotide_bases;num_sequences=12311; | Features of the file that affect compression. |
features (FASTA) | VBs=196 X 16.0 MB; num_lines=12167; Nucleotide_bases; segconf.line_len=1649; | Features of the file that affect compression |
features (FASTQ) | VBs=531 X 16.0 MB;num_lines=46009532;Qname=Illumina-old/;segconf.line_len=194;segconf.longest_seq_len=76;Sequencer=Illumina;ref_nbases=2542341441;ref_ncontigs=25; | Features of the file that affect compression |
features (GENERIC) | VBs=1 X 16.0 MB; magic="MZ??????????????????????@???????" 4D.5A.90.00.03.00.00.00.04.00.00.00.FF.FF.00.00.B8.00.00.00.00.00.00.00.40.00.00.00.00.00.00.00; extension="exe"; segconf.line_len=0; | Features of the file that affect compression. "magic" is the first 32 bytes of the file; "extension" is the component of the filename following the final ".", but if it is 'gz', 'bz2', 'xz' or 'zip', the before-last component is included too. |
features (GFF) | num_fasta_sequences=1 | Features of the file that affect compression. |
features (SAM/BAM) | VBs=4 X 28.1 MB; num_lines=99909; hdr_contigs=86 (3137454505);
ref_contigs=298 (3235006512); Sorted; Mapper=dragen; Paired-End; sag_type=BY_SA; mate=49%; saggy_near=0%; prim_far=0.01%; Qname=Illumina; segconf.line_len=344; segconf.longest_seq_len=151;bisulfite; | Features of the file that affect compression |
features (VCF) | VBs=7 X 32.0 MB; num_lines=6907; num_samples=722; GVCF; segconf.line_len=20964; hdr_contigs=86 (3137454505);
ref_contigs=298 (3235006512) | Features of the file that affect compression |