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] [-U username]
10       tx_type ...
11       $PCP_PMDAS_DIR/txmon/txrecord [-l]
12       $PCP_PMDAS_DIR/txmon/txrecord tx_type servtime [tx_type servtime ... ]
13       $PCP_PMDAS_DIR/txmon/genload
14

DESCRIPTION

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

INSTALLATION

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

FILES

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

PCP ENVIRONMENT

89       Environment variables with the prefix PCP_ are used to parameterize the
90       file and directory names used by PCP.  On each installation,  the  file
91       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
92       $PCP_CONF variable may be used to specify an alternative  configuration
93       file, as described in pcp.conf(5).
94

SEE ALSO

96       PCPIntro(1),  pmcd(1),  pmdasample(1),  pmdatrivial(1), txmonvis(1) and
97       PMDA(3).
98
99
100
101Performance Co-Pilot                  PCP                         PMDATXMON(1)
Impressum