pmgetpmnslocation(3) — Linux manual page

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

PMGETPMNSLOCATION(3)    Library Functions Manual    PMGETPMNSLOCATION(3)

NAME         top

       pmGetPMNSLocation - determine the location of the currently used
       PMNS

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmGetPMNSLocation(void);

       cc ... -lpcp

DESCRIPTION         top

       If an application needs to know where the Performance Metrics
       Name Space (PMNS) is coming from then pmGetPMNSLocation will
       return whether it is from an archive, PMNS_ARCHIVE, or from a
       local PMNS file, PMNS_LOCAL, or from a remote pmcd, PMNS_REMOTE.

       This information may be useful in determining an appropriate
       error message depending on the PMNS' location.

DIAGNOSTICS         top

       PM_ERR_NOPMNS
              If is not possible to determine where the location of the
              PMNS is.  This could be due to problems with the current
              context or being unable to load a local PMNS.

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).  Values for these variables may be obtained
       programmatically using the pmGetConfig(3) function.

SEE ALSO         top

       PMAPI(3), pmGetConfig(3), pmLoadASCIINameSpace(3),
       pmLoadNameSpace(3), pmTrimNameSpace(3), pcp.conf(5), pcp.env(5)
       and PMNS(5).

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 [email protected].  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2024-06-14.
       (At that time, the date of the most recent commit that was found
       in the repository was 2024-06-14.)  If you discover any rendering
       problems in this HTML version 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 manual page), send a mail to
       [email protected]

Performance Co-Pilot               PCP              PMGETPMNSLOCATION(3)