Edit online

How to Access Instance Logs

Log File Location

Logs are written to the logs subdirectory of your Feedback installation directory.

You can configure a different location by running the application with the following argument:

-Dlogging.file.path=new/path

Log History

Oxygen Feedback Enterprise keeps a history of a maximum of 10 log files, but that can be configured inside {oxygen-feedback-installation-dir}/feedback-logback.xml as follows:

<property name="LOG_FILE_MAX_HISTORY" value="20"/>

Log Levels

The possible logging levels are (in order of precedence): TRACE, DEBUG, INFO, WARN, and ERROR. This means that TRACE provides the most verbose logging while ERROR provides the least.

If a logger is not explicitly assigned a level, it inherits the level of its closest ancestor.

You can change the logger level by editing the following fragment inside {oxygen-feedback-installation-dir}/feedback-logback.xml:

<logger name="com.oxygenxml.webhelp.feedback" level="info" additivity="false">
	<appender-ref ref="FILE" />
	<appender-ref ref="CONSOLE"/>
</logger>  

How to Receive Logs via Email

To receive logs via email, define a custom email appender by using this procedure:
  1. Edit the {oxygen-feedback-installation-dir}/feedback-logback.xml file and add the following lines to set up an email appender:
    <appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
         <smtpHost>[smtp mail host]</smtpHost>
         <smtpPort>[smtp mail port]</smtpPort>	    
         <!-- One or more recipients are possible -->
         <to>recipient@example.com</to>
         <from>sender@example.com</from>
         <!-- Define custom e-mail subject -->
         <subject>Oxygen Feedback: %logger{20} - %msg</subject>
         <!-- Custom e-mail body -->
         <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{35} - %msg%n</pattern>
         </layout>
    </appender>
  2. Add this appender to the root element of the feedback-logback.xml file:
    <root level="INFO">
        <appender-ref ref="EMAIL"/>
    </root>
    Note: The level attribute values can be: ALL, INFO, DEBUG, WARN, ERROR.
  3. Save the modifications and restart Oxygen Feedback Enterprise.