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

NAME

6       pmrepconf - create/edit a pmrep configuration file
7

SYNOPSIS

9       pmrepconf  [-crvV?]  [-d groupsdir] [-g grouptag] [-o option] [-h host]
10       configfile
11

DESCRIPTION

13       pmrepconf may be used to create and modify a generic configuration file
14       for pmrep(1) and related utilities in the pmrep.conf(5) format.
15
16       If  configfile does not exist, pmrepconf will create a generic configu‐
17       ration file with a set of discovered metrics in a [metrics] section.
18
19       Once created, configfile may be used with the -c option to pmrep(1) and
20       related utilities such as pcp2elasticsearch(2) and pcp2spark(2).
21
22       If configfile does exist, pmrepconf will prompt for input from the user
23       to enable or disable groups of related performance metrics.
24
25       Group selection requires a simple y (yes) or n  (no)  response  to  the
26       prompt Log this group?.
27
28       Other  responses at this point may be used to select additional control
29       functions as follows:
30
31       m         Report the names of the metrics in the current group.
32
33       q         Finish with  group  selection  (quit)  and  make  no  further
34                 changes to this group or any subsequent group.
35
36       /pattern  Make  no change to this group but search for a group contain‐
37                 ing pattern in the description of the group or the  names  of
38                 the associated metrics.
39
40       When run from automated setup processes, the -c option is used to indi‐
41       cate that pmrepconf is in auto-create mode and  no  interactive  dialog
42       takes  place.   The output configfile has an additional comment message
43       and timestamp indicating this fact, so that it can  be  identified  and
44       subsequently  updated  using  -c again.  This option is not appropriate
45       for interactive use of the tool.
46
47       More verbose output may be enabled with the -v option.
48

SETUP GROUP FILES

50       When an initial configfile is created, the default specifications  come
51       from a set of group files below the groupsdir specified with the -d op‐
52       tion (the default groupsdir is $PCP_VAR_DIR/config/pmlogconf  which  is
53       most commonly correct, so the -d option is rarely used in practice).
54
55       The  directory  structure and format of files below groupsdir is shared
56       with the pmlogconf (1) utility, and described in detail on that  manual
57       page.  When used by pmrepconf all interval settings are ignored.
58

OPTIONS

60       The available command line options are:
61
62       -c   Enable non-interactive, auto-create mode.
63
64       -d groupdir, --groups=groupdir
65            Specify the path to the groupsdir directory.
66
67       -g grouptag, --group=grouptag
68            Query logging state for the specific group named grouptag.
69
70       -h host, --host=host
71            Performance  metrics source is pmcd(1) on host, rather than on the
72            default localhost.
73
74       -o option, --option=option
75            Specify an option to be added to the [option] secton of the gener‐
76            ated  pmrep.conf(5)  file.   This  command line option can be pre‐
77            sented multiple times in order to added multiple lines in the [op‐
78            tion] section.
79
80       -r, --reprobe
81            Reconsider every group for inclusion in the configfile.
82
83       -v, --verbose
84            Enable verbose mode.
85
86       -V, --version
87            Display version number and exit.
88
89       -?, --help
90            Display usage message and exit.
91

PCP ENVIRONMENT

93       Environment variables with the prefix PCP_ are used to parameterize the
94       file and directory names used by PCP.  On each installation,  the  file
95       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
96       $PCP_CONF variable may be used to specify an alternative  configuration
97       file, as described in pcp.conf(5).
98
99       pmrepconf  overrides any $PCP_DERIVED_CONFIG environment variable to an
100       empty string, for performance reasons.
101
102       pmrepconf honours  the  $PMCD_WAIT_TIMEOUT  environment  variable  when
103       probing  and creating new pmrep configuration files.  It uses a default
104       timeout value of 10 seconds for this, in the absence of an  environment
105       setting.
106

SEE ALSO

108       pcp2elasticsearch(1),  pcp2spark(1),  pmcd(1),  pmlogconf(1), pmrep(1),
109       pcp.conf(5), pcp.env(5) and pmrep.conf(5)
110
111
112
113Performance Co-Pilot                  PCP                         PMREPCONF(1)
Impressum