KCML_PerfMetric_SectionSet

Purpose

Sets additional performance metrics for the current partition from the named section in /etc/kcml/msgq.conf

Definition

DEFSUB 'KCML_PerfMetric_SectionSet(section$, sToken$ = "") AS KCML_PERFMETRIC_STATUS_ENUM

Parameters

section	Section name
sToken	Optional. Security token with a SHA-256 signature.

Return

Returns a KCML_PERFMETRIC_STATUS_ENUM value.

Description

For processes that are not interactive or short-lived, there may be little opportunity to enable extra performance metrics using KCML_PerfMetric_Set. So an application can programmatically enable additional metrics from a in /etc/kcml/msgq.conf. The name of the section, in /etc/kcml/msgq.conf is prefixed with perfmetric:, so if passed a section$ of "env" then performance metrics will be loaded from a [perfmetric:env] section. Unlike the default metrics from the [perfmetric] section, which affect all partitions, these metrics are only enabled for the current partition. The optional sToken$ parameter is not required for background processes or if the [section] sets a suppressverify key to 1. The additional metrics can be disabled by calling KCML_PerfMetric_SectionClear.