DTraceTazTool ReadMe
====================

Description
-----------

   DTraceTazTool is a disk activity analysis tool for Solaris 10 or newer.
   It uses DTrace to read disk activity and GTK to plot a graph.

Installation
------------

   See the INSTALL file.

Notes
-----

   If you want the easy way, run this as root. Regular users can run it,
   they need the privilege "dtrace_kernel" to be able to activate tracing;
   and they will not be able to run "prtvtoc" to determine the size of the
   disk - which means the y-axis scale will be determined by discovery
   (which is ok, so long as you are aware of it).

   For root to permanently give the required dtrace privilege to a user
   (so long as you understand the security risk),

	useradd -K defaultpriv=basic,dtrace_kernel username

   For root to temporarily give the dtrace privilege to all the currently
   running dtaz processes,

	ppriv -s A+dtrace_kernel `pgrep dtaz`

   It is recommended to run this as a regular user if you can.

Warning
-------

   This tool is under development.

See Also
--------

   TAZ Disk Tool - the original version on which this is based. 
   http://www.solarisinternals.com/si/tools/taz/index.php
   The original version was written by Richard McDougall and used TNF
   tracing (available since Solaris 2.5) to examine disk activity. 

   Solaris Internals, 2nd Edition.

   DTraceToolkit - various other tools to analyse disk behaviour. 
   http://www.opensolaris.org/os/community/dtrace/dtracetoolkit
   DTrace tools (including DTraceTazTool) require Solaris 10 or newer.

Copyright
---------

   Copyright (c) 2006 Brendan Gregg.

License
-------

   CDDL HEADER START
  
   The contents of this file are subject to the terms of the
   Common Development and Distribution License, Version 1.0 only
   (the "License").  You may not use this file except in compliance
   with the License.
  
   You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   or http://www.opensolaris.org/os/licensing.
   See the License for the specific language governing permissions
   and limitations under the License.
  
   When distributing Covered Code, include this CDDL HEADER in each
   file and include the License file at usr/src/OPENSOLARIS.LICENSE.
   If applicable, add the following below this CDDL HEADER, with the
   fields enclosed by brackets "[]" replaced with your own identifying
   information: Portions Copyright [yyyy] [name of copyright owner]
  
   CDDL HEADER END

Author
------

   Brendan Gregg
   [Sydney, Australia]
   http://www.brendangregg.com

History
-------

   29-Jan-2006  Brendan Gregg	Created this.
   05-Feb-2006     "       " 	Reorganized code.
   31-May-2006	   "	   "	Fixed STDIN bug.

ReadMe Version
--------------

   $Id: README 32 2006-05-31 15:28:13Z brendan $
