JavaScript admin.groupSetTelemetryLogLevel

MarkLogic 10 Product Documentation
admin:group-set-telemetry-log-level

admin:group-set-telemetry-log-level(
   $config as element(configuration),
   $group-id as xs:unsigned-long,
   $value as xs: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.
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



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-log-level($config, xdmp:group(),
   admin:group-get-file-log-level($config,xdmp:group() ))
return
admin:save-configuration($spec)

(: sets the telemetry log level to match the server's file log level :)
Powered by MarkLogic Server | Terms of Use | Privacy Policy