Loading TOC...

admin.groupSetTelemetryConfig

admin.groupSetTelemetryConfig(
   config as element(configuration),
   group-id as xs.unsignedLong,
   value as String
) as element(configuration)

Summary

This function sets the update frequency for configuration changes sent to telemetry, would also be the maximum frequency at which updates 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 frequency at which configuration file updates will be sent to the Secure Telemetry Storage.

This must be one of "disabled","frequent","infrequent".
If "frequent", then all configuration changes will be sent.
If "infrequent" then only periodic snapshots will be sent.
If "disabled" then no configuration files are sent.

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.groupSetTelemetryConfig(config,
  xdmp.group(),"frequent")
admin.saveConfiguration(spec)

     

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.