XQuery admin:group-set-performance-metering-period

MarkLogic Server 11.0 Product Documentation
admin.groupSetPerformanceMeteringPeriod

admin.groupSetPerformanceMeteringPeriod(
   config as element(configuration),
   group-id as (Number|String),
   value as Number
) as element(configuration)

Summary

This function sets the period (in number of seconds) between when performance data is gathered. setting it to a higher number stores less data but also gives less grainular data; setting it to a lower number stores more data but provides higher grainularity.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
group-id	The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
value	The number of seconds between data samples. This value must be 60 or greater, in multiples of 60 (one minute increments).

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{id}

Example

const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
const groupid = admin.groupGetId(config, "Default")
admin.groupSetPerformanceMeteringPeriod(config, groupid, 60)

   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.

MarkLogic Server 11.0 Product Documentationadmin.groupSetPerformanceMeteringPeriod

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.groupSetPerformanceMeteringPeriod