1PMDATXMON(1) General Commands Manual PMDATXMON(1)
2
6 pmdatxmon, txrecord, genload - txmon performance metrics domain agent
7 (PMDA)
8
10 $PCP_PMDAS_DIR/txmon/pmdatxmon [-d domain] [-l logfile] [-U username]
11 tx_type ...
12 $PCP_PMDAS_DIR/txmon/txrecord [-l]
13 $PCP_PMDAS_DIR/txmon/txrecord tx_type servtime [tx_type servtime ... ]
14 $PCP_PMDAS_DIR/txmon/genload
15
17 pmdatxmon is an example Performance Metrics Domain Agent (PMDA) which
18 exports a small number of performance metrics from a simulated transac‐
19 tion monitor.
20 The txmon PMDA is shipped as both binary and source code and is de‐
22 signed to be an aid for PMDA developers; the txmon PMDA demonstrates
23 how performance data can be exported from an application (in this case
24 txrecord) to the PCP infrastructure via a shared memory segment. As a
25 matter of convenience, pmdatxmon creates (and destroys on exit) the
26 shared memory segment.
27 The tx_type arguments are arbitrary unique tags used to identify dif‐
29 ferent transaction types.
30 The txrecord application simulates the processing of one or more trans‐
32 actions identified by tx_type and with an observed service time of
33 servtime .
34 With the -l option, txrecord displays the current summary of the trans‐
36 action activity from the shared memory segment.
37 genload is a shell and awk(1) script that acts as a front-end to
39 txrecord to generate a constant load of simulated transaction activity.
40 A brief description of the pmdatxmon command line options follows:
42 -d It is absolutely crucial that the performance metrics domain num‐
44 ber specified here is unique and consistent. That is, domain
45 should be different for every PMDA on the one host, and the same
46 domain number should be used for the same PMDA on all hosts.
47 -l Location of the log file. By default, a log file named txmon.log
49 is written in the current directory of pmcd(1) when pmdatxmon is
50 started, i.e. $PCP_LOG_DIR/pmcd. If the log file cannot be cre‐
51 ated or is not writable, output is written to the standard error
52 instead.
53 -U User account under which to run the agent. The default is the un‐
55 privileged "pcp" account in current versions of PCP, but in older
56 versions the superuser account ("root") was used by default.
57
59 If you want access to the names, help text and values for the txmon
60 performance metrics, do the following as root:
61 # cd $PCP_PMDAS_DIR/txmon
63 # ./Install
64 You will be prompted for the tx_type tags.
66 If you want to undo the installation, do the following as root:
68 # cd $PCP_PMDAS_DIR/txmon
70 # ./Remove
71 pmdatxmon is launched by pmcd(1) and should never be executed directly.
73 The Install and Remove scripts notify pmcd(1) when the agent is in‐
74 stalled or removed.
75
77 $PCP_PMCDCONF_PATH
78 command line options used to launch pmdatxmon
79 $PCP_PMDAS_DIR/txmon/help
80 default help text file for the txmon metrics
81 $PCP_PMDAS_DIR/txmon/Install
82 installation script for the pmdatxmon agent
83 $PCP_PMDAS_DIR/txmon/Remove
84 undo installation script for the pmdatxmon agent
85 $PCP_LOG_DIR/pmcd/txmon.log
86 default log file for error messages and other information
87 from pmdatxmon
88
90 Environment variables with the prefix PCP_ are used to parameterize the
91 file and directory names used by PCP. On each installation, the file
92 /etc/pcp.conf contains the local values for these variables. The
93 $PCP_CONF variable may be used to specify an alternative configuration
94 file, as described in pcp.conf(5).
95
97 PCPIntro(1), pmcd(1), pmdasample(1), pmdatrivial(1), txmonvis(1) and
98 PMDA(3).
99Performance Co-Pilot PCP PMDATXMON(1)