----------------------------------------------------------------------------
perfkit - performance recording toolkit
----------------------------------------------------------------------------
I. Introduction
II. Installation and Running
III. Contributing
Please use http://bugzilla.perfkit.org/ to file bugs.
----------------------------------------------------------------------------
0. TL;DR
----------------------------------------------------------------------------
./configure --enable-silent-rules --enable-debug=minimum
make
cd perfkit-agent && make run
cd perfkit-profiler && make run
----------------------------------------------------------------------------
I. Introduction
----------------------------------------------------------------------------
Perfkit is a performance recording toolkit for developers and system
administrators. It can be used for both profiling systems software and
applications as well as monitoring servers and remote devices.
----------------------------------------------------------------------------
II. Installation and Running
----------------------------------------------------------------------------
Perfkit is packaged in the standard format for most GNU/Linux-based software.
Use the standard `./configure', `make', `make install' to build and install
Perfkit.
Perfkit contains a runtime agent that manages profiling and systems
monitoring. It can be run using `perfkit-agent'.
Perfkit contains a basic gui for adminstration of the agent. It is called
perfkit-gui and lives in the directory of the same name.
The profiler gui, perfkit-profiler, contains a Gtk and GooCanvas based
interface into the same perfkit-agent. It is found in the perfkit-profiler
directory.
A command line interface to the perfkit-agent can be found in the tools
directory, and is named perfkit-shell.
----------------------------------------------------------------------------
III. Contributing
----------------------------------------------------------------------------
Perfkit is actively looking for contributors to help improve the codebase
and add collection data sources.
You can find more information on the architecture of Perfkit and a layout
of the codebase in HACKING which can be found in the same directory as this
file.