Revision as of 12:40, January 11, 2024 by Xavier (talk | contribs)
Jump to: navigation, search

WFM Server:Log:x-json-log

verbose

Section: Log
Default Value: standard
Valid Values: all, debug, trace, standard, none, yes (= all), no (= none)
Changes Take Effect: Immediately
Dependencies: None

This option is mandatory.

Specifies whether or not a log output is created and if it is, sets the minimum level of log events generated. The log events levels, starting with the highest priority level, are Standard, Trace, and Debug.

The valid values are described, as follows:

  • all—All log events (that is, Standard, Trace, and Debug levels) are generated.
  • debug—The same as all.
  • trace—Log events of the Trace level and higher (that is, Standard, and Trace levels) are generated, but log events of the Debug level are not generated.
  • standard—Log events of the Standard level are generated, but log events of the Trace, and Debug levels are not generated.
  • none—No output is produced.

verbose

Section: Log
Default Value: standard
Valid Values: all, debug, trace, standard, none, yes (= all), no (= none)
Changes Take Effect: Immediately
Dependencies: None

This option is mandatory.

Specifies whether or not a log output is created and if it is, sets the minimum level of log events generated. The log events levels, starting with the highest priority level, are Standard, Trace, and Debug.

The valid values are described, as follows:

  • all—All log events (that is, Standard, Trace, and Debug levels) are generated.
  • debug—The same as all.
  • trace—Log events of the Trace level and higher (that is, Standard, and Trace levels) are generated, but log events of the Debug level are not generated.
  • standard—Log events of the Standard level are generated, but log events of the Trace, and Debug levels are not generated.
  • none—No output is produced.


{{DraftOption |default="" (empty string) |valid=stdout, stderr, [filename with or without path] |takeseffect=After restart |shortdesc=Enables the JSON logging for WFM servers, if not empty.

WFM now supports structured logging to the file containing one-line log records formatted in JSON format. This facilitates easy integration with the centralized log aggregation and viewing systems, like Grafana/Loki.

Important

The log level for structured logging is the same as for logging to a file and is defined by a regular verbose option.

View in ref guide.

Edit this option          Publish this option          Clear draft content


Published Option

x-json-log

Default Value: "" (empty string)
Valid Values: stdout, stderr, [filename with or without path]
Changes Take Effect: After restart
Introduced: 8.5.220.08

Enables the JSON logging for WFM servers, if not empty.

WFM now supports structured logging to the file containing one-line log records formatted in JSON format. This facilitates easy integration with the centralized log aggregation and viewing systems, like Grafana/Loki.

Important

The log level for structured logging is the same as for logging to a file and is defined by a regular verbose option.

Important

All x-json-log configuration options are not included in the application template. You can configure them manually.

Sample Configuration 

[Log]
x-json-log = c:\logs\structured-log.log
x-json-log.rotation = 10 M
x-json-log.archive = timestamp
x-json-log.purgeCount = 10
x-json-log.purgeAge = 30 days
x-json-log.rotateOnOpen = true
x-json-log.compress = true
x-json-log.times = local
x-json-log.flush = false

Draft Option

No draft option


Comments or questions about this documentation? Contact us for support!