Add `diagnosticsOptions` to settings.js

This commit is contained in:
Steve-Mcl 2022-03-28 18:50:12 +01:00
parent a2fd705153
commit cdc8a42393
1 changed files with 14 additions and 0 deletions

View File

@ -224,6 +224,7 @@ module.exports = {
/*******************************************************************************
* Runtime Settings
* - lang
* - diagnosticsOptions
* - logging
* - contextStorage
* - exportGlobalContextKeys
@ -236,6 +237,19 @@ module.exports = {
*/
// lang: "de",
/** ### Configure diagnostics options
* - `.enabled`: When `enabled` is `true` (or unset), diagnostics data will
* be available at http://localhost:1880/diagnostics
* - `.level`: When `level` is "basic" (or unset), the diagnostics will not
* include sensitive data. Set level to "admin" for detailed diagnostics
*/
diagnosticsOptions: {
/** @type {boolean} enable or disable diagnostics. Must be set to `false` to disable */
enabled: true,
/** @type {"basic"|"admin"} diagnostic level can be "basic" (default) or "admin" (more sensitive details are included) */
level: "basic",
},
/** Configure the logging output */
logging: {
/** Only console logging is currently supported */