PMLOOKUPTEXT(3) Library Functions Manual PMLOOKUPTEXT(3)NAME
pmLookupText - return text describing a performance metric
C SYNOPSIS
#include <pcp/pmapi.h>
int pmLookupText(pmID pmid, int level, char **buffer);
cc ... -lpcp
DESCRIPTION
Provided the source of metrics from the current Performance Metrics Application Programming Interface (PMAPI) context is a host, retrieve
descriptive text about the performance metric identified by pmid.
The argument level should be PM_TEXT_ONELINE for a one-line summary, else PM_TEXT_HELP for a more verbose description, suited to a help
dialog.
The space pointed to by buffer will have been allocated in pmLookupText with malloc(3C), and it is the responsibility of the caller to
free(3C) the space when it is no longer required.
pmLookupText returns zero on success.
SEE ALSO chkhelp(1), newhelp(1), PMAPI(3), pmGetConfig(3), pmLookupDesc(3), pmLookupInDomText(3), pcp.conf(5) and pcp.env(5).
DIAGNOSTICS
PM_ERR_NOTHOST
if the current PMAPI context is an archive log (help and one-line text is not maintained in the archive logs)
Performance Co-Pilot PCP PMLOOKUPTEXT(3)
Check Out this Related Man Page
PMDATEXT(3) Library Functions Manual PMDATEXT(3)NAME
pmdaText - extract metric help text for a PMDA
C SYNOPSIS
#include <pcp/pmapi.h>
#include <pcp/impl.h>
#include <pcp/pmda.h>
int pmdaText(int ident, int type, char **buffer, pmdaExt *pmda);
cc ... -lpcp_pmda -lpcp
DESCRIPTION
As part of the Performance Metrics Domain Agent (PMDA) API (see PMDA(3)), pmdaText uses the standard PMDA(3) data structures to return the
help text for metric ident in buffer. The help text must be located in help text files created with newhelp(1), and the associated files
are automatically opened by pmdaInit(3).
The path to the (basename of the) help text files can be set in the calls to pmdaDSO(3) or pmdaDaemon(3) and overridden by the -h command
line option in pmdaGetOpt(3).
The encoding of ident follows the internal scheme used below the routines pmLookupText(3) and pmLookupInDomText(3), namely ident encodes
either a metric identifier or an instance domain identifier, according to the value of type.
The type argument is a bit mask that encodes the interpretation of ident and the requested form of help text, as follows: either
PM_TEXT_PMID if ident is a metric identifier, or PM_TEXT_INDOM if ident is an instance domain identifier, plus either PM_TEXT_ONELINE for
the one line help text or PM_TEXT_HELP for the full help text.
The buffer is managed internally (usually it is cached), and it should not be released or freed by the caller of pmdaText.
DIAGNOSTICS
If the requested help text could not be obtained, pmdaText will return PM_ERR_TEXT.
CAVEAT
The PMDA must be using PMDA_PROTOCOL_2 or later, as specified in the call to pmdaDSO(3) or pmdaDaemon(3).
SEE ALSO newhelp(1), malloc(3), PMAPI(3), PMDA(3), pmdaDaemon(3), pmdaDSO(3), pmdaInit(3), pmLookupInDomText(3) and pmLookupText(3).
Performance Co-Pilot PCP PMDATEXT(3)
Hello,
I would like get idea about performance enginering from basic to advanced level. Do anyone know a place where i can find some videos related to performance engineering ? (5 Replies)