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

NAME

6       pmdasendmail - sendmail performance metrics domain agent (PMDA)
7

SYNOPSIS

9       $PCP_PMDAS_DIR/sendmail/pmdasendmail [-d domain] [-l logfile] [-U user‐
10       name]
11

DESCRIPTION

13       pmdasendmail is a sendmail  Performance  Metrics  Domain  Agent  (PMDA)
14       which exports mail traffic statistics as collected by sendmail(1).
15
16       Before  the sendmail PMDA can export any metrics, sendmail(1) must have
17       statistics collection enabled.  This involves checking the name of  the
18       statistics  file,  as  given by the OS or O StatusFile control lines in
19       /etc/sendmail.cf, and then creating this file if it  does  not  already
20       exist.  Removing the file will terminate statistics collection by send‐
21       mail(1) and hence the sendmail PMDA.
22
23       A brief description of the pmdasendmail command line options follows:
24
25       -d   It is absolutely crucial that the performance metrics domain  num‐
26            ber  specified  here  is  unique  and consistent.  That is, domain
27            should be different for every PMDA on the one host, and  the  same
28            domain number should be used for the same PMDA on all hosts.
29
30       -l   Location  of  the  log  file.   By default, a log file named send‐
31            mail.log is written in  the  current  directory  of  pmcd(1)  when
32            pmdasendmail is started, i.e.  $PCP_LOG_DIR/pmcd.  If the log file
33            cannot be created or is not writable, output  is  written  to  the
34            standard error instead.
35
36       -U   User  account  under  which  to run the agent.  The default is the
37            unprivileged "pcp" account in current  versions  of  PCP,  but  in
38            older versions the superuser account ("root") was used by default.
39
40       There  are  no communication options, as the Install script ensures the
41       sendmail PMDA will be connected to PMCD by a pipe.
42

INSTALLATION

44       If you want access to the names, help text and values for the  sendmail
45       performance metrics, do the following as root:
46
47            # cd $PCP_PMDAS_DIR/sendmail
48            # ./Install
49
50       If you want to undo the installation, do the following as root:
51
52            # cd $PCP_PMDAS_DIR/sendmail
53            # ./Remove
54
55       pmdasendmail  is  launched  by  pmcd(1)  and  should  never be executed
56       directly.  The Install and Remove scripts notify pmcd(1) when the agent
57       is installed or removed.
58

FILES

60       $PCP_PMCDCONF_PATH
61                 command line options used to launch pmdasendmail
62       $PCP_PMDAS_DIR/sendmail/help
63                 default help text file for the sendmail metrics
64       $PCP_PMDAS_DIR/sendmail/Install
65                 installation script for the pmdasendmail agent
66       $PCP_PMDAS_DIR/sendmail/Remove
67                 undo installation script for the pmdasendmail agent
68       $PCP_LOG_DIR/pmcd/sendmail.log
69                 default  log  file  for  error messages and other information
70                 from pmdasendmail
71       /etc/sendmail.cf
72                 sendmail configuration file to identify the name of the  sta‐
73                 tistics file
74

PCP ENVIRONMENT

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

SEE ALSO

83       PCPIntro(1), pmcd(1) and sendmail(1).
84
85
86
87Performance Co-Pilot                  PCP                      PMDASENDMAIL(1)
Impressum