1PMIECONF(1) General Commands Manual PMIECONF(1)
2PMIECONF(1) General Commands Manual PMIECONF(1)
10
16 pmieconf - display and set configurable pmie rule variables
17
19 pmieconf [-Fv] [-f file] [-r rulepath] [command [args...]]
20
22 pmieconf is a utility for viewing and configuring variables from gener‐
23 alized pmie(1) rules. The set of generalized rules is read in from
24 rulepath, and the output file produced by pmieconf is a valid input
25 file for pmie.
26 A brief description of the pmieconf command line options follows:
28 -f file Any rule modifications resulting from pmieconf manipulation of
30 variable values will be written to file. The default value of
31 file is dependent on the user ID - for the root user, the file
32 $PCP_VAR_DIR/config/pmieconf/config.pmie is used, for other
33 users the default is $HOME/.pcp/pmie/config.pmie.
34 -F Forces the pmieconf output file to be created (or updated),
36 after which pmieconf immediately exits.
37 -r rulepath
39 Allows the source of generalized pmie rules to be changed -
40 rulepath is a colon-delimited list of pmieconf(4) rule files
41 and/or subdirectories. The default value for rulepath is
42 $PCP_VAR_DIR/config/pmieconf. Use of this option overrides the
43 PMIECONF_PATH environment variable which has a similar func‐
44 tion.
45 -v Verbose mode. Additional information associated with each rule
47 and its associated variables will be displayed. This is the
48 complete list of variables which affects any given rule (by
49 default, global variables are not displayed with the rule).
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 The pmieconf command language is described here:
57 help [ { . | all | global | <rule> | <group> } [<variable>] ]
59 Without arguments, the help command displays the syntax for all
60 of the available pmieconf commands. With one argument, a
61 description of one or more of the generalized rules is dis‐
62 played. With two arguments, a description of a specific vari‐
63 able relating to one or more of the generalized rules is dis‐
64 played.
65 rules [ enabled | disabled ]
67 Display the name and short summary for all of the generalized
68 rules found on rulepath. Each of the rule names can be used in
69 place of the keyword <rule> in this command syntax description.
70 The enabled and disabled options can be used to filter the set
71 of rules displayed to just those which are enabled or disabled
72 respectfully.
73 groups Display the name of all of the rule groups that were found on
75 rulepath. Each of the group names can be used in place of the
76 keyword <group> in this command syntax description, which
77 applies the command to all rules within the rule group.
78 status Display status information relating to the current pmieconf
80 session, including a list of running pmie processes which are
81 currently using file.
82 enable { . | all | <rule> | <group> }
84 Enables the specified rule or group of rules. An enabled rule
85 is one which will be included in the pmie configuration file
86 generated by pmieconf. Any enabled "actions" will be appended
87 to the rule's "predicate", in a manner conforming to the pmie
88 syntax ("actions" can be viewed using the list global command,
89 described below).
90 disable { . | all | <rule> | <group> }
92 Disables the specified rule or group of rules. If the rule was
93 previously enabled, it will be removed from the pmie configura‐
94 tion file generated by pmieconf, and hence no longer evaluated
95 when pmie is restarted (using pmieconf does not affect any
96 existing pmie processes using file).
97 list { . | all | global | <rule> | <group> } [<variable>]
99 Display the values for a specific rule variable; or for all
100 variables of a rule, a rule group, all rules, or the global
101 variables.
102 modify { . | all | global | <rule> | <group> } <variable> <value>
104 Enable, disable, or otherwise change the value for one or more
105 rule variables. This value must be consistent with the type of
106 the variable, which can be inferred from the format of the
107 printed value - e.g. strings will be enclosed in double-quotes,
108 percentages have the ``%'' symbol appended, etc. Note that
109 certain rule variables cannot be modified through pmieconf -
110 "predicate" and "help", for example.
111 undo { . | all | global | <rule> | <group> } [<variable>]
113 Applicable only to a variable whose value has been modified -
114 this command simply reverts to the default value for the given
115 variable.
116 quit Save any changes made to file and then exit pmieconf.
118 abort Exit pmieconf immediately without saving any changes to file.
120 Each of the commands above can be shortened by simply using the first
122 character of the command name, and also ``?'' for help.
123 Use of the all keyword causes the command to be applied to all of the
125 rules. The global keyword refers to those variables which are applied
126 to every rule. Such variables can be changed either globally or
127 locally, for example:
128 pmieconf> modify global delta "5 minutes"
130 pmieconf> modify memory delta "1 minute"
131 causes all rules to now be evaluated once every five minutes, except
133 for rules in the "memory" group which are to be evaluated once per
134 minute.
135 The ``.'' character is special to pmieconf - it refers to the last suc‐
137 cessfully used value of all, global, <rule> or <group>.
138
140 Specify that all of the rules in the "memory" group should be evalu‐
141 ated:
142 pmieconf> modify memory enabled yes
144 Change your mind, and revert to using only the "memory" rules which
146 were enabled by default:
147 pmieconf> undo memory enabled
149 Specify that notification of rules which evaluate to true should be
151 sent to syslogd(1):
152 pmieconf> modify global syslog_action yes
154 Specify that rules in the "per_cpu" group should use a different hold‐
156 off value to other rules:
157 pmieconf> help global holdoff
159 rule: global [generic parameters applied to all rules]
160 var: holdoff
161 help: Once the predicate is true and the action is executed,
162 this variable allows suppression of further action
163 execution until the specified interval has elapsed.
164 A value of zero enables execution of the action if
165 the rule predicate is true at the next sample. Default
166 units are seconds and common units are "second", "sec",
167 "minute", "min" and "hour".
168 pmieconf> modify per_cpu holdoff "1 hour"
170 Lower the threshold associated with a particular variable for a speci‐
172 fied rule:
173 pmieconf> l cpu.syscall predicate
175 rule: cpu.syscall [High aggregate system call rate]
176 predicate =
177 some_host (
178 ( kernel.all.syscall $hosts$ )
179 > $threshold$ count/sec * hinv.ncpu $hosts$
180 )
181 pmieconf> m . threshold 7000
183 pmieconf> l . threshold
185 rule: cpu.syscall [High aggregate system call rate]
186 threshold = 7000
187
190 The environment variable PMIECONF_PATH has a similar function to the -r
191 option described above, and if set will be used provided no -r option
192 is presented.
193
195 $PCP_VAR_DIR/config/pmieconf/*/*
196 generalized system resource monitoring rules
197 $PCP_VAR_DIR/config/pmieconf/config.pmie
198 default super-user settings for system resource monitoring
199 rules
200 $HOME/.pcp/pmie/config.pmie
201 default user settings for system resource monitoring rules
202
204 Environment variables with the prefix PCP_ are used to parameterize the
205 file and directory names used by PCP. On each installation, the file
206 /etc/pcp.conf contains the local values for these variables. The
207 $PCP_CONF variable may be used to specify an alternative configuration
208 file, as described in pcp.conf(4).
209
211 PCPIntro(1), pmie(1), pmie_check(1) and pmieconf(4).
212Performance Co-Pilot SGI PMIECONF(1)