NAME | SYNOPSIS | DESCRIPTION | FILES | PCP ENVIRONMENT | SEE ALSO | DIAGNOSTICS | COLOPHON

PMSTORE(1)                 General Commands Manual                PMSTORE(1)

NAME         top

       pmstore - modify performance metric values

SYNOPSIS         top

       pmstore [-Lf] [-h host] [-i instances] [-K spec] [-n pmnsfile]
       metricname value

DESCRIPTION         top

       Under certain circumstances, it is useful to be able to modify the
       values of performance metrics, for example to re-initialize counters
       or to assign new values to metrics that act as control variables.

       pmstore changes the current values for the nominated instances of a
       single performance metric, as identified by metricname and the list
       of instance identifiers following the -i argument.  instances must be
       a single argument, with elements of the list separated by commas
       and/or white space.  By default all instances of metricname will be
       updated.

       Normally pmstore operates on the default Performance Metrics Name
       Space (PMNS), however if the -n option is specified an alternative
       namespace is loaded from the file pmnsfile.

       Unless directed to another host by the -h option, pmstore will
       interact with the Performance Metric Collector Daemon (PMCD) on the
       local host.

       The -L option causes pmstore to use a local context to store to
       metrics from PMDAs on the local host without PMCD.  Only some metrics
       are available in this mode.  The -h and -L options are mutually
       exclusive.

       The -f option forces the given value to be stored, even if there is
       no current value set.

       The interpretation of value is dependent on the syntax used in its
       specification and the underlying data type of metricname, as follows.

       1.  If the metric has an integer type, then value should be an
           optional leading hyphen, followed either by decimal digits or
           ``0x'' and some hexadecimal digits.  ``0X'' is also acceptable in
           lieu of ``0x''.  See strtol(3) and the related routines.

       2.  If the metric has a floating point type, then value should be
           either in the form of an integer described above, or a fixed
           point number, or a number in scientific notation.  See strtod(3).

       3.  If the metric has a string type, then value is interpreted as a
           literal string of ASCII characters.

       4.  If the metric has any other type (i.e.  PM_TYPE_EVENT or
           PM_TYPE_AGGREGATE) then no encoding of value from the command
           line makes sense, and the values of these metrics cannot be
           modified with pmstore.

       The output reports the old value and the new value for each updated
       instance of the requested metric.

       When using the -L option to fetch metrics from a local context, the
       -K option may be used to control the DSO PMDAs that should be made
       accessible.  The spec argument conforms to the syntax described in
       __pmSpecLocalPMDA(3).  More than one -K option may be used.

FILES         top

       $PCP_VAR_DIR/pmns/*
                 default PMNS specification files

PCP ENVIRONMENT         top

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

SEE ALSO         top

       pmcd(1), pminfo(1), pmval(1), __pmSpecLocalPMDA(3), strtod(3) and
       strtol(3).

DIAGNOSTICS         top

       Two messages indicate a mismatch between the internal data type for
       metricname and the value provided.

       The value "???" is out of range for the data type (PM_TYPE_...)

       The value "???" is incompatible with the data type (PM_TYPE_...)

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at ⟨http://www.pcp.io/⟩.
       If you have a bug report for this manual page, send it to
       pcp@oss.sgi.com.  This page was obtained from the project's upstream
       Git repository ⟨https://github.com/performancecopilot/pcp.git⟩ on
       2017-09-15.  If you discover any rendering problems in this HTML ver‐
       sion of the page, or you believe there is a better or more up-to-date
       source for the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original man‐
       ual page), send a mail to man-pages@man7.org

Performance Co-Pilot                 PCP                          PMSTORE(1)

Pages that refer to this page: pmcd(1)pmdacifs(1)pmdadm(1)pmdagfs2(1)pmdagluster(1)pmdaoracle(1)pmdapapi(1)pmdaproc(1)pmdaweblog(1)pmdaxfs(1)pcpintro(3)pmdastore(3)