XQuery admin:group-set-telemetry-metering

MarkLogic Server 11.0 Product Documentation
admin.groupSetTelemetryMetering

admin.groupSetTelemetryMetering(
   config as element(configuration),
   group-id as xs.unsignedLong,
   value as 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

const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
const spec = admin.groupSetTelemetryMetering(config,
  xdmp.group(),"raw")
admin.saveConfiguration(spec)
Powered by MarkLogic Server | Terms of Use | Privacy Policy