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

NAME

6       pmdalogger - log file performance metrics domain agent (PMDA)
7

SYNOPSIS

9       $PCP_PMDAS_DIR/logger/pmdalogger  [-d  domain] [-l logfile] [-m memory]
10       [-s interval] [-U username] [configfile]
11

DESCRIPTION

13       pmdalogger is a configurable log file  monitoring  Performance  Metrics
14       Domain  Agent  (PMDA).  It can be seen as analogous to the -f option to
15       tail(1) and converts each new log line into a  performance  event.   It
16       was the first PMDA to make extensive use of event metrics, which can be
17       consumed by client tools like pmevent(1).
18
19       The logger PMDA exports both event-style metrics reflecting timestamped
20       event records for text logged to a file (or set of files or output from
21       a process), as well as the more orthodox sample-style metrics  such  as
22       event counts and throughput size values.
23
24       The  PMDA  is  configured  via a configfile which contains one line for
25       each source of events (file or process).  This file is setup by the In‐
26       stall  script described in the later section on ``INSTALLATION'' of the
27       PMDA.
28
29       A brief description of the pmdalogger command line options follows:
30
31       -d   It is absolutely crucial that the performance metrics domain  num‐
32            ber  specified  here  is  unique  and consistent.  That is, domain
33            should be different for every PMDA on the one host, and  the  same
34            domain number should be used for the same PMDA on all hosts.
35
36       -l   Location of the log file.  By default, a log file named logger.log
37            is written in the current directory of pmcd(1) when pmdalogger  is
38            started,  i.e.  $PCP_LOG_DIR/pmcd.  If the log file cannot be cre‐
39            ated or is not writable, output is written to the  standard  error
40            instead.
41
42       -m   Limit the physical memory used by the PMDA to buffer event records
43            to maxsize bytes.  As log events arrive at the PMDA, they must  be
44            buffered  until  individual  client  tools  request the next batch
45            since their previous batch of events.  The default  maximum  is  2
46            megabytes.
47
48       -s   Sets  the  polling interval for detecting newly arrived log lines.
49            Mirrors the same option from the tail(1) command.
50
51       -U   User account under which to run the agent.  The default is the un‐
52            privileged  "pcp" account in current versions of PCP, but in older
53            versions the superuser account ("root") was used by default.
54

INSTALLATION

56       If you want access to the names, help text and values  for  the  logger
57       performance metrics, do the following as root:
58
59            # cd $PCP_PMDAS_DIR/logger
60            # ./Install
61
62       This  is an interactive installation process which prompts for each log
63       file path to be monitored (or command to be  run),  a  metric  instance
64       name  to identify it, and whether access should be restricted (refer to
65       the -x option to pmevent(1) for further details).
66
67       If you want to undo the installation, do the following as root:
68
69            # cd $PCP_PMDAS_DIR/logger
70            # ./Remove
71
72       pmdalogger is launched by pmcd(1) and  should  never  be  executed  di‐
73       rectly.   The  Install and Remove scripts notify pmcd(1) when the agent
74       is installed or removed.
75

FILES

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

PCP ENVIRONMENT

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

SEE ALSO

99       PCPIntro(1), pmevent(1), pmcd(1), tail(1), pcp.conf(5) and pcp.env(5).
100
101
102
103Performance Co-Pilot                  PCP                        PMDALOGGER(1)
Impressum