Inheritance diagram for ztee.GZipLog:

Public Member Functions
def	__init__ (self, log_file)

def	finish (self)

def	flush_block (self)

def	handle_timeout (self)

def	try_flush (self)

def	write (self, bytes)

def	write_block (self, data)

Public Attributes
	block

	block_size

	block_size_max

	block_timeout

	file

	file_max_size

	file_min_size

	file_truncate_pos

	file_truncate_state

	last_flush

	zstream

Detailed Description

Definition at line 13 of file ztee.py.

Constructor & Destructor Documentation

◆ init()

def ztee.GZipLog.__init__	(	self,
		log_file
	)

Definition at line 14 of file ztee.py.

     def __init__(self, log_file):
         self.file = None
 
         self.last_flush = time.time()
         self.zstream = zlib.compressobj(6, zlib.DEFLATED, zlib.MAX_WBITS | 16)
 
         # 'gzip' block will be flushed if we reach max bytes or the timeout
         self.block = []
         self.block_size = 0
         self.block_size_max = 2*1024*1024 # bytes
         self.block_timeout = 15 # seconds
 
         self.file = open(log_file, "wb+")
         self.file_min_size = 2*1024*1024    # this amount of space we keep after truncating
         self.file_max_size = 16*1024*1024   # we truncate if file gets bigger
 
         self.file_truncate_pos = None
         self.file_truncate_state = None
 

Member Function Documentation

◆ finish()

def ztee.GZipLog.finish ( self )

Definition at line 70 of file ztee.py.

References fbuf.file, ztee.GZipLog.file, TkOfflineVariables.file, EcalRecHitsFilter.file, SiStripPlotGain.file, EcalBxOrbitNumberGrapher.file, SiStripCorrelateBadStripAndNoise.file, SiStripCorrelateNoise.file, EcalURecHitHists.file, GlobalTrackerMuonAlignment.file, EcalCosmicsHists.file, ztee.GZipLog.flush_block(), ztee.GZipLog.write(), ztee.GZipLog.zstream, and ztail.Decoder.zstream.

Referenced by progressbar.ProgressBar.__next__().

     def finish(self):
         self.flush_block()
         self.file.write(self.zstream.flush(zlib.Z_FINISH))
         self.file.close()
         self.file = None
 

◆ flush_block()

def ztee.GZipLog.flush_block ( self )

Definition at line 37 of file ztee.py.

References ztee.GZipLog.block, ztee.GZipLog.block_size, filterCSVwithJSON.copy, fbuf.file, ztee.GZipLog.file, TkOfflineVariables.file, EcalRecHitsFilter.file, SiStripPlotGain.file, EcalBxOrbitNumberGrapher.file, SiStripCorrelateBadStripAndNoise.file, SiStripCorrelateNoise.file, EcalURecHitHists.file, GlobalTrackerMuonAlignment.file, EcalCosmicsHists.file, ztee.GZipLog.file_max_size, ztee.GZipLog.file_min_size, ztee.GZipLog.file_truncate_pos, ztee.GZipLog.file_truncate_state, join(), ztee.GZipLog.last_flush, HLT_2024v14_cff.truncate, ztee.GZipLog.write_block(), ztee.GZipLog.zstream, and ztail.Decoder.zstream.

Referenced by ztee.GZipLog.finish(), and ztee.GZipLog.try_flush().

     def flush_block(self):
         self.last_flush = time.time()
 
         data, size, = "".join(self.block), self.block_size
         self.block, self.block_size = [], 0
 
         if size == 0:
             # nothing to do
             return
 
         # check if we need to truncate the file
         # 'size' refers to uncompressed data, so the file be truncated at max_size -+ max_block_size
         # there is no way know compressed size without collapsing the zlib state
         if (self.file.tell() + size) > self.file_max_size:
             if self.file_truncate_pos is not None:
                 # tell it to cleanup
                 self.zstream.flush(zlib.Z_FINISH)
 
                 self.file.seek(self.file_truncate_pos, 0)
                 self.file.truncate()
                 self.zstream = self.file_truncate_state.copy()
 
                 self.write_block("\n\n--- file was cut at this point ---\n\n")
 
         # write it
         self.write_block(data)
 
         # check if we can save the ptr into truncate_position
         if self.file_truncate_pos is None:
             if self.file.tell() >= self.file_min_size:
                 self.file_truncate_pos = self.file.tell()
                 self.file_truncate_state = self.zstream.copy()
 

◆ handle_timeout()

def ztee.GZipLog.handle_timeout ( self )

Definition at line 90 of file ztee.py.

References ztee.GZipLog.try_flush().

Referenced by esMonitoring.AsyncLineReaderTimeoutMixin.readable().

     def handle_timeout(self):
         self.try_flush()

◆ try_flush()

def ztee.GZipLog.try_flush ( self )

Definition at line 76 of file ztee.py.

References ztee.GZipLog.block_size, ztee.GZipLog.block_size_max, ztee.GZipLog.block_timeout, ztee.GZipLog.flush_block(), and ztee.GZipLog.last_flush.

Referenced by ztee.GZipLog.handle_timeout(), and ztee.GZipLog.write().

     def try_flush(self):
         timeout = (time.time() - self.last_flush) > self.block_timeout
         large_block = self.block_size > self.block_size_max
 
         if timeout or large_block:
             self.flush_block()
 

◆ write()

def ztee.GZipLog.write	(	self,
		bytes
	)

Definition at line 83 of file ztee.py.

References mps_setup.append, ztee.GZipLog.block, ztee.GZipLog.block_size, and ztee.GZipLog.try_flush().

Referenced by ztee.GZipLog.finish(), pkg.AbstractPkg.generate(), and ztee.GZipLog.write_block().

     def write(self, bytes):
         if bytes:
             self.block.append(bytes)
             self.block_size += len(bytes)
 
         self.try_flush()
 

◆ write_block()

def ztee.GZipLog.write_block	(	self,
		data
	)

Definition at line 33 of file ztee.py.

References fbuf.file, ztee.GZipLog.file, TkOfflineVariables.file, EcalRecHitsFilter.file, SiStripPlotGain.file, EcalBxOrbitNumberGrapher.file, SiStripCorrelateBadStripAndNoise.file, SiStripCorrelateNoise.file, EcalURecHitHists.file, GlobalTrackerMuonAlignment.file, EcalCosmicsHists.file, ztee.GZipLog.write(), ztee.GZipLog.zstream, and ztail.Decoder.zstream.

Referenced by ztee.GZipLog.flush_block().

     def write_block(self, data):
         self.file.write(self.zstream.compress( data.encode("utf-8") ))
         self.file.write(self.zstream.flush(zlib.Z_FULL_FLUSH))
 