1*c29d5175SchristosGuide - Guide to the DTraceToolkit 2*c29d5175Schristos 3*c29d5175Schristos How to get started, and a table of contents. 4*c29d5175Schristos 5*c29d5175SchristosQuickStart 6*c29d5175Schristos 7*c29d5175Schristos 1. The top most useful scripts are in this directory. 8*c29d5175Schristos 2. Try running them with "-h". Eg, "./execsnoop -h". 9*c29d5175Schristos 3. Read Docs/Contents for a full list of scripts. 10*c29d5175Schristos 11*c29d5175SchristosQuickStart-by-Screenshot 12*c29d5175Schristos 13*c29d5175Schristos 1. Look through the examples in the Examples directory until 14*c29d5175Schristos you see an output you like 15*c29d5175Schristos 2. Find the script and run it 16*c29d5175Schristos 3. Look for its man page in Man 17*c29d5175Schristos 18*c29d5175SchristosNot-so-QuickStart 19*c29d5175Schristos 20*c29d5175Schristos 1. Welcome! 21*c29d5175Schristos 2. Check the Table of Contents below to become famaliar with the 22*c29d5175Schristos directory structure of the DTraceToolkit. 23*c29d5175Schristos 3. See Docs/Faq for any initial questions. 24*c29d5175Schristos 4. Read Docs/Contents for a list of scripts. 25*c29d5175Schristos 5. Read Docs/Readme to see where scripts are documented. 26*c29d5175Schristos 6. Check Docs/Links for further DTrace. 27*c29d5175Schristos 7. Once famaliar with the toolkit, the following may be useful to 28*c29d5175Schristos add to your shell initialisation file, 29*c29d5175Schristos PATH=$PATH:/opt/DTT/Bin 30*c29d5175Schristos MANPATH=$MANPATH:/opt/DTT/Man 31*c29d5175Schristos in this case assuming the toolkit was installed in /opt/DTT. 32*c29d5175Schristos 33*c29d5175SchristosInstallation 34*c29d5175Schristos 35*c29d5175Schristos 1. Run ./install 36*c29d5175Schristos This will replace any existing version of the DTraceToolkit 37*c29d5175Schristos with this one. It will prompt. Final install location is 38*c29d5175Schristos printed by this install script. 39*c29d5175Schristos 40*c29d5175SchristosTable of Contents 41*c29d5175Schristos 42*c29d5175Schristos DTraceToolkit-X.XX/ 43*c29d5175Schristos Bin/ Symlinks to all the scripts 44*c29d5175Schristos Apps/ Application specific scripts 45*c29d5175Schristos Cpu/ Scripts for CPU analysis 46*c29d5175Schristos Code/ Example code to practise on 47*c29d5175Schristos Disk/ Scripts for disk I/O analysis 48*c29d5175Schristos Docs/ Documentation 49*c29d5175Schristos Contents Command list for the Toolkit 50*c29d5175Schristos Faq Frequently asked questions 51*c29d5175Schristos Links Further DTrace links 52*c29d5175Schristos Readme Readme for using the docs 53*c29d5175Schristos Examples/ Examples of command usage 54*c29d5175Schristos Guide This file! 55*c29d5175Schristos Include/ DTrace include files 56*c29d5175Schristos Java/ Scripts for tracing Java 57*c29d5175Schristos JavaScript/ Scripts for tracing JavaScript 58*c29d5175Schristos Kernel/ Scripts for kernel analysis 59*c29d5175Schristos License The CDDL license 60*c29d5175Schristos Locks/ Scripts for lock analysis 61*c29d5175Schristos Man/ Man pages 62*c29d5175Schristos man1m/ Man pages for the Toolkit commands 63*c29d5175Schristos Mem/ Scripts for memory analysis 64*c29d5175Schristos Misc/ Misc scripts 65*c29d5175Schristos Net/ Scripts for network analysis 66*c29d5175Schristos Notes/ Notes on Toolkit commands 67*c29d5175Schristos Perl/ Scripts for tracing Perl 68*c29d5175Schristos Php/ Scripts for tracing Php 69*c29d5175Schristos Proc/ Scripts for process analysis 70*c29d5175Schristos Python/ Scripts for tracing Python 71*c29d5175Schristos Ruby/ Scripts for tracing Ruby 72*c29d5175Schristos Shell/ Scripts for tracing Shell languages 73*c29d5175Schristos Snippits/ Snippits of D scripting 74*c29d5175Schristos System/ Scripts for system analysis 75*c29d5175Schristos Tcl/ Scripts for tracing Tcl 76*c29d5175Schristos User/ Scripts for user based activity analysis 77*c29d5175Schristos Zones/ Scripts for analysis by zone 78*c29d5175Schristos Version DTraceToolkit version 79*c29d5175Schristos install Install script, use for installs only 80*c29d5175Schristos 81*c29d5175SchristosWhen you type ls in the DTraceToolkit, you will be looking at the top ten 82*c29d5175Schristosor so most useful scripts plus the top level directories. Other scripts have 83*c29d5175Schristosbeen placed in meaningful subdirectories, such as Disk, Kernel, Proc, etc. 84*c29d5175Schristos 85*c29d5175SchristosAn optional Bin directory has been provided that links to all the scripts. 86*c29d5175Schristos 87*c29d5175SchristosThe DTraceToolkit is released under the CDDL license. It's the same open 88*c29d5175Schristossource license that OpenSolaris has been released under. 89*c29d5175Schristos 90*c29d5175SchristosThank you for using the DTraceToolkit! 91*c29d5175Schristos 92