Man Linux: Main Page and Category List

NAME

       stapgraph - systemtap grapher

SYNOPSIS

       stapgraph [ OPTIONS ] FILENAME [ ARGUMENTS ]
       stapgraph [ OPTIONS ] - [ ARGUMENTS ]
       stapgraph [ OPTIONS ] -e SCRIPT [ ARGUMENTS ]

DESCRIPTION

       The stapgraph program is a simple frontend to stap that produces graphs
       from the output of stap scripts.

       This manual corresponds to version 1.2.

OPTIONS

       stapgraph accepts all  options  accepted  by  stap.   They  are  passed
       through to the stap process running the script or probe points.

USER INTERFACE

       The  script  that  produces results can be started from a dialog within
       the program, in addition to being launched using the program’s  command
       line  arguments.  This dialog allows arguments to be passed to stap and
       to the script.

       When running, a mouse left click on a graph pauses the display of data,
       even  though  it  is still collected by the program. Dragging the mouse
       scrolls  the  graph  backwards  and  forwards  in  time;  clicking  the
       displayed pause button restarts the display of new data.

       The scroll wheel can be used to zoom in and out on the graph.

SCRIPT OUTPUT SYNTAX

       Scripts  can  output   Comma  Separated  Values  (CSV)  which  will  be
       interpreted by stapgraph.  The first value is the X coordinate  of  the
       graph,  usually  a  time  value.   stapgraph assumes that this value is
       constantly increasing.

       A different syntax allows the script to specify  many  details  of  the
       graph’s appearance.

       %DataSet: DATA-SET-NAME  SCALE  COLOR  GRAPHSTYLE

       The  data  set  name  identifies a data set that will be emitted by the
       script.  "SCALE" is the overall vertical scale of the  graph  for  this
       data set. "COLOR" is a red-green-blue hex color. "GRAPHSTYLE" is one of
       bar - a traditional bar graph dot - plotted points discreet - An  event
       style timeline that records that an event happened at a certain time.

       %Title: TITLE
              A title for the whole graph.

       %XAxisTitle: TITLE
              The legend for the X axis

       %YAxisTitle: TITLE
              The legend for the Y axis.

       %YMax: MAX VALUE
              The maximum value displayed on the graph.

GRAPH DATA

         DATA SET  TIME  VALUE Each data point that is to be plotted is tagged
       with the data set name, followed by the time and value of the point.

SEE ALSO

       stap(3stap), staprun(3stap),

BUGS

       Use the Bugzilla link off of the project web page or our mailing  list.
       http://sources.redhat.com/systemtap/,<systemtap@sources.redhat.com>.