Skip to end of metadata
Go to start of metadata

Diagram

Elements

Logging - LoggingType
References Notes

YADE uses the log4j framework for logging and makes use of the following loggers:

  • rootLogger
  • reportLogger
where the output of the reportLogger is more compact than the rootLogger output.

These loggers are configured by a log4j configuration file which determines that the

  • rootLogger logs to stdout.
  • reportLogger optionally logs to a file.

If the log4j configuration file is not found then a log4j base configuration is used which logs to stdout.

Element Type Required Description
LogFile string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

YADE makes use of the following log4j loggers:

  • rootLogger which logs to stdout
  • reportLogger which logs to a file

This parameter specifies the location of the file to which the log output of the reportLogger will be written. Should the file not exist then it will be created. If the file already exists then all log output will be appended.

Without specifying this parameter all log output of the reportLogger will be written to

  • JobScheduler releases starting from 1.13.3
    • JobScheduler Master / Agent
      • ${scheduler_data}/logs/YADE.log
    • YADE Client
      • Windows - ${java.io.tmpdir}/YADE.log
      • Unix - ${java.io.tmpdir}/${user.name}/YADE.log
  • JobScheduler releases before 1.13.3
    • Windows - ${java.io.tmpdir}/Jade-client.log
    • Unix - ${java.io.tmpdir}/${user.name}/Jade-client.log
Log4JPropertyFile string
  • Min: 1
  • Whitespace: preserve
  • Occurrence: 0..1
Optional
References Notes

This parameter specifies the location of a log4j configuration file. Without this parameter the following configuration is used:

  • JobScheduler releases starting from 1.13.3 (Log4j 2)
    • JobScheduler Master / Agent
      • JadeReportLog logger in the ${scheduler_install}/lib/log4j2.xml configuration file.
    • YADE Client
      • JadeReportLog logger in the <yade client>/bin/log4j2.xml configuration file.
  • JobScheduler releases before 1.13.3 (Log4j)
    • log4j.rootLogger=info, stdout
      log4j.logger.JadeReportLog=info, JadeReportLog
      log4j.logger.JadeReportLog.SOSVfsReportLog=info, JadeReportLog
      #log4j.logger.JadeReportLog=info, JadeReportLog, JadeReportLogHTML
      #log4j.logger.JadeReportLog.SOSVfsReportLog=info, JadeReportLog, JadeReportLogHTML
      log4j.additivity.JadeReportLog = false
      log4j.additivity.JadeReportLog.SOSVfsReportLog = false

      log4j.appender.stdout=org.apache.log4j.ConsoleAppender
      log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
      log4j.appender.stdout.layout.ConversionPattern=%t %-5p %-14d{HH:mm:ss,SSS} (%F:%L) ::%M %m %n

      # Configuration of JadeHTMLReportLog
      log4j.appender.JadeReportLogHTML=org.apache.log4j.FileAppender
      log4j.appender.JadeReportLogHTML.layout=com.sos.JSHelper.Logging.SOSHtmlLayout
      log4j.appender.JadeReportLogHTML.File=${java.io.tmpdir}/Jade-client.html
      log4j.appender.JadeReportLogHTML.Append=false
      log4j.appender.JadeReportLogHTML.layout.Title=YADE Report Log

      # Configuration of JadeReportLog
      log4j.appender.JadeReportLog=org.apache.log4j.RollingFileAppender
      log4j.appender.JadeReportLog.File=${java.io.tmpdir}/Jade-client.log
      log4j.appender.JadeReportLog.MaxFileSize=5000KB
      log4j.appender.JadeReportLog.MaxBackupIndex=30
      log4j.appender.JadeReportLog.layout=org.apache.log4j.PatternLayout
      log4j.appender.JadeReportLog.layout.ConversionPattern=%-21d{HH:mm:ss,SSS}%m %n
DebugLevel integer
  • Pattern: [\-+]?[0-9]+
  • Whitespace: collapse
  • Enumeration:
    • 0
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
  • Occurrence: 0..1
Optional
References Notes

YADE makes use of the following log4j loggers:

  • rootLogger which logs to stdout
  • reportLogger which logs to a file

The debug level specifies the verbosity of the rootLogger log entries. A value between 1 and 9 can be specified. Higher values cause more detailed information to be logged.

ProtocolCommandListener boolean
  • Whitespace: collapse
  • Occurrence: 0..1
Optional
References Notes

YADE makes use of the following log4j loggers:

  • rootLogger which logs to stdout
  • reportLogger which logs to a file

This parameter activates the logging of the Apache Commons FTP Client. All output will be written by the rootLogger to stdout.

 

Explanations

YADE uses the log4j framework for logging and makes use of two loggers:

  • rootLogger
  • reportLogger

where the output of the reportLogger is more compact than rootLogger output.

Both loggers are configured by a log4j.properties file such as

Example log4j.properties configuration file
log4j.rootLogger=info, stdout
log4j.logger.JadeReportLog=info, JadeReportLog
log4j.logger.JadeReportLog.SOSVfsReportLog=debug, JadeReportLog
#log4j.logger.JadeReportLog=debug, JadeReportLog, JadeReportLogHTML
#log4j.logger.JadeReportLog.SOSVfsReportLog=debug, JadeReportLog, JadeReportLogHTML
log4j.additivity.JadeReportLog = false
log4j.additivity.JadeReportLog.SOSVfsReportLog = false

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%t %-5p %-14d{HH:mm:ss,SSS} (%F:%L) ::%M %m %n

# Configuration of JadeHTMLReportLog
log4j.appender.JadeReportLogHTML=org.apache.log4j.FileAppender
log4j.appender.JadeReportLogHTML.layout=com.sos.JSHelper.Logging.SOSHtmlLayout
log4j.appender.JadeReportLogHTML.File=${java.io.tmpdir}/Jade-client.html
log4j.appender.JadeReportLogHTML.Append=false
log4j.appender.JadeReportLogHTML.layout.Title=YADE Report Log

# Configuration of JadeReportLog
log4j.appender.JadeReportLog=org.apache.log4j.RollingFileAppender
log4j.appender.JadeReportLog.File=${java.io.tmpdir}/Jade-client.log
log4j.appender.JadeReportLog.MaxFileSize=5000KB
log4j.appender.JadeReportLog.MaxBackupIndex=30
log4j.appender.JadeReportLog.layout=org.apache.log4j.PatternLayout
log4j.appender.JadeReportLog.layout.ConversionPattern=%-21d{HH:mm:ss,SSS}%m %n

 

  • Line 1 detemines that the rootLogger logs to stdout (ConsoleAppender)
  • Line 2 detemines that the reportLogger logs into a file (RollingFileAppender)
    • The location of this file (Line 22) will be overwritten by the LogFile parameter.

 

 

  • No labels
Write a comment…