JavaScript admin.groupSetTelemetryMetering

MarkLogic Server 11.0 Product Documentation
admin:group-set-telemetry-metering

admin:group-set-telemetry-metering(
   $config as element(configuration),
   $group-id as xs:unsigned-long,
   $value as xs:string
) as element(configuration)

Summary

This function sets the level of metering data sent to telemetry. This is also the maximum level of information that will be sent.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
group-id	The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
value	The maximum level of detail for metering data updates sent to the Secure Telemetry Storage. Must be one of "disabled","raw","hourly","daily". These correspond to data collected by metering. Raw data is collected according to the period set by `admin:group-set-performance-metering-period()` and includes Hourly and Data aggregates. Hourly metering data is collected hourly and includes Daily data. Daily metering data is collected daily.

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 $spec := admin:group-set-telemetry-metering($config,
  xdmp:group(),"raw")
return
admin:save-configuration($spec)

MarkLogic Server 11.0 Product Documentationadmin:group-set-telemetry-metering

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin:group-set-telemetry-metering