|
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 | Python SYNOPSIS | DESCRIPTION | SEE ALSO | COLOPHON |
|
|
|
LOGIMPORT(3) Library Functions Manual LOGIMPORT(3)
LOGIMPORT - introduction to the library for importing data and
creating a PCP archive
#include <pcp/pmapi.h>
#include <pcp/import.h>
cc ... -lpcp_import -lpcp
use PCP::LogImport;
from pcp import pmi
The Performance Co-Pilot Log Import (LOGIMPORT) API is a library
(with Perl and Python wrappers) that supports the creation of PCP
archives from external sources of performance data, either in the
form of historical logs and spreadsheets or from real-time
sources that are not integrated as a Performance Metrics Domain
Agent (PMDA) under the control of pmcd(1).
The typical usage for LOGIMPORT would involve:
• An initial call to pmiStart(3).
• Optional calls to pmiSetHostname(3) and/or pmiSetTimezone(3)
to set the hostname and timezone for the source of the
performance data.
• One or more calls to pmiAddMetric(3) to define performance
metrics.
• One or more calls to pmiAddInstance(3) to define instances
associated with the metrics.
• Optional calls to pmiGetHandle(3) to defined convenience
handles for metric-instance pairs.
• A main loop in which performance data is ingested and for each
sample time interval, the PCP archive record is constructed by
calls to pmiPutValue(3), pmiPutValueHandle(3), pmiPutText(3),
and/or pmiPutLabel(3), followed by a call to pmiWrite(3) to
flush all data and any associated new metadata to the PCP
archive. Alternatively, pmiPutResult(3) could be used to
package and process all the data for one sample time interval.
• Once the input source of data has been consumed, calling
pmiEnd(3) to complete the PCP archive creation and close all
open files.
If new metrics and/or instances are discovered during the data
ingestion, these can be added by subsequent calls to
pmiAddMetric(3) and/or pmiAddInstance(3), provided all the
metrics and instances have been defined before a call to
pmiGetHandle(3), pmiPutValue(3)or pmiPutResult(3) that references
those metrics and instances.
pmcd(1), pmlogger(1), PMAPI(3), pmiAddInstance(3),
pmiAddMetric(3), pmiEnd(3), pmiErrStr(3), pmiGetHandle(3),
pmiPutLabel(3), pmiPutMark(3), pmiPutResult(3), pmiPutText(3),
pmiPutValue(3), pmiPutValueHandle(3), pmiSetHostname(3),
pmiSetTimezone(3), pmiStart(3) and pmiWrite(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 pcp@groups.io. 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
man-pages@man7.org
Performance Co-Pilot LOGIMPORT(3)
Pages that refer to this page: collectl2pcp(1), ganglia2pcp(1), iostat2pcp(1), mrtg2pcp(1), pcpcompat(1), pcpintro(1), pmlogpaste(1), sar2pcp(1), sheet2pcp(1), pmdiscoversetup(3), pmgetarchivelabel(3), pmiaddinstance(3), pmiaddmetric(3), pmiend(3), pmierrstr(3), pmigethandle(3), pmiputlabel(3), pmiputmark(3), pmiputresult(3), pmiputtext(3), pmiputvalue(3), pmiputvaluehandle(3), pmisethostname(3), pmisettimezone(3), pmisetversion(3), pmistart(3), pmiunits(3), pmiusecontext(3), pmiwrite(3), LOGARCHIVE(5)
|
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. |
|