pminfo(1)

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

NAME

6       pminfo - display information about performance metrics
7

SYNOPSIS

9       pminfo  [-dfFLmMtTvz] [-a archive] [-b batchsize] [-c dmfile] [-h host‐
10       name] [-K spec] [-n pmnsfile] [-O time] [-Z timezone] [metricname ...]
11

DESCRIPTION

13       pminfo displays various types of information about performance  metrics
14       available through the facilities of the Performance Co-Pilot (PCP).
15
16       Normally  pminfo  operates  on the distributed Performance Metrics Name
17       Space (PMNS), however if the -n  option  is  specified  an  alternative
18       local PMNS is loaded from the file pmnsfile.
19
20       The metrics of interest are named in the metricname arguments.  If met‐
21       ricname is a non-leaf node in the PMNS, then  pminfo  will  recursively
22       descend  the PMNS and report on all leaf nodes.  If no metricname argu‐
23       ment is given, the root of the PMNS is used.
24
25       Unless directed to another host by the -h  option,  by  default  pminfo
26       will  contact  the  Performance  Metrics Collector Daemon (PMCD) on the
27       local host.  The connection to  a  PMCD  is  only  required  if  pminfo
28       requires distributed PMNS information, and/or meta-data describing met‐
29       rics, and/or metric values, and/or help text.
30
31       The -a option causes pminfo to use the specified  archive  rather  than
32       connecting to a PMCD.  The -a and -h options are mutually exclusive.
33
34       The  -L  option causes pminfo to use a local context to collect metrics
35       from PMDAs on the local host  without  PMCD.   Only  some  metrics  are
36       available  in  this mode.  The -a,-h and -L options are mutually exclu‐
37       sive.
38
39       The -b option may be used to define the maximum size of  the  group  of
40       metrics  to  be  fetched in a single request for the -f and -v options.
41       The default value for batchsize is 20.
42
43       Other options control the specific information to be reported.
44
45       -c   The dmfile argument specfies a file that contains  derived  metric
46            definitions  in  the  format described for pmLoadDerivedConfig(3).
47            The -c option provides a way to load  derived  metric  definitions
48            that   is   an   alternative  to  the  more  generic  use  of  the
49            PCP_DERIVED_CONFIG environment variable  as  described  in  PCPIn‐
50            tro(1).   Using  the -c option and the PCP_DERIVED_CONFIG environ‐
51            ment variable to specify the same configuration is a bad idea,  so
52            choose one or the other method.
53
54       -d   Metric descriptions detailing the PMID, data type, data semantics,
55            units, scale and associated instance domain.
56
57       -f   Fetch and print values for all instances.  When fetching  from  an
58            archive,  only those instances present in the first archive record
59            for a metric will be displayed; see also the -O option,  else  use
60            pmdumplog(1) which may be a better tool for examining archives.
61
62       -F   Same  as  -f  but  try harder to fetch instances for metrics which
63            have non-enumerable instance domains (e.g. metrics in the ``proc''
64            subtree of the default PMNS).
65
66       -K   When  using  the  -L option to fetch metrics from a local context,
67            the -K option may be used to control the DSO PMDAs that should  be
68            made  accessible.   The  spec  argument  conforms  to  the  syntax
69            described in __pmSpecLocalPMDA(3).  More than one -K option may be
70            used.
71
72       -m   Print the PMID in terse mode.
73
74       -M   Print the PMID in verbose mode.
75
76       -O   When used in conjunction with an archive source of metrics and the
77            options -f or -F, the time argument defines a time origin at which
78            the  metrics  should be fetched from the archive.  Refer to PCPIn‐
79            tro(1) for a complete description of this option, and  the  syntax
80            for the time argument.
81
82            When  the  ``ctime''  format is used for the time argument in a -O
83            option, the timezone becomes an issue.  The default is to use  the
84            local  timezone  on the system where pminfo is run.  The -Z option
85            changes the timezone to timezone in the format of the  environment
86            variable TZ as described in environ(5).  The -z option changes the
87            timezone to the local timezone at the host that is the  source  of
88            the performance metrics, as identified via the -a option.
89
90       -t   Print the ``one line'' help summary, if available.
91
92       -T   Print the help text, if available.
93
94       -v   Verify  mode  in  which descriptions and values are retrieved, but
95            only error conditions are reported.  This option silently disables
96            any output from the options -f, -M, -m, -t and -T.
97

FILES

99       $PCP_VAR_DIR/pmns/*
100                 default local PMNS specification files
101

PCP ENVIRONMENT

103       Environment variables with the prefix PCP_ are used to parameterize the
104       file and directory names used by PCP.  On each installation,  the  file
105       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
106       $PCP_CONF variable may be used to specify an alternative  configuration
107       file, as described in pcp.conf(4).
108

NAME

SYNOPSIS

DESCRIPTION

FILES

PCP ENVIRONMENT

SEE ALSO