1PMIECONF(1) General Commands Manual PMIECONF(1)
2
6 pmieconf - display and set configurable pmie rule variables
7
9 pmieconf [-cFv?] [-f file] [-r rulepath] [command [args...]]
10
12 pmieconf is a utility for viewing and configuring variables from gener‐
13 alized pmie(1) rules. The set of generalized rules is read in from
14 rulepath, and the output file produced by pmieconf is a valid input
15 file for pmie.
16
18 The available command line options are:
19 -c When run from automated pmie setup processes, this option is used
21 to add a specific message and timestamp indicating that this is
22 the case. It is not appropriate when using the tool interac‐
23 tively.
24 -f file, --config=file
26 Any rule modifications resulting from pmieconf manipulation of
27 variable values will be written to file. The default value of
28 file is dependent on the user ID - for the root user, the file
29 $PCP_SYSCONF_DIR/pmie/config.pmie is used, for other users the
30 default is $HOME/.pcp/pmie/config.pmie.
31 -F Forces the pmieconf output file to be created (or updated), after
33 which pmieconf immediately exits.
34 -r rulepath, --rules=rulepath
36 Allows the source of generalized pmie rules to be changed -
37 rulepath is a colon-delimited list of pmieconf(5) rule files
38 and/or subdirectories. The default value for rulepath is
39 $PCP_VAR_DIR/config/pmieconf. Use of this option overrides the
40 PMIECONF_PATH environment variable which has a similar function.
41 -v, --verbose
43 Enable verbose mode. associated variables will be displayed.
44 This is the complete list of variables which affects any given
45 rule (by default, global variables are not displayed with the
46 rule).
47 -?, --help
49 Display usage message and exit.
50 The pmieconf commands allow information related to the various rules
52 and configurable variables to be displayed or modified. If no pmieconf
53 commands are presented on the command line, pmieconf prompts for com‐
54 mands interactively.
55
57 The pmieconf command language is described here:
58 help [ { . | all | global | <rule> | <group> } [<variable>] ]
60 Without arguments, the help command displays the syntax for all
61 of the available pmieconf commands. With one argument, a
62 description of one or more of the generalized rules is dis‐
63 played. With two arguments, a description of a specific vari‐
64 able relating to one or more of the generalized rules is dis‐
65 played.
66 rules [ enabled | disabled ]
68 Display the name and short summary for all of the generalized
69 rules found on rulepath. Each of the rule names can be used in
70 place of the keyword <rule> in this command syntax description.
71 The enabled and disabled options can be used to filter the set
72 of rules displayed to just those which are enabled or disabled
73 respectfully.
74 groups Display the name of all of the rule groups that were found on
76 rulepath. Each of the group names can be used in place of the
77 keyword <group> in this command syntax description, which
78 applies the command to all rules within the rule group.
79 status Display status information relating to the current pmieconf
81 session, including a list of running pmie processes which are
82 currently using file.
83 enable { . | all | <rule> | <group> }
85 Enables the specified rule or group of rules. An enabled rule
86 is one which will be included in the pmie configuration file
87 generated by pmieconf. Any enabled "actions" will be appended
88 to the rule's "predicate", in a manner conforming to the pmie
89 syntax ("actions" can be viewed using the list global command,
90 described below).
91 disable { . | all | <rule> | <group> }
93 Disables the specified rule or group of rules. If the rule was
94 previously enabled, it will be removed from the pmie configura‐
95 tion file generated by pmieconf, and hence no longer evaluated
96 when pmie is restarted (using pmieconf does not affect any
97 existing pmie processes using file).
98 list { . | all | global | <rule> | <group> } [<variable>]
100 Display the values for a specific rule variable; or for all
101 variables of a rule, a rule group, all rules, or the global
102 variables.
103 modify { . | all | global | <rule> | <group> } <variable> <value>
105 Enable, disable, or otherwise change the value for one or more
106 rule variables. This value must be consistent with the type of
107 the variable, which can be inferred from the format of the
108 printed value - e.g. strings will be enclosed in double-quotes,
109 percentages have the ``%'' symbol appended, etc. Note that
110 certain rule variables cannot be modified through pmieconf -
111 "predicate" and "help", for example.
112 undo { . | all | global | <rule> | <group> } [<variable>]
114 Applicable only to a variable whose value has been modified -
115 this command simply reverts to the default value for the given
116 variable.
117 quit Save any changes made to file and then exit pmieconf.
119 abort Exit pmieconf immediately without saving any changes to file.
121 Each of the commands above can be shortened by simply using the first
123 character of the command name, and also ``?'' for help.
124 Use of the all keyword causes the command to be applied to all of the
126 rules. The global keyword refers to those variables which are applied
127 to every rule. Such variables can be changed either globally or
128 locally, for example:
129 pmieconf> modify global delta "5 minutes"
131 pmieconf> modify memory delta "1 minute"
132 causes all rules to now be evaluated once every five minutes, except
134 for rules in the "memory" group which are to be evaluated once per
135 minute.
136 The ``.'' character is special to pmieconf - it refers to the last suc‐
138 cessfully used value of all, global, <rule> or <group>.
139
141 Specify that all of the rules in the "memory" group should be evalu‐
142 ated:
143 pmieconf> modify memory enabled yes
145 Change your mind, and revert to using only the "memory" rules which
147 were enabled by default:
148 pmieconf> undo memory enabled
150 Specify that notification of rules which evaluate to true should be
152 sent to syslogd(1):
153 pmieconf> modify global syslog_action yes
155 Specify that rules in the "per_cpu" group should use a different hold‐
157 off value to other rules:
158 pmieconf> help global holdoff
160 rule: global [generic parameters applied to all rules]
161 var: holdoff
162 help: Once the predicate is true and the action is executed,
163 this variable allows suppression of further action
164 execution until the specified interval has elapsed.
165 A value of zero enables execution of the action if
166 the rule predicate is true at the next sample. Default
167 units are seconds and common units are "second", "sec",
168 "minute", "min" and "hour".
169 pmieconf> modify per_cpu holdoff "1 hour"
171 Lower the threshold associated with a particular variable for a speci‐
173 fied rule:
174 pmieconf> l cpu.syscall predicate
176 rule: cpu.syscall [High aggregate system call rate]
177 predicate =
178 some_host (
179 ( kernel.all.syscall $hosts$ )
180 > $threshold$ count/sec * hinv.ncpu $hosts$
181 )
182 pmieconf> m . threshold 7000
184 pmieconf> l . threshold
186 rule: cpu.syscall [High aggregate system call rate]
187 threshold = 7000
188
191 $PCP_VAR_DIR/config/pmieconf/*/*
192 generalized system resource monitoring rules
193 $PCP_SYSCONF_DIR/pmie/config.pmie
195 default super-user settings for system resource monitoring rules
196 $HOME/.pcp/pmie/config.pmie
198 default user settings for system resource monitoring rules
199
201 The environment variable PMIECONF_PATH has a similar function to the -r
202 option described above, and if set will be used provided no -r option
203 is presented.
204
206 Environment variables with the prefix PCP_ are used to parameterize the
207 file and directory names used by PCP. On each installation, the file
208 /etc/pcp.conf contains the local values for these variables. The
209 $PCP_CONF variable may be used to specify an alternative configuration
210 file, as described in pcp.conf(5).
211
213 PCPIntro(1), pmie(1), pmie_check(1) and pmieconf(5).
214Performance Co-Pilot PCP PMIECONF(1)