Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions man/man3/pmiaddinstance.3
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ pmiAddInstance($\fIindom\fP, $\fIinstance\fP, $\fIinst\fP);
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.pmiAddInstance(\fIindom\fP, \fIinstance\fP, \fIinstid\fP)
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
Expand Down
17 changes: 17 additions & 0 deletions man/man3/pmiaddmetric.3
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,23 @@ $\fIunits\fP);
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.pmiAddMetric(\fIname\fP,
'in +\w'log.pmiAddMetric('u
\fIpmid\fP,
\fItype\fP,
\fIindom\fP,
\fIsem\fP,
\fIunits\fP)
.in
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
Expand Down
10 changes: 10 additions & 0 deletions man/man3/pmiend.3
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ pmiEnd();
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.pmiEnd()
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
Expand Down
10 changes: 10 additions & 0 deletions man/man3/pmigethandle.3
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ $\fIhandle\fP = pmiGetHandle($\fIname\fP, $\fIinstance\fP);
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
\fIhandle\fP = log.pmiGetHandle(\fIname\fP, \fIinstance\fP)
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
Expand Down
16 changes: 16 additions & 0 deletions man/man3/pmiputlabel.3
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,22 @@ $\fIvalue\fP);
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.pmiPutLabel(\fItype\fP,
'in +\w'log.pmiPutLabel('u
\fIid\fP,
\fIinstance\fP,
\fIname\fP,
\fIvalue\fP)
.in
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
Expand Down
10 changes: 10 additions & 0 deletions man/man3/pmiputmark.3
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ pmiPutMark();
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.pmiPutMark()
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
Expand Down
68 changes: 47 additions & 21 deletions man/man3/pmiputresult.3
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
.\"
.TH PMIPUTRESULT 3 "" "Performance Co-Pilot"
.SH NAME
\f3pmiPutResult\f1 \- add a data record to a LOGIMPORT archive
\f3pmiPutResult\f1,
\f3pmiPutHighResResult\f1 \- add a data record to a LOGIMPORT archive
.SH "C SYNOPSIS"
.ft 3
.ad l
Expand All @@ -25,52 +26,76 @@
.br
#include <pcp/import.h>
.sp
int pmiPutResult(const pmResult *\fIresult\fP);
int pmiPutResult(const pmResult_v2 *\fIresult\fP);
.br
int pmiPutHighResResult(const pmResult *\fIresult\fP);
.sp
cc ... \-lpcp_import \-lpcp
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.put_result(\fIresult\fP)
.br
log.put_highres_result(\fIresult\fP)
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
.B pmiPutResult
provides an interface for developers familiar with the internal
these routines provide an interface for developers familiar with the internal
PCP data structures to create output archives directly.
.PP
By building the
By building a
.B pmResult
data structure directly, then calling
.B pmiPutResult
the developer avoids calls to
data structure directly and calling one of these routines, the developer
avoids the separate
.BR pmiPutValue (3)
and/or
.BR pmiPutValueHandle (3)
followed by a call to
.BR pmiWrite (3)
calls followed by
.BR pmiHighResWrite (3)
for each record written to the archive.
.PP
Any metrics and instances appearing in the
.B pmiPutHighResResult
is the preferred interface.
It accepts a
.B pmResult
with a
.B struct timespec
timestamp, giving nanosecond resolution and Y2038-safe 64-bit seconds.
.PP
.B pmiPutResult
accepts the older
.B pmResult_v2
type with a
.B struct timeval
timestamp (microsecond resolution).
.PP
Any metrics and instances appearing in
.I result
must have been defined by prior calls to
.BR pmiAddMetric (3)
and
.BR pmiAddInstance (3).
.PP
.B pmiPutResult
will arrange for any new metadata (metrics and/or instance domain changes)
covered by
Both routines will arrange for any new metadata (metrics and/or instance
domain changes) covered by
.I result
to be also written to the PCP archive.
to be written to the PCP archive.
.PP
Because of the complexity of the
.B pmResult
data structure, this routine is not available in the Perl
data structure, neither routine is available in the Perl
interface to the LOGIMPORT services.
.SH DIAGNOSTICS
.B pmiPutResult
returns zero on success else a negative value that can be turned into an
error message by calling
Both routines return zero on success else a negative value that can be
turned into an error message by calling
.BR pmiErrStr (3).
.SH SEE ALSO
.BR LOGIMPORT (3),
Expand All @@ -82,6 +107,7 @@ error message by calling
.BR pmiPutText (3),
.BR pmiPutLabel (3),
.BR pmiPutValueHandle (3),
.BR pmiSetTimezone (3)
.BR pmiSetTimezone (3),
.BR pmiHighResWrite (3)
and
.BR pmiWrite (3).
10 changes: 10 additions & 0 deletions man/man3/pmiputtext.3
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ pmiPutText($\fItype\fP, $\fIclass\fP, $\fIid\fP, $\fIcontent\fP);
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.pmiPutText(\fItype\fP, \fIcls\fP, \fIid\fP, \fIcontent\fP)
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
Expand Down
10 changes: 10 additions & 0 deletions man/man3/pmiputvalue.3
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ pmiPutValue($\fIname\fP, $\fIinstance\fP, $\fIvalue\fP);
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.pmiPutValue(\fIname\fP, \fIinstance\fP, \fIvalue\fP)
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
Expand Down
34 changes: 30 additions & 4 deletions man/man3/pmiputvaluehandle.3
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'\"macro stdmacro
.\"
.\" Copyright (c) 2010 Ken McDonell. All Rights Reserved.
.\" Copyright (c) 2018 Red Hat.
.\" Copyright (c) 2018,2026 Red Hat.
.\"
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
Expand All @@ -16,6 +16,7 @@
.\"
.TH PMIPUTVALUEHANDLE 3 "" "Performance Co-Pilot"
.SH NAME
\f3pmiPutAtomValueHandle\f1,
\f3pmiPutValueHandle\f1 \- add a value for a metric-instance pair via a handle
.SH "C SYNOPSIS"
.ft 3
Expand All @@ -25,6 +26,8 @@
.br
#include <pcp/import.h>
.sp
int pmiPutAtomValueHandle(int \fIhandle\fP, pmAtomValue *\fIatom\fP);
.br
int pmiPutValueHandle(int \fIhandle\fP, const char *\fIvalue\fP);
.sp
cc ... \-lpcp_import \-lpcp
Expand All @@ -41,17 +44,37 @@ pmiPutValueHandle($\fIhandle\fP, $\fIvalue\fP);
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.pmiPutValueHandle(\fIhandle\fP, \fIvalue\fP)
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
.B pmiPutAtomValueHandle
and
.B pmiPutValueHandle
adds a single value to the current output record for a given
add a single value to the current output record for a given
metric and instance, using the
.I handle
defined by an earlier call to
.BR pmiGetHandle (3).
.PP
The
With
.B pmiPutAtomValueHandle
the
.I atom
passes the binary value directly using a union of types.
.PP
In the case of
.B pmiPutValueHandle
the
.I value
should be in a format consistent with the metric's type as
defined in the call to
Expand All @@ -60,15 +83,18 @@ defined in the call to
No data will be written until
.BR pmiWrite (3)
is called, so multiple calls to
.BR pmiPutAtomValueHandle ,
.B pmiPutValueHandle
or
.BR pmiPutValue (3)
are typically used to accumulate data values for several
metric-instance pairs before calling
.BR pmiWrite (3).
.SH DIAGNOSTICS
.B pmiPutAtomValueHandle
and
.B pmiPutValueHandle
returns zero on success else a negative value that can be turned into an
return zero on success else a negative value that can be turned into an
error message by calling
.BR pmiErrStr (3).
.SH SEE ALSO
Expand Down
10 changes: 10 additions & 0 deletions man/man3/pmisethostname.3
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ pmiSetHostname($\fIvalue\fP);
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.pmiSetHostname(\fIvalue\fP)
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
Expand Down
10 changes: 10 additions & 0 deletions man/man3/pmisettimezone.3
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ pmiSetTimezone($\fIvalue\fP);
.hy
.ad
.ft 1
.SH "Python SYNOPSIS"
.ft 3
.ad l
.hy 0
from pcp import pmi
.sp
log.pmiSetTimezone(\fIvalue\fP)
.hy
.ad
.ft 1
.SH DESCRIPTION
As part of the Performance Co-Pilot Log Import API (see
.BR LOGIMPORT (3)),
Expand Down
Loading
Loading