mtail.py

   1 #!/usr/bin/env python
   2
   3 '''
   4 Does tail -f on log files in a given directory.
   5 The display is in chronological order of the logged lines,
   6 given that the first column of log files is timestamp.
   7 It can be altered to fit other formats too
   8 '''
   9
  10 import os, sys, time
  11 from optparse import OptionParser
  12
  13 class mtail:
  14
  15     subversion_id = "$Id$"
  16
  17     default_time_format = "%H:%M:%S"
  18
  19     def __init__ (self, args ):
  20
  21         # internal structure for tracking changes
  22         self.files = {}
  23         # parse command-line args : will set options and args
  24         self.parse_args(args)
  25         # initialize
  26         self.scan_files()
  27
  28     def parse_args (self, args):
  29         usage = """usage: %prog [options] file-or-dir ...
  30 example:
  31 # %prog -e '*access*' /var/log"""
  32         parser=OptionParser(usage=usage,version=self.subversion_id)
  33         # tail_period
  34         parser.add_option("-p","--period", type="int", dest="tail_period", default=1,
  35                           help="Files check period in seconds")
  36         # rescan_period
  37         parser.add_option("-d","--dir-period", type="int", dest="rescan_period", default=20,
  38                           help="Directories rescan period in seconds")
  39         # time format
  40         parser.add_option("-f","--format", dest="time_format", default=mtail.default_time_format,
  41                           help="Time format, defaults to " + mtail.default_time_format)
  42         # show time
  43         parser.add_option("-r","--raw", action="store_true", dest="show_time", default=True,
  44                           help="Suppresses time display")
  45
  46         # note for exclusion patterns
  47         parser.add_option("-e","--exclude", action="append", dest="excludes", default=[],
  48                           help="Exclusion pattern  -- can be specified multiple times applies on files not explicitly mentioned on the command-line")
  49
  50         parser.add_option("-u","--usual",action="store_true",dest="plc_mode",default=False,
  51                           help="Shortcut for watching /var/log with default settings")
  52
  53         # verbosity
  54         parser.add_option("-v","--verbose", action="store_true", dest="verbose", default=False,
  55                           help="Run in verbose mode")
  56
  57         (self.options, self.args) = parser.parse_args(args)
  58         self.optparse = parser
  59
  60         ### plc shortcuts
  61         if self.options.plc_mode:
  62             self.options.excludes.append('*access_log')
  63             self.options.excludes.append('*request_log')
  64             self.options.excludes.append('*.swp')
  65             self.args.append('/var/log')
  66
  67         if self.options.verbose:
  68             print 'Version:',self.subversion_id
  69             print 'Options:',self.options
  70             print 'Arguments:',self.args
  71
  72     def file_size (self,filename):
  73         return os.stat(filename)[6]
  74
  75     def number_files (self):
  76         return len(self.files)
  77
  78     # scans given arguments, and updates files accordingly
  79     # can be run several times
  80     def scan_files (self) :
  81
  82         if self.options.verbose:
  83             print 'entering scan_files, files=',self.files
  84
  85         # mark entries in files as pre-existing
  86         for key in self.files:
  87             self.files[key]['old-file']=True
  88
  89         # refreshes the proper set of filenames
  90         filenames = []
  91         for arg in self.args:
  92             if self.options.verbose:
  93                 print 'scan_files -- Considering arg',arg
  94             if os.path.isfile (arg):
  95                 filenames += [ arg ]
  96             elif os.path.isdir (arg) :
  97                 filenames += self.walk (arg)
  98             else:
  99                 print "mtail : no such file or directory %s -- ignored"%arg
 100
 101         # updates files
 102         for filename in filenames :
 103             # known file
 104             if self.files.has_key(filename):
 105                 size = self.file_size(filename)
 106                 offset = self.files[filename]['size']
 107                 if size > offset:
 108                     self.show_file_end(filename,offset,size)
 109                     self.files[filename]['size']=size
 110                 elif size < offset:
 111                     self.show_file_when_size_decreased(filename,offset,size)
 112                 try:
 113                     del self.files[filename]['old-file']
 114                 except:
 115                     pass
 116             else:
 117                 # enter file with current size
 118                 # if we didn't set format yet, it's because we are initializing
 119                 try:
 120                     self.format
 121                     self.show_now()
 122                     print self.format%filename,"new file"
 123                     self.show_file_end(filename,0,self.file_size(filename))
 124                 except:
 125                     pass
 126                 self.files[filename]={'size':self.file_size(filename)}
 127
 128         # cleanup
 129         # avoid side-effects on the current loop basis
 130         read_filenames = self.files.keys()
 131         for filename in read_filenames:
 132             if self.files[filename].has_key('old-file'):
 133                 self.show_now()
 134                 print self.format%filename,"file has gone"
 135                 del self.files[filename]
 136
 137         # compute margin and format
 138         if not filenames:
 139             print sys.argv[0],": WARNING : no file in scope"
 140             self.format="%s"
 141         else:
 142             if len(filenames)==1:
 143                 self.margin=len(filenames[0])
 144             else:
 145                 # this stupidly fails when there's only 1 file
 146                 self.margin=max(*[len(f) for f in filenames])
 147             self.format="%%%ds"%self.margin
 148             if self.options.verbose:
 149                 print 'Current set of files:',filenames
 150
 151     def tail_files (self):
 152
 153         if self.options.verbose:
 154             print 'tail_files'
 155         for filename in self.files:
 156             size = self.file_size(filename)
 157             offset = self.files[filename]['size']
 158             if size != offset:
 159                 self.show_file_end(filename,offset,size)
 160                 self.files[filename]['size']=size
 161
 162     def show_now (self):
 163         if self.options.show_time:
 164             label=time.strftime(self.options.time_format,time.localtime())
 165             print label,
 166
 167     def show_file_end (self, filename, offset, size):
 168         file = open(filename,"r")
 169         file.seek(offset)
 170         line=file.read(size-offset)
 171         self.show_now()
 172         print self.format%filename,'----------------------------------------'
 173         print line
 174         file.close()
 175
 176     def show_file_when_size_decreased (self, filename, offset, size):
 177         print self.format%filename,'---------- file size decreased ---------',
 178         if self.options.verbose:
 179             print 'size during last check',offset,'current size',size
 180         else:
 181             print ''
 182
 183     # get all files under a directory
 184     def walk ( self, root ):
 185         import fnmatch, os, string
 186
 187         # initialize
 188         result = []
 189
 190         # must have at least root folder
 191         try:
 192             names = os.listdir(root)
 193         except os.error:
 194             return result
 195
 196         # check each file
 197         for name in names:
 198             fullname = os.path.normpath(os.path.join(root, name))
 199
 200             # a file : check for excluded, otherwise append
 201             if os.path.isfile(fullname):
 202                 try:
 203                     for exclude in self.options.excludes:
 204                         if fnmatch.fnmatch(name, exclude):
 205                             raise Exception('excluded')
 206                     result.append(fullname)
 207                 except:
 208                     pass
 209             # a dir : let's recurse - avoid symlinks for anti-loop
 210             elif os.path.isdir(fullname) and not os.path.islink(fullname):
 211                 result = result + self.walk( fullname )
 212
 213         return result
 214
 215     def run (self):
 216
 217         if self.number_files() == 0:
 218             self.optparse.print_help()
 219             sys.exit(1)
 220         counter = 0
 221
 222         while 1:
 223             ## hit the period ?
 224             # dont do this twice at startup
 225             if (counter !=0 and counter % self.options.rescan_period == 0):
 226                 self.scan_files()
 227
 228             if (counter % self.options.tail_period == 0):
 229                 self.tail_files()
 230
 231             time.sleep(1)
 232             counter += 1
 233
 234 ###
 235 if __name__ == '__main__':
 236     mtail (sys.argv[1:]).run()