JavaScript admin.groupSetPerformanceMeteringEnabled

MarkLogic Server 11.0 Product Documentation
admin:group-set-performance-metering-enabled

admin:group-set-performance-metering-enabled(
   $config as element(configuration),
   $group-id as xs:unsignedLong,
   $value as xs: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


xquery version "1.0-ml";

import module namespace admin = "http://marklogic.com/xdmp/admin"
		  at "/MarkLogic/admin.xqy";

let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-performance-metering-enabled($config, $groupid, fn:true())

  (: returns the new configuration element -- use admin:save-configuration
     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:group-set-performance-metering-enabled

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin:group-set-performance-metering-enabled