pmtrace(1)

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

NAME

6       pmtrace - command line performance instrumentation
7

SYNOPSIS

9       pmtrace  [-q?]  [-c value | -e command | -v value] [-h host] [-S state]
10       tag
11

DESCRIPTION

13       pmtrace provides a simple command line interface to the  trace  Perfor‐
14       mance Metrics Domain Agent (PMDA) and the associated pcp_trace library.
15
16       The  default  pmtrace  behavior  is  to provide point trace data to the
17       trace PMDA, using the tag argument as the identifying  name  associated
18       with  each  trace  point.   The tag then becomes an instance identifier
19       within the set of trace.point metrics.
20

OPTIONS

22       The available command line options are:
23
24       -c value
25            Allow an arbitrary  counter  value  to  be  exported  through  the
26            trace.count metrics.
27
28       -e command
29            Allow  an  arbitrary command to be executed.  This command will be
30            measured as a transaction since it has well defined start and  end
31            points.    The   information   is   made   available  through  the
32            trace.transact metrics.
33
34       -h host
35            Sent the trace data to the trace PMDA running on host, rather than
36            the  localhost.   This  overrides  use of the environment variable
37            PCP_TRACE_HOST.
38
39       -q   Suppress messages from a successful trace, so  that  pmtrace  runs
40            quietly.
41
42       -S state
43            Enable  internal  debugging  and tracing.  The value of state is a
44            bit-wise combination of debug flags as defined in pmtracestate(3),
45            and  may be specified using the decimal or hexadecimal syntax pre‐
46            scribed by strtol(3).
47
48       -v value
49            Allow an arbitrary floating point value to be exported through the
50            trace.observe metrics.
51
52       -?   Display usage message and exit.
53

DIAGNOSTICS

55       All  are  generated  on  standard  error  and  are intended to be self-
56       explanatory.
57
58       The pmtrace exit status is always zero except when the -e option is  in
59       use, in which case the exit status of command is returned.
60

FILES

62       $PCP_DEMOS_DIR/trace/pmtrace.c
63            source code for pmtrace
64

ENVIRONMENT

66       Since  pmtrace  uses the libpcp_trace library routines, the environment
67       variables PCP_TRACE_HOST, PCP_TRACE_PORT, and PCP_TRACE_TIMEOUT are all
68       honored.   Refer  to  pmdatrace(3)  for  a  detailed description of the
69       semantics of each.
70

PCP ENVIRONMENT

72       Environment variables with the prefix PCP_ are used to parameterize the
73       file  and  directory names used by PCP.  On each installation, the file
74       /etc/pcp.conf contains the  local  values  for  these  variables.   The
75       $PCP_CONF  variable may be used to specify an alternative configuration
76       file, as described in pcp.conf(5).
77