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

NAME

6       pmdatxmon - txmon performance metrics domain agent (PMDA)
7

SYNOPSIS

9       $PCP_PMDAS_DIR/txmon/pmdatxmon [-d domain] [-l logfile] tx_type ...
10       $PCP_PMDAS_DIR/txmon/txrecord [-l]
11       $PCP_PMDAS_DIR/txmon/txrecord tx_type servtime [tx_type servtime ... ]
12       $PCP_PMDAS_DIR/txmon/genload
13

DESCRIPTION

15       pmdatxmon  is  an example Performance Metrics Domain Agent (PMDA) which
16       exports a small number of performance metrics from a simulated transac‐
17       tion monitor.
18
19       The  txmon  PMDA  is  shipped  as  both  binary  and source code and is
20       designed to be an aid for PMDA developers; the txmon PMDA  demonstrates
21       how  performance data can be exported from an application (in this case
22       txrecord) to the PCP infrastructure via a shared memory segment.  As  a
23       matter  of  convenience,  pmdatxmon  creates (and destroys on exit) the
24       shared memory segment.
25
26       The tx_type arguments are arbitrary unique tags used to  identify  dif‐
27       ferent transaction types.
28
29       The txrecord application simulates the processing of one or more trans‐
30       actions identified by tx_type and with  an  observed  service  time  of
31       servtime .
32
33       With the -l option, txrecord displays the current summary of the trans‐
34       action activity from the shared memory segment.
35
36       genload is a shell and awk(1)  script  that  acts  as  a  front-end  to
37       txrecord to generate a constant load of simulated transaction activity.
38
39       A brief description of the pmdatxmon command line options follows:
40
41       -d   It  is absolutely crucial that the performance metrics domain num‐
42            ber specified here is unique  and  consistent.   That  is,  domain
43            should  be  different for every PMDA on the one host, and the same
44            domain number should be used for the same PMDA on all hosts.
45
46       -l   Location of the log file.  By default, a log file named  txmon.log
47            is  written  in the current directory of pmcd(1) when pmdatxmon is
48            started, i.e.  $PCP_LOG_DIR/pmcd.  If the log file cannot be  cre‐
49            ated  or  is not writable, output is written to the standard error
50            instead.
51

INSTALLATION

53       If you want access to the names, help text and  values  for  the  txmon
54       performance metrics, do the following as root:
55
56            # cd $PCP_PMDAS_DIR/txmon
57            # ./Install
58
59       You will be prompted for the tx_type tags.
60
61       If you want to undo the installation, do the following as root:
62
63            # cd $PCP_PMDAS_DIR/txmon
64            # ./Remove
65
66       pmdatxmon is launched by pmcd(1) and should never be executed directly.
67       The Install and  Remove  scripts  notify  pmcd(1)  when  the  agent  is
68       installed or removed.
69

FILES

71       $PCP_PMCDCONF_PATH
72                 command line options used to launch pmdatxmon
73       $PCP_PMDAS_DIR/txmon/help
74                 default help text file for the txmon metrics
75       $PCP_PMDAS_DIR/txmon/Install
76                 installation script for the pmdatxmon agent
77       $PCP_PMDAS_DIR/txmon/Remove
78                 undo installation script for the pmdatxmon agent
79       $PCP_LOG_DIR/pmcd/txmon.log
80                 default  log  file  for  error messages and other information
81                 from pmdatxmon
82

PCP ENVIRONMENT

84       Environment variables with the prefix PCP_ are used to parameterize the
85       file  and  directory names used by PCP.  On each installation, the file
86       /etc/pcp.conf contains the  local  values  for  these  variables.   The
87       $PCP_CONF  variable may be used to specify an alternative configuration
88       file, as described in pcp.conf(4).
89

SEE ALSO

91       PCPIntro(1), pmcd(1), pmdasample(1),  pmdatrivial(1),  txmonvis(1)  and
92       PMDA(3).
93
94
95
96Performance Co-Pilot                  SGI                         PMDATXMON(1)
Impressum