From ca947d81acf86cd346f139316e1287dcf42160de Mon Sep 17 00:00:00 2001 From: ddomingo Date: Tue, 2 Sep 2008 09:57:46 +1000 Subject: added all else --- doc/BeginnersGuide/en-US/Appendix.xml | 13 + doc/BeginnersGuide/en-US/Author_Group.xml | 16 + doc/BeginnersGuide/en-US/Book_Info.xml | 28 + doc/BeginnersGuide/en-US/Chapter.xml | 25 + doc/BeginnersGuide/en-US/Errors.xml | 11 + doc/BeginnersGuide/en-US/Introduction.xml | 43 + doc/BeginnersGuide/en-US/Preface.xml | 15 + doc/BeginnersGuide/en-US/References.xml | 10 + doc/BeginnersGuide/en-US/Revision_History.xml | 20 + .../en-US/SystemTap_Beginners_Guide.ent | 3 + .../en-US/SystemTap_Beginners_Guide.xml | 20 + doc/BeginnersGuide/en-US/Tips_Tricks.xml | 11 + .../en-US/Understanding_How_SystemTap_Works.xml | 35 + doc/BeginnersGuide/en-US/Useful_Scripts-Disk.xml | 21 + doc/BeginnersGuide/en-US/Useful_Scripts-IO.xml | 27 + doc/BeginnersGuide/en-US/Useful_Scripts-Kernel.xml | 27 + .../en-US/Useful_Scripts-Network.xml | 18 + doc/BeginnersGuide/en-US/Useful_Scripts-Others.xml | 25 + .../en-US/Useful_Scripts-Signals.xml | 25 + .../en-US/Useful_Scripts-Syscalls.xml | 29 + .../en-US/Useful_SystemTap_Scripts.xml | 23 + doc/BeginnersGuide/en-US/Using_SystemTap.xml | 37 + doc/BeginnersGuide/en-US/images/icon.svg | 3936 ++++++++++++++++++++ 23 files changed, 4418 insertions(+) create mode 100644 doc/BeginnersGuide/en-US/Appendix.xml create mode 100644 doc/BeginnersGuide/en-US/Author_Group.xml create mode 100644 doc/BeginnersGuide/en-US/Book_Info.xml create mode 100644 doc/BeginnersGuide/en-US/Chapter.xml create mode 100644 doc/BeginnersGuide/en-US/Errors.xml create mode 100644 doc/BeginnersGuide/en-US/Introduction.xml create mode 100644 doc/BeginnersGuide/en-US/Preface.xml create mode 100644 doc/BeginnersGuide/en-US/References.xml create mode 100644 doc/BeginnersGuide/en-US/Revision_History.xml create mode 100644 doc/BeginnersGuide/en-US/SystemTap_Beginners_Guide.ent create mode 100644 doc/BeginnersGuide/en-US/SystemTap_Beginners_Guide.xml create mode 100644 doc/BeginnersGuide/en-US/Tips_Tricks.xml create mode 100644 doc/BeginnersGuide/en-US/Understanding_How_SystemTap_Works.xml create mode 100644 doc/BeginnersGuide/en-US/Useful_Scripts-Disk.xml create mode 100644 doc/BeginnersGuide/en-US/Useful_Scripts-IO.xml create mode 100644 doc/BeginnersGuide/en-US/Useful_Scripts-Kernel.xml create mode 100644 doc/BeginnersGuide/en-US/Useful_Scripts-Network.xml create mode 100644 doc/BeginnersGuide/en-US/Useful_Scripts-Others.xml create mode 100644 doc/BeginnersGuide/en-US/Useful_Scripts-Signals.xml create mode 100644 doc/BeginnersGuide/en-US/Useful_Scripts-Syscalls.xml create mode 100644 doc/BeginnersGuide/en-US/Useful_SystemTap_Scripts.xml create mode 100644 doc/BeginnersGuide/en-US/Using_SystemTap.xml create mode 100644 doc/BeginnersGuide/en-US/images/icon.svg (limited to 'doc/BeginnersGuide') diff --git a/doc/BeginnersGuide/en-US/Appendix.xml b/doc/BeginnersGuide/en-US/Appendix.xml new file mode 100644 index 00000000..f7f8ea1d --- /dev/null +++ b/doc/BeginnersGuide/en-US/Appendix.xml @@ -0,0 +1,13 @@ + + + + + + + + Revision History + + + + diff --git a/doc/BeginnersGuide/en-US/Author_Group.xml b/doc/BeginnersGuide/en-US/Author_Group.xml new file mode 100644 index 00000000..c19ae8f0 --- /dev/null +++ b/doc/BeginnersGuide/en-US/Author_Group.xml @@ -0,0 +1,16 @@ + + + + + Red Hat Enterprise Linux Documentation + + Don + Domingo + + Engineering Services and Operations + Content Services + + ddomingo@redhat.com + + diff --git a/doc/BeginnersGuide/en-US/Book_Info.xml b/doc/BeginnersGuide/en-US/Book_Info.xml new file mode 100644 index 00000000..80937677 --- /dev/null +++ b/doc/BeginnersGuide/en-US/Book_Info.xml @@ -0,0 +1,28 @@ + + + + + Red Hat Enterprise Linux + SystemTap Beginners Guide + 0.1 + 0 + This guide provides basic instructions on how to use SystemTap to monitor different subsystems of &PRODUCT; in finer detail. The SystemTap Beginners Guide is recommended for users who have taken RHCT or have a similar level of expertise in &PRODUCT;. + + + + + + Logo + + + + &YEAR; + &HOLDER; + + + + + + + diff --git a/doc/BeginnersGuide/en-US/Chapter.xml b/doc/BeginnersGuide/en-US/Chapter.xml new file mode 100644 index 00000000..0a2b58fd --- /dev/null +++ b/doc/BeginnersGuide/en-US/Chapter.xml @@ -0,0 +1,25 @@ + + + + + Test + + This is a test paragraph + +
+ Section 1 Test + + Test of a section + +
+ +
+ Section 2 Test + + Test of a section + +
+ + + diff --git a/doc/BeginnersGuide/en-US/Errors.xml b/doc/BeginnersGuide/en-US/Errors.xml new file mode 100644 index 00000000..21351e08 --- /dev/null +++ b/doc/BeginnersGuide/en-US/Errors.xml @@ -0,0 +1,11 @@ + + + + + Understanding SystemTap Errors + + By type - http://sourceware.org/systemtap/tutorial/node23.html + + + diff --git a/doc/BeginnersGuide/en-US/Introduction.xml b/doc/BeginnersGuide/en-US/Introduction.xml new file mode 100644 index 00000000..9285d0ae --- /dev/null +++ b/doc/BeginnersGuide/en-US/Introduction.xml @@ -0,0 +1,43 @@ + + + + + Introduction + + A short introduction on SystemTap_Beginners_Guide + + + + Goals + TBD + +above, Short description on the underlying goals of SystemTap_Beginners_Guide, what we want to teach users. + + +
+ Usage + + This section describes the practical uses of SystemTap, at a conceptual level. What a beginner can use SystemTap for, and what an advanced user can use SystemTap for. + +
+ +
+ SystemTap Versus Other Monitoring Tools + + Short summary; when is SystemTap suitable vs other popular monitoring tools (e.g. top, Oprofile, /proc) + + + + Advantages + TBD + + + + Limitations + TBD + +
+ + + diff --git a/doc/BeginnersGuide/en-US/Preface.xml b/doc/BeginnersGuide/en-US/Preface.xml new file mode 100644 index 00000000..06d2d1f7 --- /dev/null +++ b/doc/BeginnersGuide/en-US/Preface.xml @@ -0,0 +1,15 @@ + + + + + Preface + + + + + + + + + diff --git a/doc/BeginnersGuide/en-US/References.xml b/doc/BeginnersGuide/en-US/References.xml new file mode 100644 index 00000000..a548a700 --- /dev/null +++ b/doc/BeginnersGuide/en-US/References.xml @@ -0,0 +1,10 @@ + + + + + References + display links to other useful, more advanced systemtap docs - http://sourceware.org/systemtap/documentation.html, http://sourceware.org/systemtap/wiki/HomePage + + + diff --git a/doc/BeginnersGuide/en-US/Revision_History.xml b/doc/BeginnersGuide/en-US/Revision_History.xml new file mode 100644 index 00000000..93b96e19 --- /dev/null +++ b/doc/BeginnersGuide/en-US/Revision_History.xml @@ -0,0 +1,20 @@ + + + + + + 1.0 + + + + + + + + + + + + + diff --git a/doc/BeginnersGuide/en-US/SystemTap_Beginners_Guide.ent b/doc/BeginnersGuide/en-US/SystemTap_Beginners_Guide.ent new file mode 100644 index 00000000..46bb6c06 --- /dev/null +++ b/doc/BeginnersGuide/en-US/SystemTap_Beginners_Guide.ent @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/doc/BeginnersGuide/en-US/SystemTap_Beginners_Guide.xml b/doc/BeginnersGuide/en-US/SystemTap_Beginners_Guide.xml new file mode 100644 index 00000000..1aa65bff --- /dev/null +++ b/doc/BeginnersGuide/en-US/SystemTap_Beginners_Guide.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + diff --git a/doc/BeginnersGuide/en-US/Tips_Tricks.xml b/doc/BeginnersGuide/en-US/Tips_Tricks.xml new file mode 100644 index 00000000..662d5b3d --- /dev/null +++ b/doc/BeginnersGuide/en-US/Tips_Tricks.xml @@ -0,0 +1,11 @@ + + + + + Tips and Tricks + This chapter covers miscellaneous tips/tricks + + This is a tentative section, and will only be included if content can be provided + + diff --git a/doc/BeginnersGuide/en-US/Understanding_How_SystemTap_Works.xml b/doc/BeginnersGuide/en-US/Understanding_How_SystemTap_Works.xml new file mode 100644 index 00000000..b3a1cbed --- /dev/null +++ b/doc/BeginnersGuide/en-US/Understanding_How_SystemTap_Works.xml @@ -0,0 +1,35 @@ + + + + + Understanding How SystemTap Works + + Short summary; probes, handlers, events + + +
+ Architecture + + add diagram, describe architecture, enumerate common tools + +
+ +
+ SystemTap Scripts + + + definition, significance, structure, very basic examples, reference to later chapter (how to read library of preset SystemTap scripts in this book, using them) + +
+ +
+ Tapsets + + + definition, significance, difference with stap scripts (previous section), library of tapsets in system: location + +
+ + + diff --git a/doc/BeginnersGuide/en-US/Useful_Scripts-Disk.xml b/doc/BeginnersGuide/en-US/Useful_Scripts-Disk.xml new file mode 100644 index 00000000..a5df51b6 --- /dev/null +++ b/doc/BeginnersGuide/en-US/Useful_Scripts-Disk.xml @@ -0,0 +1,21 @@ + + + + +
+ Disk + + http://sourceware.org/systemtap/examples/subsystem-index.html + + + + Graphing Disk and CPU Utilization - http://sourceware.org/systemtap/examples/general/graphs.stp + + + + Summarize Disk Read/Write Traffic + http://sourceware.org/systemtap/examples/io/disktop.stp + +
+ diff --git a/doc/BeginnersGuide/en-US/Useful_Scripts-IO.xml b/doc/BeginnersGuide/en-US/Useful_Scripts-IO.xml new file mode 100644 index 00000000..e6271b06 --- /dev/null +++ b/doc/BeginnersGuide/en-US/Useful_Scripts-IO.xml @@ -0,0 +1,27 @@ + + +
+ I/O Subsystem + + http://sourceware.org/systemtap/examples/subsystem-index.html + + + + Tally Reschedule Reason During AIO io_submit Call - http://sourceware.org/systemtap/examples/io/io_submit.stp + + + + Periodically Print I/O Activity by Process Name - http://sourceware.org/systemtap/examples/io/iotop.stp + + + + Track Cumulative I/O Activity by Process Name - + http://sourceware.org/systemtap/examples/io/traceio.stp + + + + Watch I/O Activity on a Particular Device + http://sourceware.org/systemtap/examples/io/traceio2.stp + +
diff --git a/doc/BeginnersGuide/en-US/Useful_Scripts-Kernel.xml b/doc/BeginnersGuide/en-US/Useful_Scripts-Kernel.xml new file mode 100644 index 00000000..aa188f0a --- /dev/null +++ b/doc/BeginnersGuide/en-US/Useful_Scripts-Kernel.xml @@ -0,0 +1,27 @@ + + + +
+ Kernel + + http://sourceware.org/systemtap/examples/subsystem-index.html + + + + Tracing Calls for Sections of Code - http://sourceware.org/systemtap/examples/general/para-callgraph.stp + + + + Profile kernel functions - http://sourceware.org/systemtap/examples/process/pf2.stp + + + + Count Times Functions Called - + http://sourceware.org/systemtap/examples/profiling/functioncallcount.stp + + + + Profile kernel functions - http://sourceware.org/systemtap/examples/profiling/thread-times.stp + +
\ No newline at end of file diff --git a/doc/BeginnersGuide/en-US/Useful_Scripts-Network.xml b/doc/BeginnersGuide/en-US/Useful_Scripts-Network.xml new file mode 100644 index 00000000..c8eea941 --- /dev/null +++ b/doc/BeginnersGuide/en-US/Useful_Scripts-Network.xml @@ -0,0 +1,18 @@ + + + +
+ Network + + http://sourceware.org/systemtap/examples/subsystem-index.html + + + + Periodic Listing of Processes Using Network Interfaces - http://sourceware.org/systemtap/examples/network/nettop.stp + + + + Trace Functions called in Network Socket Code - http://sourceware.org/systemtap/examples/network/socket-trace.stp + +
\ No newline at end of file diff --git a/doc/BeginnersGuide/en-US/Useful_Scripts-Others.xml b/doc/BeginnersGuide/en-US/Useful_Scripts-Others.xml new file mode 100644 index 00000000..c92eb2bd --- /dev/null +++ b/doc/BeginnersGuide/en-US/Useful_Scripts-Others.xml @@ -0,0 +1,25 @@ + + + + +
+ Other Useful Scripts + + http://sourceware.org/systemtap/examples/subsystem-index.html + + + + SCHEDULER - Generating Backtraces of Threads Waiting for IO Operations - http://sourceware.org/systemtap/examples/process/sleepingBeauties.stp + + + + LOCKING - System-Wide Futex Contention - http://sourceware.org/systemtap/examples/process/futexes.stp + + + + CPU - Graphing Disk and CPU Utilization - http://sourceware.org/systemtap/examples/general/graphs.stp + + + +
\ No newline at end of file diff --git a/doc/BeginnersGuide/en-US/Useful_Scripts-Signals.xml b/doc/BeginnersGuide/en-US/Useful_Scripts-Signals.xml new file mode 100644 index 00000000..a2668b6c --- /dev/null +++ b/doc/BeginnersGuide/en-US/Useful_Scripts-Signals.xml @@ -0,0 +1,25 @@ + + +
+ Signals + + http://sourceware.org/systemtap/examples/subsystem-index.html + + + + Signal Counts by Process ID - http://sourceware.org/systemtap/examples/process/sig_by_pid.stp + + + + Signal Counts by Process Name - http://sourceware.org/systemtap/examples/process/sig_by_proc.stp + + + + Track SIGKILL Signals - http://sourceware.org/systemtap/examples/process/sigkill.stp + + + + System-Wide Count of Syscalls by PID - http://sourceware.org/systemtap/examples/process/syscalls_by_pid.stp + +
\ No newline at end of file diff --git a/doc/BeginnersGuide/en-US/Useful_Scripts-Syscalls.xml b/doc/BeginnersGuide/en-US/Useful_Scripts-Syscalls.xml new file mode 100644 index 00000000..30c900ab --- /dev/null +++ b/doc/BeginnersGuide/en-US/Useful_Scripts-Syscalls.xml @@ -0,0 +1,29 @@ + + +
+ System Calls + + http://sourceware.org/systemtap/examples/subsystem-index.html + + + + Trace Time Spent in Read and Write for Files - http://sourceware.org/systemtap/examples/io/iotime.stp + + + + Trace Time Spent in nanosleep Syscalls - http://sourceware.org/systemtap/examples/process/sleeptime.stp + + + + System-Wide Count of Syscalls by PID - http://sourceware.org/systemtap/examples/process/syscalls_by_pid.stp + + + + System-Wide Count of Syscalls by Executable - http://sourceware.org/systemtap/examples/process/syscalls_by_proc.stp + + + + Trace Time Spent in wait4 Syscalls - http://sourceware.org/systemtap/examples/process/wait4time.stp + +
\ No newline at end of file diff --git a/doc/BeginnersGuide/en-US/Useful_SystemTap_Scripts.xml b/doc/BeginnersGuide/en-US/Useful_SystemTap_Scripts.xml new file mode 100644 index 00000000..d3cfb897 --- /dev/null +++ b/doc/BeginnersGuide/en-US/Useful_SystemTap_Scripts.xml @@ -0,0 +1,23 @@ + + + + + Useful SystemTap Scripts + + short intro, reference to online source (http://sourceware.org/systemtap/examples/subsystem-index.html); "always updated" + + + short description of gnuplot (?) for better GUI of results + + case studies and more info on some scripts here - http://sourceware.org/systemtap/wiki/WarStories + + + + + + + + + + diff --git a/doc/BeginnersGuide/en-US/Using_SystemTap.xml b/doc/BeginnersGuide/en-US/Using_SystemTap.xml new file mode 100644 index 00000000..f3f7a276 --- /dev/null +++ b/doc/BeginnersGuide/en-US/Using_SystemTap.xml @@ -0,0 +1,37 @@ + + + + + Using SystemTap + + short intro, contents of chapter + +
+ Setup and Installation + + required packages, installation thru yum, repos (?); possibly, a script to install all required packages + + + Cross-Compiling + TBD + +above; add short description, significance, howto, script (test first) + +
+ +
+ Usage + + basic commands (e.g. stap), useful options per command (e.g. stap -vv), tool references (man pages, related kernel-doc), references within book (i.e. errors chapter) + + + + running systemtap scripts + + + Tapsets: short intro on usage +
+ + + diff --git a/doc/BeginnersGuide/en-US/images/icon.svg b/doc/BeginnersGuide/en-US/images/icon.svg new file mode 100644 index 00000000..c471a607 --- /dev/null +++ b/doc/BeginnersGuide/en-US/images/icon.svg @@ -0,0 +1,3936 @@ + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + id="path2858" /> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit