Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: b5f6f2c6b8
Fetching contributors…

Cannot retrieve contributors at this time

executable file 386 lines (355 sloc) 15.52 kb
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright 2011 Liftoff Software Corporation
# Meta
__version__ = '1.0'
__license__ = "AGPLv3 or Proprietary (see LICENSE.txt)"
__version_info__ = (1, 0)
__author__ = 'Dan McDougall <>'
# Import stdlib stuff
import os, sys, re, gzip, fcntl, termios, struct
from time import sleep
from datetime import datetime
from optparse import OptionParser
# Import our own stuff
from utils import raw
from gateone import PLUGINS
# 3rd party imports
from tornado.escape import json_encode, json_decode
__doc__ = """\
.. _log_viewer:
Log Viewer
Allows the user to play back a given log file like a video (default) or display
it in a syslog-like format. To view usage information, run it with the --help
.. ansi-block::
\x1b[1;31mroot\x1b[0m@host\x1b[1;34m:/opt/gateone $\x1b[0m ./ --help
Usage: [options] <log file>
  --version show program's version number and exit
  -h, --help show this help message and exit
  -f, --flat Display the log line-by-line in a syslog-like format.
  -p, --playback Play back the log in a video-like fashion. This is the
default view.
  --pretty Preserve font and character renditions when displaying the
log in flat view (default).
  --raw Display control characters and escape sequences when
Here's an example of how to display a Gate One log (.golog) in a flat, greppable
.. ansi-block::
\x1b[1;31mroot\x1b[0m@host\x1b[1;34m:/opt/gateone $\x1b[0m ./ --flat
Sep 09 21:07:14 Host/IP or SSH URL [localhost]: modern-host
Sep 09 21:07:16 Port [22]:
Sep 09 21:07:16 User: bsmith
Sep 09 21:07:17 Connecting to: ssh://bsmith@modern-host:22
Sep 09 21:07:17
Sep 09 21:07:17 bsmith@modern-host's password:
Sep 09 21:07:20 Welcome to Ubuntu 11.04 (GNU/Linux 2.6.38-11-generic x86_64)
Sep 09 21:07:20
Sep 09 21:07:20 * Documentation:
Sep 09 21:07:20
Sep 09 21:07:20 Last login: Thu Sep 29 08:51:27 2011 from portarisk
Sep 09 21:07:20 \x1b[1;34mbsmith\x1b[0m@modern-host\x1b[1;34m:~ $\x1b[0m ls
Sep 09 21:07:21 why_I_love_gate_one.txt  to_dont_list.txt
Sep 09 21:07:21 \x1b[1;34mbsmith\x1b[0m@modern-host\x1b[1;34m:~ $\x1b[0m
About Gate One's Log Format
Gate One's log format (.golog) is a gzip-compressed unicode (UTF-8) text file
consisting of time-based frames separated by the unicode character, U+F0F0F0.
Each frame consists of JavaScript-style timestamp (because it is compact)
followed by a colon and then the text characters of the frame. A frame ends
when a U+F0F0F0 character is encountered.
Here are two example .golog frames demonstrating the format::
1317344834868:\\x1b[H\\x1b[2JHost/IP or SSH URL [localhost]: <U+F0F0F>1317344836086:\\r\\nPort [22]: <U+F0F0F>
Gate One logs can be opened, decoded, and parsed in Python fairly easily::
import gzip
golog =
for frame in golog.split(u"\U000f0f0f".encode('UTF-8')):
frame_time = float(frame[:13]) # First 13 chars is the timestamp
# Timestames can be converted into datetime objects very simply:
datetime_obj = datetime.fromtimestamp(frame_time/1000)
frame_text = frame[14:] # This gets you the actual text minus the colon
# Do something with the datetime_obj and the frame_text
.. note:: U+F0F0F0 is from Private Use Area (PUA) 15 in the Unicode Character Set (UCS). It was chosen at random (mostly =) from PUA-15 because it is highly unlikely to be used in an actual terminal program where it could corrupt a session log.
Class Docstrings
# Globals
SEPARATOR = u"\U000f0f0f" # The character used to separate frames in the log
RE_OPT_SEQ = re.compile(r'\x1b\]_\;(.+?)(\x07|\x1b\\)', re.MULTILINE)
RE_TITLE_SEQ = re.compile(
r'.*\x1b\][0-2]\;(.+?)(\x07|\x1b\\)', re.DOTALL|re.MULTILINE)
# TODO: Support Fast forward/rewind/pause like Gate One itself.
def get_frames(golog_path, chunk_size=131072):
A generator that iterates over the frames in a .golog file, returning them
as strings.
encoded_separator = SEPARATOR.encode('UTF-8')
golog =
frame = ""
while True:
chunk =
frame += chunk
if encoded_separator in chunk:
split_frames = frame.split(encoded_separator)
next_frame = split_frames[-1]
for fr in split_frames[:-1]:
yield fr
frame = next_frame
if len(chunk) < chunk_size:
# Write last frame
if frame:
yield frame
def playback_log(log_path, file_like, show_esc=False):
Plays back the log file at *log_path* by way of timely output to *file_like*
which is expected to be any file-like object with write() and flush()
If *show_esc* is True, escape sequences and control characters will be
escaped so they can be seen in the output. There will also be no delay
between the output of frames (under the assumption that if you want to see
the raw log you want it to output all at once so you can pipe it into
some other app).
prev_frame_time = None
for count, frame in enumerate(get_frames(log_path)):
frame_time = float(frame[:13]) # First 13 chars is the timestamp
frame = frame[14:] # [14:] Skips the timestamp and the colon
if count == 0:
# Write it out immediately
if show_esc:
frame = raw(frame)
prev_frame_time = frame_time
if show_esc:
frame = raw(frame)
# Wait until the time between the previous frame and now
# has passed
wait_time = (frame_time - prev_frame_time)/1000.0
sleep(wait_time) # frame times are in milliseconds
prev_frame_time = frame_time
except IOError: # Something wrong with the file
def escape_escape_seq(text, preserve_renditions=True, rstrip=True):
Escapes escape sequences so they don't muck with the terminal viewing *text*
Also replaces special characters with unicode symbol equivalents (e.g. so
you can see what they are without having them do anything to your running
If *preserve_renditions* is True, CSI escape sequences for renditions will
be preserved as-is (e.g. font color, background, etc).
If *rstrip* is true, trailing escape sequences and whitespace will be
esc_sequence = re.compile(
r'\x1b(.*\x1b\\|[ABCDEFGHIJKLMNOQRSTUVWXYZa-z0-9=]|[()# %*+].)')
csi_sequence = re.compile(r'\x1B\[([?A-Za-z0-9;@:\!]*)([A-Za-z@_])')
#esc_rstrip = re.compile('[ \t]+\x1b.+$')
out = u""
esc_buffer = u""
# If this seems confusing it is because text parsing is a black art! ARRR!
for char in text:
if not esc_buffer:
if char == u'\x1b': # Start of an ESC sequence
esc_buffer = char
# TODO: Determine if we should bring this back:
#elif ord(char) in replacement_map:
#out += replacement_map[ord(char)]
else: # Vanilla char. Booooring.
out += raw(char)
else: # Something interesting is going on
esc_buffer += char
if char == u'\x07' or esc_buffer.endswith(u'\x1b\\'): # Likely title
esc_buffer = u'' # Nobody wants to see your naked ESC sequence
elif esc_buffer.endswith('\x1b\\'):
esc_buffer = u'' # Ignore
# Nobody wants to see plain ESC sequences in the buf...
match_obj = esc_sequence.match(esc_buffer)
if match_obj:
seq_type =
esc_buffer = u'' # Just when you thought you've ESC'd...
# CSI ESC sequences... These are worth a second look
match_obj = csi_sequence.match(esc_buffer)
if match_obj:
csi_type =
if csi_type == 'm' and preserve_renditions: # mmmmmm!
out += esc_buffer # Ooh, naked viewing of pretty things!
esc_buffer = u'' # Make room for more!
if rstrip:
# Remove trailing whitespace + trailing ESC sequences
return out.rstrip()
else: # All these trailers better make for a good movie
return out
def flatten_log(log_path, file_like, preserve_renditions=True, show_esc=False):
Given a log file at *log_path*, write a string of log lines contained
within to *file_like*. Where *file_like* is expected to be any file-like
object with write() and flush() methods.
If *preserve_renditions* is True, CSI escape sequences for renditions will
be preserved as-is (e.g. font color, background, etc). This is to make the
output appear as close to how it was originally displayed as possible.
Besides that, it looks really nice =)
If *show_esc* is True, escape sequences and control characters will be
visible in the output. Trailing whitespace and escape sequences will not be
NOTE: Converts our standard recording-based log format into something that
can be used with grep and similar search/filter tools.
import gzip
encoded_separator = SEPARATOR.encode('UTF-8')
out_line = ""
cr = False
# We skip the first frame, [1:] because it holds the recording metadata
for count, frame in enumerate(get_frames(log_path)):
if count == 0:
# Skip the first frame (it's just JSON-encoded metadata)
frame = frame.decode('UTF-8', 'ignore')
frame_time = float(frame[:13]) # First 13 chars is the timestamp
# Convert to datetime object
frame_time = datetime.fromtimestamp(frame_time/1000)
if show_esc:
frame_time = frame_time.strftime(u'\x1b[0m%b %m %H:%M:%S')
else: # Renditions preserved == I want pretty. Make the date bold:
frame_time = frame_time.strftime(
u'\x1b[0;1m%b %m %H:%M:%S\x1b[m')
for char in frame[14:]:
if '\x1b[H\x1b[2J' in out_line: # Clear screen sequence
# Handle the clear screen (usually ctrl-l) by outputting
# a new log entry line to avoid confusion regarding what
# happened at this time.
out_line += "^L" # Clear screen is a ctrl-l or equivalent
if show_esc:
adjusted = raw(out_line)
adjusted = escape_escape_seq(out_line, rstrip=True)
file_like.write(frame_time + ' %s\n' % adjusted)
out_line = ""
if char == u'\n':
if show_esc:
adjusted = raw(out_line)
adjusted = escape_escape_seq(out_line, rstrip=True)
file_like.write(frame_time + ' %s\n' % adjusted)
out_line = ""
cr = False
elif char == u'\r':
# Carriage returns need special handling. Make a note of it
cr = True
# \r without \n means that characters were (likely)
# overwritten. This usually happens when the user gets to
# the end of the line (which would create a newline in the
# terminal but not necessarily the log), erases their
# current line (e.g. ctrl-u), or an escape sequence modified
# the line in-place. To clearly indicate what happened we
# insert a '^M' and start a new line so as to avoid
# confusion over these events.
if cr:
out_line += "^M"
file_like.write(frame_time + ' ')
if show_esc:
adjusted = raw(out_line)
adjusted = escape_escape_seq(out_line, rstrip=True)
file_like.write(adjusted + '\n')
out_line = ""
out_line += char
cr = False
def get_terminal_size():
Returns the size of the current terminal in the form of (rows, cols).
env = os.environ
def ioctl_GWINSZ(fd):
cr = struct.unpack('hh', fcntl.ioctl(fd, termios.TIOCGWINSZ,
return None
return cr
cr = ioctl_GWINSZ(0) or ioctl_GWINSZ(1) or ioctl_GWINSZ(2)
if not cr:
fd =, os.O_RDONLY)
cr = ioctl_GWINSZ(fd)
if not cr:
cr = (env['LINES'], env['COLUMNS'])
cr = (25, 80)
return int(cr[0]), int(cr[1])
if __name__ == "__main__":
"""Parse command line arguments and view the log in the specified format."""
usage = ('\t%prog [options] <log file>')
parser = OptionParser(usage=usage, version=__version__)
parser.add_option("-f", "--flat",
help="Display the log line-by-line in a syslog-like format."
parser.add_option("-p", "--playback",
help=("Play back the log in a video-like fashion. This is the default "
help=("Preserve font and character renditions when displaying the log "
"in flat view (default).")
help="Display control characters and escape sequences when viewing."
(options, args) = parser.parse_args()
if len(args) < 1:
print("ERROR: You must specify a log file to view.")
log_path = args[0]
if not os.path.exists(log_path):
print("ERROR: %s does not exist" % log_path)
if options.flat:
result = flatten_log(
preserve_renditions=options.pretty, show_esc=options.raw)
playback_log(log_path, sys.stdout, show_esc=options.raw)
except KeyboardInterrupt:
# Move the cursor to the bottom of the screen to ensure it isn't in the
# middle of the log playback output
rows, cols = get_terminal_size()
print("\x1b[%s;0H\n" % rows)
Jump to Line
Something went wrong with that request. Please try again.