pmunregisterderived(3) — Linux manual page

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

PMUNREGISTERDERIVED(3)   Library Functions Manual  PMUNREGISTERDERIVED(3)

NAME         top

       pmUnregisterDerived  - unregister a derived metric

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmUnregisterDerived(char *name);

       cc ... -lpcp

DESCRIPTION         top

       Derived metrics provide a way of extending the Performance Metrics
       Name  Space (PMNS) with new metrics defined at the PCP client-side
       using expressions over the existing performance metrics.

       Global    derived    metrics    are     created     by     calling
       pmRegisterDerived(3),         pmRegisterDerivedMetric(3)        or
       pmLoadDerivedConfig(3).  Per-context derived metrics  are  created
       by calling pmAddDerived(3) or pmAddDerivedMetric(3).

       pmUnregisterDerived  removes  the definition of the derived metric
       name from the set of glabal derived metrics and from every  active
       PMAPI context.

DIAGNOSTICS         top

       On  success,  pmUnregisterDerived  returns a value greater than or
       equal to zero being the number of contexts from which name was re‐
       moved.

       Othewise pmUnregisterDerived returns a PMAPI error and the  appli‐
       cation should call pmErrStr(3) to retrieve the corresponding error
       message.

SEE ALSO         top

       PCPIntro(1),   PMAPI(3),  pmAddDerived(3),  pmAddDerivedMetric(3),
       pmErrStr(3),     pmLoadDerivedConfig(3),     pmRegisterDerived(3),
       pmRegisterDerivedMetric(3) and PMNS(5).

COLOPHON         top

       This  page is part of the PCP (Performance Co-Pilot) project.  In‐
       formation 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@groups.io.  This page was obtained from the project's upstream
       Git repository ⟨https://github.com/performancecopilot/pcp.git⟩  on
       2026-01-16.   (At  that  time,  the date of the most recent commit
       that was found in the repository was 2026-01-16.)  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 man-pages@man7.org

Performance Co-Pilot                               PMUNREGISTERDERIVED(3)

Pages that refer to this page: pmaddderived(3)pmloadderivedconfig(3)pmregisterderived(3)