cddl/contrib/dtracetoolkit/Guide

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