1STAP(1)                     General Commands Manual                    STAP(1)
2
3
4

NAME

6       stapgraph - systemtap grapher
7
8
9

SYNOPSIS

11       stapgraph [ OPTIONS ] FILENAME [ ARGUMENTS ]
12       stapgraph [ OPTIONS ] - [ ARGUMENTS ]
13       stapgraph [ OPTIONS ] -e SCRIPT [ ARGUMENTS ]
14
15

DESCRIPTION

17       The stapgraph program is a simple frontend to stap that produces graphs
18       from the output of stap scripts.
19
20       This manual corresponds to version 1.6.
21
22

OPTIONS

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

USER INTERFACE

29       The  script  that  produces results can be started from a dialog within
30       the program, in addition to being launched using the program's  command
31       line  arguments.  This dialog allows arguments to be passed to stap and
32       to the script.
33
34       When running, a mouse left click on a graph pauses the display of data,
35       even  though  it  is still collected by the program. Dragging the mouse
36       scrolls the graph backwards and forwards in  time;  clicking  the  dis‐
37       played pause button restarts the display of new data.
38
39       The scroll wheel can be used to zoom in and out on the graph.
40
41

SCRIPT OUTPUT SYNTAX

43       Scripts  can  output  Comma Seperated Values (CSV) which will be inter‐
44       preted by stapgraph.  The first value is the X coordinate of the graph,
45       usually  a time value.  stapgraph assumes that this value is constantly
46       increasing.
47
48       A different syntax allows the script to specify  many  details  of  the
49       graph's appearance.
50
51       %DataSet: DATA-SET-NAME  SCALE  COLOR  GRAPHSTYLE
52
53       The  data  set  name  identifies a data set that will be emitted by the
54       script.  "SCALE" is the overall vertical scale of the  graph  for  this
55       data set. "COLOR" is a red-green-blue hex color. "GRAPHSTYLE" is one of
56       bar - a traditional bar graph dot - plotted points discreet - An  event
57       style timeline that records that an event happened at a certain time.
58
59       %Title: TITLE
60              A title for the whole graph.
61
62       %XAxisTitle: TITLE
63              The legend for the X axis
64
65       %YAxisTitle: TITLE
66              The legend for the Y axis.
67
68       %YMax: MAX VALUE
69              The maximum value displayed on the graph.
70
71

GRAPH DATA

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

SEE ALSO

78       stap(3stap), staprun(3stap),
79
80

BUGS

82       Use the Bugzilla link off of the project web page or our mailing  list.
83       http://sourceware.org/systemtap/,<systemtap@sourceware.org>.
84
85
86
87Red Hat                           2011-08-02                           STAP(1)
Impressum