Hiprofile version 1.0
[hiprofile] / README
1 hiprofile - HTML Interactive profiler
2
3 Copyright 2009 Jeremy Kerr <jk@ozlabs.org>
4
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
18 ---
19
20 The hiprofile script provides an easy way to generate a report of an
21 oprofile session run on a remote machine. A typical session would be:
22
23 # on the machine to be profiled:
24 $ sudo opcontrol --setup --vmlinux=/boot/vmlinux-$(uname -r)
25 $ sudo opcontrol --start
26   {run application to profile}
27 $ sudo opcontrol --stop
28 $ sudo opcontrol --dump
29
30 # on your workstation machine:
31 $ hiprofile --remote-host <profile-machine> --outdir output
32
33 This will create a set of HTML pages (plus additional media) in the directory
34 'output'. Just point your browser to the index.html file in that directory
35 to see the profile data.
36
37 ---
38
39 hiprofile incorporates the 'jQuery' javascript library, licenced under the
40 GPL, and available from http://jquery.com/