f60dd38482
This adds a devstack-inspired output filter to standardise timestamping. Currently, python tools timestamp always (timestamp setup in logging_config.py) but all the surrounding bash does not. We have extra timestamps added in run_functests.sh for our own purposes to get the bash timestamps; but this ends up giving us double-timestamps for the python bits. Additionally, callers such as nodepool capture our output and put their own timestamps on it, and again have the double-timestamps. This uses a lightly modified outfilter.py from devstack to standardise this. All output is run through this filter, which will timestamp it. I have removed the places where we double-timestamp -- logging_config.py and the prefix in dib-run-parts. An env option is added to turn timestamps off completely (does not seem worth taking up a command-line option for). For callers like nodepool, they can set this and will just have their own timestamps as they collect the lines. Since all logging is going through outfilter, it's easy to add a --logfile option. I think this will be quite handy; personally I'm always redirecting dib runs to files for debugging. I've also added a "quiet" option. I think this could be useful in run_tests.sh if we were to start logging the output of each test to individual files. This would be much easier to deal with than the very large log files we get (especially if we wanted to turn on parallel running...) Change-Id: I202e1cb200bde17f6d7770cf1e2710bbf4cca64c
90 lines
2.9 KiB
Python
90 lines
2.9 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# 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.
|
|
|
|
# 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
|
|
# 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)')
|
|
|
|
|
|
def get_options():
|
|
parser = argparse.ArgumentParser(
|
|
description='Filter output by DevStack and friends')
|
|
parser.add_argument('-o', '--outfile',
|
|
help='Output file for content',
|
|
default=None)
|
|
parser.add_argument('-v', '--verbose', action='store_true',
|
|
help='Write to stdout',
|
|
default=False)
|
|
parser.add_argument('-b', '--no-timestamp', action='store_true',
|
|
help='Do not prefix stdout with timestamp (bare)',
|
|
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:
|
|
outfile = open(opts.outfile, 'ab', 0)
|
|
|
|
# Otherwise fileinput reprocess args as files
|
|
sys.argv = []
|
|
for line in iter(sys.stdin.readline, ''):
|
|
# put skip lines here
|
|
if skip_line(line):
|
|
continue
|
|
|
|
now = datetime.datetime.utcnow()
|
|
ts_line = ("%s | %s" % (
|
|
now.strftime("%Y-%m-%d %H:%M:%S.%f")[:-3],
|
|
line))
|
|
|
|
if opts.verbose:
|
|
sys.stdout.write(line if opts.no_timestamp else ts_line)
|
|
sys.stdout.flush()
|
|
if outfile:
|
|
# 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,):
|
|
outfile.write(ts_line)
|
|
else:
|
|
outfile.write(ts_line.encode('utf-8'))
|
|
outfile.flush()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
try:
|
|
sys.exit(main())
|
|
except KeyboardInterrupt:
|
|
sys.exit(1)
|