pmiInDom3

C synopsis

#include <pcp/pmapi.h>
#include <pcp/import.h>

pmID pmiID(int domain, int cluster, int item);
pmInDom pmiInDom(int domain, int serial);
pmUnits pmiUnits(int dimSpace, int dimTime, int dimCount, unsigned int scaleSpace, unsigned int scaleTime, unsigned int scaleCount);
pmUnits pmiExtraUnits(int dimSpace, int dimTime, int dimCount, unsigned int scaleSpace, unsigned int scaleTime, unsigned int scaleCount, int extraUnit, unsigned int extraScale);

cc ... -lpcp_import -lpcp

Perl SYNOPSIS

use PCP::LogImport;

$pmid = pmiID($domain, $cluster, $item);
$indom = pmiInDom($domain, $serial);
$units = pmiUnits($dimSpace, $dimTime, $dimCount, $scaleSpace, $scaleTime, $scaleCount);
$units = pmiExtraUnits($dimSpace, $dimTime, $dimCount, $scaleSpace, $scaleTime, $scaleCount, $extraUnit, $extraScale);

Python SYNOPSIS

from pcp import pmi

pmid = pmi.pmiLogImport.pmiID(domain, cluster, item)
indom = pmi.pmiLogImport.pmiInDom(domain, serial)
units = pmi.pmiLogImport.pmiUnits(dim_space, dim_time, dim_count, scale_space, scale_time, scale_count)

Overview

As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), these routines provide convenience methods (especially for script use) for constructing pmID, pmInDom and pmUnits structures respectively, to be used in subsequent calls to pmiAddMetric(3) and pmiAddInstance(3).

Refer to pmLookupDesc(3) for a complete description of the values and semantics of the components of a pmUnits structure, and hence the valid argument values for pmiUnits and pmiExtraUnits.