|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|
|
NAME | C SYNOPSIS | Perl SYNOPSIS | DESCRIPTION | DIAGNOSTICS | SEE ALSO | COLOPHON |
|
|
|
PMIGETHANDLE() PMIGETHANDLE()
pmiGetHandle - define a handle for a metric-instance pair
#include <pcp/pmapi.h>
#include <pcp/import.h>
int pmiGetHandle(const char *name, const char *instance);
cc ... -lpcp_import -lpcp
use PCP::LogImport;
$handle = pmiGetHandle($name, $instance);
As part of the Performance Co-Pilot Log Import API (see
LOGIMPORT(3)), pmiGetHandle creates a handle for a given metric
and instance. The handle is returned as the value from the
pmiGetHandle call and can be used in subsequent calls to
pmiPutValueHandle(3).
The metric's name should match one defined earlier in a call to
pmiAddMetric(3).
For singular metrics (those defined with an instance domain of
PM_INDOM_NULL), the instance should be NULL or an empty string,
otherwise instance should match the name of an instance defined
earlier in a call to pmiAddInstance(3) for the metric's instance
domain.
When combined with pmiPutValueHandle(3), the use of handles
provide a performance improvement over the alternative lookup for
a metric name and an instance name for each data value that is
required for pmiPutValue(3).
On failure pmiGetHandle returns a negative value that can be
turned into an error message by calling pmiErrStr(3).
LOGIMPORT(3), pmiAddInstance(3), pmiAddMetric(3), pmiErrStr(3)
and pmiPutValueHandle(3).
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 PMIGETHANDLE()
Pages that refer to this page: logimport(3), pmiaddinstance(3), pmiputvaluehandle(3), pmistart(3)
|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|