PMUNREGISTERDERIVED(3)

NAME
pmUnregisterDerived - unregister a derived metric

C SYNOPSIS
#include <pcp/pmapi.h>

int pmUnregisterDerived(char *name);

cc ... -lpcp

DESCRIPTION
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
On success, pmUnregisterDerived returns a value greater than or equal to zero being the number of contexts from which name was removed.

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

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