tools/outfilter.py
21a10d34
 #!/usr/bin/env python3
 
62cb563d
 # Copyright 2014 Hewlett-Packard Development Company, L.P.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may
 # not use this file except in compliance with the License. You may obtain
 # a copy of the License at
 #
 #      http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
 
dc97cb71
 # This is an output filter to filter and timestamp the logs from Grenade and
 # DevStack. Largely our awk filters got beyond the complexity level which were
62cb563d
 # sustainable, so this provides us much more control in a single place.
 #
 # The overhead of running python should be less than execing `date` a million
 # times during a run.
 
 import argparse
 import datetime
 import re
 import sys
 
 IGNORE_LINES = re.compile('(set \+o|xtrace)')
 HAS_DATE = re.compile('^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{3} \|')
 
 
 def get_options():
     parser = argparse.ArgumentParser(
dc97cb71
         description='Filter output by DevStack and friends')
62cb563d
     parser.add_argument('-o', '--outfile',
                         help='Output file for content',
                         default=None)
83ecb97f
     # NOTE(ianw): This is intended for the case where your stdout is
     # being captured by something like ansible which independently
     # logs timestamps on the lines it receives.  Note that if using a
     # output file, those log lines are still timestamped.
     parser.add_argument('-b', '--no-timestamp', action='store_true',
                         help='Do not prefix stdout with timestamp (bare)',
                         default=False)
62cb563d
     parser.add_argument('-v', '--verbose', action='store_true',
                         default=False)
     return parser.parse_args()
 
 
 def skip_line(line):
     """Should we skip this line."""
     return IGNORE_LINES.search(line) is not None
 
 
 def main():
     opts = get_options()
     outfile = None
     if opts.outfile:
e033e1b8
         # note, binary mode so we can do unbuffered output.
         outfile = open(opts.outfile, 'ab', 0)
62cb563d
 
dc97cb71
     # Otherwise fileinput reprocess args as files
62cb563d
     sys.argv = []
 
e033e1b8
     for line in iter(sys.stdin.readline, ''):
62cb563d
         # put skip lines here
         if skip_line(line):
             continue
 
83ecb97f
         # This prevents us from nesting date lines, because we'd like
         # to pull this in directly in Grenade and not double up on
         # DevStack lines.
         # NOTE(ianw): we could actually strip the extra ts in "bare"
         # mode (which came after this)? ... as we get more experience
         # with zuulv3 native jobs and ansible capture it may become
         # clearer what to do
62cb563d
         if HAS_DATE.search(line) is None:
             now = datetime.datetime.utcnow()
83ecb97f
             ts_line = ("%s | %s" % (
62cb563d
                 now.strftime("%Y-%m-%d %H:%M:%S.%f")[:-3],
                 line))
83ecb97f
         else:
             ts_line = line
62cb563d
 
         if opts.verbose:
83ecb97f
             sys.stdout.write(line if opts.no_timestamp else ts_line)
62cb563d
             sys.stdout.flush()
e033e1b8
 
62cb563d
         if outfile:
e033e1b8
             # We've opened outfile as a binary file to get the
             # non-buffered behaviour.  on python3, sys.stdin was
             # opened with the system encoding and made the line into
             # utf-8, so write the logfile out in utf-8 bytes.
             if sys.version_info < (3,):
83ecb97f
                 outfile.write(ts_line)
e033e1b8
             else:
83ecb97f
                 outfile.write(ts_line.encode('utf-8'))
62cb563d
             outfile.flush()
 
 
 if __name__ == '__main__':
     try:
         sys.exit(main())
     except KeyboardInterrupt:
         sys.exit(1)