The [options] section
The [options] section is read every time pmrep is run and it
defines the default runtime values (which may be overridden by
the corresponding command line options). Metric specifications
are not allowed in this section.
Section options
version (integer)
Indicates the configuration file version. Defaults to 1.
The only currently supported value is 1.
source (string)
Indicates the source for metrics. Interpreted as a PCP
archive if the string contains a slash (``/''). If set to
the special character ``@'', local DSO PMDA context is used.
Otherwise interpreted as a hostname. Corresponding command
line paraters are -a, -h, and -L. Defaults to local: (see
PCPIntro(1)).
output (string)
Indicates the output target. Corresponding command line
option is -o. For supported output targets, see pmrep(1).
Defaults to stdout.
speclocal (string)
Indicates the local DSO PMDAs to be made available when using
the local DSO PMDA context. Corresponding command line
option is -K. For syntax description, see
pmSpecLocalPMDA(3). Use a semicolon (``;'') to separate more
than one spec. Undefined by default.
derived (string)
Derived metric specifications. Corresponding command line
option is -e. For syntax description, see pmrep(1).
Undefined by default.
daemonize (boolean)
Indicates whether to daemonize on startup. Corresponding
command line option is --daemonize. Defaults to no.
header (boolean)
Indicates whether to print headers. Corresponding command
line option is -H. Defaults to yes.
instinfo (boolean)
Indicates whether to include instance information as part of
headers. Corresponding command line option is
--no-inst-info. Defaults to yes.
unitinfo (boolean)
Indicates whether to include unit information as part of
headers. Corresponding command line option is -U. Defaults
to yes.
globals (boolean)
Indicates whether to include metrics from the [global]
section (see below) for reporting. Corresponding command
line option is -G. Defaults to yes.
timestamp (boolean)
Indicates whether to print the timestamp. Corresponding
command line option is -p. Defaults to no.
samples (integer)
Indicates the number of samples to print. Corresponding
command line option is -s. Undefined by default (meaning
unlimited number of samples if not limited by other options).
interval (string)
Indicates the interval between samples. Corresponding
command line option is -o. Follows the time syntax described
in PCPIntro(1). Defaults to 1s.
delay (boolean)
Indicates whether to pause between samples when replaying
from an archive rather than replaying at full speed.
Corresponding command line option is -d. Defaults to no.
type (string)
Indicates whether to output raw metric values by disabling
all rate conversions or convert cumulative counters to rates
(default). Corresponding command line option is -r. Allowed
values are default or raw.
type_prefer (string)
As type but does not override possible per-metric type
specifications. Corresponding command line option is -R.
Allowed values are default or raw.
ignore_incompat (boolean)
Indicates that incompatible metrics are to be ignored.
Corresponding command line option is -I. Defaults to no.
ignore_unknown (boolean)
Indicates that unknown metrics are to be ignored.
Corresponding command line option is -5. Defaults to no.
names_change (string)
Indicates the action to take on PMNS changes during sampling.
Corresponding command line option is -4. Defaults to ignore.
instances (string)
Indicates the instances to be reported. Corresponding
command line option is -i. Undefined (all instances are
reported) by default.
live_filter (boolean)
Indicates that live filtering should be enabled.
Corresponding command line option is -j. Defaults to no.
rank (integer)
Indicates the value to be used for ranking instances.
Corresponding command line option is -J. Undefined (all
instances are reported) by default.
overall_rank (boolean)
Indicates that overall ranking should be performed.
Corresponding command line option is -2. Defaults to no.
overall_rank_alt (boolean)
Indicates that overall ranking with alternative output format
should be performed. Corresponding command line option is
-3. Defaults to no.
limit_filter (integer)
Indicates the value to be used with limit filtering.
Corresponding command line option is -8. Undefined (all
instances are reported) by default.
limit_filter_force (integer)
As limit_filter but overrides possible possible per-metric
specifications. Corresponding command line option is -9.
Undefined (all instances are reported) by default.
invert_filter (boolean)
Indicates that invert filtering should be performed.
Corresponding command line option is -n. Defaults to no.
predicate (string)
Indicates the metrics to be used as predicate metrics.
Corresponding command line option is -N. Undefined by
default.
sort_metric (string)
Indicates the metrics to be used as sort reference metrics.
Corresponding command line option is -6. Undefined by
default.
omit_flat (boolean)
Indicates that single-valued ``flat'' metrics are to be
omitted from reporting. Corresponding command line option is
-v. Defaults to no.
include_labels (boolean)
Indicates that metric labels should included in the output.
Corresponding command line option is -m. Defaults to no.
include_texts (boolean)
Indicates that when writing a PCP archive, PCP help texts
shall be included in the created archive. Corresponding
command line option is --include-texts. Defaults to no.
colxrow (string)
Indicates to swap columns and rows in stdout output using the
given text label. Corresponding command line option is -X.
Undefined (no swapping) by default.
width (integer)
Indicates the width of stdout output columns. Corresponding
command line option is -w. Forced minimum is 3. Defaults to
the shortest width that can fit the metric text label.
width_force (integer)
As width but overrides possible possible per-metric
specifications. Corresponding command line option is -W.
Forced minimum is 3.
precision (integer)
Indicates how many decimals to use for numeric non-integer
output values. Corresponding command line option is -P.
Defaults to 3.
precision_force (integer)
As precision but overrides possible per-metric
specifications. Corresponding command line option is -0.
Undefined by default.
delimiter (string)
Indicates the column separator. Corresponding command line
option is -l. Default depends on the output target, see
pmrep(1).
extcsv (boolean)
Indicates whether to write extended CSV output similar to
sadf(1). Corresponding command line option is -k. Defaults
to no.
extheader (boolean)
Indicates whether to print extended header. Corresponding
command line option is -x. Defaults to no.
fixed_header (boolean)
Indicates that a fixed header should be used. Corresponding
command line option is -7. Defaults to no.
repeat_header (integer)
Indicates how often to repeat the header. Corresponding
command line option is -E. auto uses terminal height.
Defaults to 0 (disabled).
dynamic_header (boolean)
Indicates that a dynamic header should be used.
Corresponding command line option is -1. Defaults to no.
separate_header (boolean)
Indicates whether to print a separate header. Corresponding
command line option is -g. Defaults to no.
timefmt (string)
Indicates the format string for formatting the timestamp.
Corresponding command line option is -f. Defaults to
%H:%M:%S.
interpol (boolean)
Indicates whether to interpolate reported archive values.
Corresponding command line option is -u. See pmrep(1) for
complete description. Defaults to yes.
count_scale (string)
Indicates the unit/scale for counter metrics. Corresponding
command line option is -q. For supported syntax, see
pmrep(1). Undefined (no scaling) by default.
count_scale_force (string)
Like count_scale but overrides possible per-metric
specifications. Corresponding command line option is -Q.
Undefined by default.
space_scale (string)
Indicates the unit/scale for space metrics. Corresponding
command line option is -b. For supported syntax, see
pmrep(1). Undefined (no scaling) by default.
space_scale_force (string)
Like space_scale but overrides possible per-metric
specifications. Corresponding command line option is -B.
Undefined by default.
time_scale (string)
Indicates the unit/scale for time metrics. Corresponding
command line option is -y. For supported syntax, see
pmrep(1). Undefined (no scaling) by default.
time_scale_force (string)
Like time_scale but overrides possible per-metric
specifications. Corresponding command line option is -Y.
Undefined by default.
The [global] section
The [global] section is used to define metrics that will be
reported in addition to any other separately defined metrics or
metricsets. Configuration options are not allowed in this
section. Global metrics are reported by default, the command
line option -G or the configuration file option globals can be
used to disable global metrics.
Section options
No predefined options, only metricspecs allowed in this
section. See below for the metricspec specification.
