1Logstalgia(1) General Commands Manual Logstalgia(1)
2
3
4
6 Logstalgia - a web server access log visualization tool
7
9 logstalgia [-f] [-WIDTHxHEIGHT] [options] logfile
10
12 logstalgia is a visualization tool that replays or streams web server
13 access logs as a retro arcade game simulation.
14
16 logstalgia's display is rendered using OpenGL and requires a 3D accel‐
17 erated video card to run.
18
19 Currently logstalgia supports several access.log formats used by Apache
20 web servers (common/custom format).
21
22 As logstalgia is designed to playback logs in real time you will need a
23 log from a fairly busy webserver to achieve interesting results (eg
24 100s of requests each minute).
25
27 -f Fullscreen.
28
29 -WIDTHxHEIGHT
30 Set the window size. If -f is also supplied, will attempt to set
31 the video mode to this also.
32
33 -b, --background
34 Background colour in hex.
35
36 -x --full-hostnames
37 Show full request ip/hostname.
38
39 -s, --speed
40 Simulation speed. Defaults to 1 (1 second-per-second).
41
42 -u, --update-rate
43 Page Summary update speed. Defaults to 5 (5 seconds).
44
45 -g name,regex,percent[,colour]
46 Urls matching the given regex will appear under a new section
47 with the given name using the given percentage of the screen.
48 Colour may optionally be supplied in the common hexadecimal for‐
49 mat (eg FF0000 for red)
50
51 If no groups are supplied the default groups are Images (image
52 files), CSS (.css files) and Scripts (.js files).
53
54 If there is enough space remaining a catch-all group of Misc
55 will appear as the last group.
56
57 --paddle-mode MODE
58 Paddle mode (pid, vhost, single).
59
60 vhost - separate paddle for each virtual host in the log file.
61
62 pid - separate paddle for each process id in the log file.
63
64 single - single paddle (the default).
65
66 --paddle-position POSITION
67 Paddle position as a fraction of the view width (0.25 - 0.75).
68
69 --sync Read from STDIN, ignoring entries before the current time.
70
71 --start-position POSITION
72 Begin at some position in the log file (between 0.0 and 1.0).
73
74 --stop-position POSITION
75 Stop at some position.
76
77 --no-bounce
78 No bouncing.
79
80 --hide-response-code
81 Hide response code.
82
83 --hide-paddle
84 Hide paddle.
85
86 --hide-url-prefix
87 Hide URL protocol and hostname prefix of requests.
88
89 --disable-progress
90 Disable the progress bar.
91
92 --disable-glow
93 Disable the glow effect.
94
95 --font-size SIZE
96 Font size.
97
98 --glow-duration
99 Duration of the glow (between 0.0 and 1.0).
100
101 --glow-multiplier
102 Adjust the amount of glow.
103
104 --glow-intensity
105 Intensity of the glow.
106
107 --output-ppm-stream FILE
108 Write frames as PPM to a file ('-' for STDOUT).
109
110 --output-framerate FPS
111 Framerate of output (used with --output-ppm-stream).
112
113 logfile
114 The path to the access log file to read or '-' if you wish to
115 supply log entries via STDIN.
116
117
119 Watch an example Apache access.log using the default settings:
120
121 logstalgia /usr/share/logstalgia/example.log
122
123 Watch the live Apache access.log, starting from the most recent batch
124 of entries in the log (requires tail). Note than '-' at the end is
125 required for logstalgia to know it needs to read from STDIN:
126
127 tail -f /var/log/apache2/access.log | logstalgia -
128
129 To follow the log in real time, use the --sync option. This will start
130 reading from the next entry received on STDIN:
131
132 tail -f /var/log/apache2/access.log | logstalgia --sync
133
134 Watch a remote Apache access.log via ssh:
135
136 ssh user@example.com tail -f /var/log/apache2/access.log | logstal‐
137 gia --sync
138
139
141 Logstalgia supports the following widely used Apache log formats:
142
143 Common Log Format (CLF)
144 "%h %l %u %t \"%r\" %>s %b"
145
146 Common Log Format with Virtual Host
147 "%v %h %l %u %t \"%r\" %>s %b"
148
149 NCSA extended/combined log format
150 "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
151
152 NCSA extended/combined log format with Virtual Host
153 "%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-
154 agent}i\""
155
156 The process id (%P), or some other identifier, may be included as an
157 additional field at the end of the entry. This can be used with '--pad‐
158 dle-mode pid' where a separate paddle will be created for each unique
159 value in this field.
160
161
163 Logstalgia now supports a pipe ('|') delimited custom log file format:
164
165 timestamp - unix timestamp of the request date.
166 hostname - hostname of the request
167 path - path requested
168 response_code - the response code from the webserver (eg 200)
169 response_size - the size of the response in bytes
170
171 The following are optional:
172
173 success - 1 or 0 to indicate if successful
174 response_colour - response colour in hexidecial (#FFFFFF) format
175 referrer url - the referrer url
176 user agent - the user agent
177 virtual host - the virtual host (to use with --paddle-mode vhost)
178 pid - process id or some other identifier (--paddle-mode
179 pid)
180
181 If success or response_colour are not provided, they will be derived
182 from the response_code using the normal HTTP conventions (code < 400 =
183 success).
184
185
187 See the guide on the homepage for examples of recording videos with
188 Logstalgia:
189
190 http://code.google.com/p/logstalgia/wiki/Videos
191
192
194 The time shown in the top left of the screen is set initially from the
195 first log entry read and is incremented according to the simulation
196 speed (-s).
197
198 The counter in the bottom right hand corner shows the number of
199 requests displayed since the start of the current session.
200
201 Pressing space at any time will pause/unpause the simulation. While
202 paused you may use the mouse to inspect the detail of individual
203 requests.
204
205 Interactive keyboard commands:
206
207 (q) Debug Information
208 (c) Displays Logstalgia logo
209 (n) Jump forward in time to next log entry.
210 (+-) Adjust simulation speed.
211 (<>) Adjust time scale.
212 (ESC) Quit
213
215 Written by Andrew Caudwell
216
217 Project Homepage: http://code.google.com/p/logstalgia/
218
220 Copyright (C) 2008 Andrew Caudwell (acaudwell@gmail.com)
221
222 This program is free software; you can redistribute it and/or
223 modify it under the terms of the GNU General Public License
224 as published by the Free Software Foundation; either version
225 3 of the License, or (at your option) any later version.
226
227 This program is distributed in the hope that it will be useful,
228 but WITHOUT ANY WARRANTY; without even the implied warranty of
229 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
230 GNU General Public License for more details.
231
232 You should have received a copy of the GNU General Public License
233 along with this program. If not, see <http://www.gnu.org/licenses/>.
234
236 Catalyst IT (catalyst.net.nz)
237
238 For supporting the development and promotion of Logstalgia!
239
240
241
242 Logstalgia(1)