XQuery admin:group-set-telemetry-log-level

MarkLogic 10 Product Documentation
admin.groupSetTelemetryLogLevel

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

Summary

This function sets the initial log level for telemetry, which is also the maximum (finest) log level 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.

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 (finest) log level at which telemetry will collect and forward logs. This must be either "disabled" or one of the levels defined in `admin:group-set-file-log-level()` (must be one of `finest`, `finer`, `fine`, `debug`, `config`, `info`, `notice`, `warning`, `error`, `critical`, `alert`, `emergency`). If set to "disabled" then no log file data will be collected or sent to telemetry. Note: The logfile data collected by telemetry is unaffected by other log level settings such as `admin:group-set-log-level()`. For example you may configure telemetry to send "fine" log file data to assist in a support case, while only collecting "info" level in the Logs directory.

value

The maximum (finest) log level at which telemetry will collect and forward logs. This must be either "disabled" or one of the levels defined in admin:group-set-file-log-level() (must be one of finest, finer, fine, debug, config, info, notice, warning, error, critical, alert, emergency).

If set to "disabled" then no log file data will be collected or sent to telemetry.

Note: The logfile data collected by telemetry is unaffected by other log level settings such as admin:group-set-log-level().

For example you may configure telemetry to send "fine" log file data to assist in a support case, while only collecting "info" level in the Logs directory.

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.groupSetTelemetryLogLevel(config, xdmp.group(),
   admin.groupGetFileLogLevel(config,xdmp.group() ))
return
admin.saveConfiguration(spec)

 //sets the telemetry log level to match the server's file log level

MarkLogic 10 Product Documentationadmin.groupSetTelemetryLogLevel

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin.groupSetTelemetryLogLevel