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

MarkLogic Server 11.0 Product Documentation
admin.groupSetPerformanceMeteringEnabled

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

Summary

This function enables or disables performance metering for all hosts in the specified group. Performance metering will save data into the meters database which can be used to analyze your system performance over time.

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	A boolean value specifying whether performance metering is enabled for all hosts in this group.

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.groupSetPerformanceMeteringEnabled(config, groupid, fn.true())

   //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.groupSetPerformanceMeteringEnabled

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.groupSetPerformanceMeteringEnabled