Jump to: navigation, search

Web Engagement Cluster:log:affectedLoggers
(Rpfeiffer used the OptionPublish action.)
Line 7: Line 7:
 
}}
 
}}
 
{{DraftOption
 
{{DraftOption
−
|hidden=false
 
−
|default=The default value is an empty string, which means that there aren't any affected loggers.
 
−
|valid=Comma-separated list of logger names, specified in the LOG4J2.xml. For example: com.genesyslab.webme.commons,PROTOCOL,org.apache.cassandra
 
−
|takeseffect=Immediately
 
−
|shortdesc=Verbosity settings are explicitly applied for loggers, as specified in the extended description.
 
 
}}
 
}}
 
{{PubExtended
 
{{PubExtended
Line 27: Line 22:
 
#The default <tt>log4j2.xml</tt> file contains the following logger: <tt><logger name="com.genesyslab.platform" level="info" additivity="false"></tt>
 
#The default <tt>log4j2.xml</tt> file contains the following logger: <tt><logger name="com.genesyslab.platform" level="info" additivity="false"></tt>
 
#Include <tt>com.genesyslab.platform</tt> in the value for the <tt>affectedLoggers</tt> option.
 
#Include <tt>com.genesyslab.platform</tt> in the value for the <tt>affectedLoggers</tt> option.
−
#Set the [[log#verbose{{!}}verbose]] option to <tt>debug</tt>.
+
#Set the [[Documentation:Options:GWE:GWECluster-log:{{PONYDOCSVERSION}}#verbose{{!}}verbose]] option to <tt>debug</tt>.
  
 
In the sample above, the value of <tt>affectedLoggers</tt> should be <tt>com.genesyslab.platform</tt>. Error (but no debug or info) messages from Cassandra will be available in logs, and debug messages from <tt>com.genesyslab.platform</tt> will be available in logs.
 
In the sample above, the value of <tt>affectedLoggers</tt> should be <tt>com.genesyslab.platform</tt>. Error (but no debug or info) messages from Cassandra will be available in logs, and debug messages from <tt>com.genesyslab.platform</tt> will be available in logs.
 
}}
 
}}
 
{{DraftExtended
 
{{DraftExtended
−
|moredesc='''Extended Description:''' Verbosity settings are explicitly applied for the following loggers:
 
−
*Loggers that are not declared explicitly in the <tt>log4j2.xml</tt> configuration file.
 
−
*Loggers that are specified explicitly in the <tt>log4j2.xml</tt> and are specified in the value for this <tt>affectedLoggers</tt> option.
 
−
For other loggers specified in <tt>log4j2.xml</tt>, but not mentioned in the value for this option, the verbosity level is not re-applied.
 
−
 
−
Here is a use case for when you might need to set this option:
 
−
*Cassandra needs to write error messages to a log file, and at the same time, Genesys components also need to write debug messages to the log file.
 
−
 
−
To resolve this use case, you would:
 
−
#Specify the following logger in <tt>log4j2.xml</tt>: <tt><logger name="org.apache.cassandra" level="error" additivity="false"></tt>
 
−
#'''Do not''' include <tt>org.apache.cassandra</tt> in the value for the <tt>affectedLoggers</tt> option.
 
−
#The default <tt>log4j2.xml</tt> file contains the following logger: <tt><logger name="com.genesyslab.platform" level="info" additivity="false"></tt>
 
−
#Include <tt>com.genesyslab.platform</tt> in the value for the <tt>affectedLoggers</tt> option.
 
−
#Set the [[Documentation:Options:GWE:GWECluster-log:{{PONYDOCSVERSION}}#verbose{{!}}verbose]] option to <tt>debug</tt>.
 
−
 
−
In the sample above, the value of <tt>affectedLoggers</tt> should be <tt>com.genesyslab.platform</tt>. Error (but no debug or info) messages from Cassandra will be available in logs, and debug messages from <tt>com.genesyslab.platform</tt> will be available in logs.
 
 
}}
 
}}
 
{{OptionCreate
 
{{OptionCreate

Revision as of 00:15, March 21, 2018


View in ref guide.

Edit this option          Publish this option          Clear draft content


Published Option

affectedLoggers

Default Value: The default value is an empty string, which means that there aren't any affected loggers.
Valid Values: Comma-separated list of logger names, specified in the LOG4J2.xml. For example: com.genesyslab.webme.commons,PROTOCOL,org.apache.cassandra
Changes Take Effect: Immediately


Verbosity settings are explicitly applied for loggers, as specified in the extended description.

Extended Description: Verbosity settings are explicitly applied for the following loggers:

  • Loggers that are not declared explicitly in the log4j2.xml configuration file.
  • Loggers that are specified explicitly in the log4j2.xml and are specified in the value for this affectedLoggers option.

For other loggers specified in log4j2.xml, but not mentioned in the value for this option, the verbosity level is not re-applied.

Here is a use case for when you might need to set this option:

  • Cassandra needs to write error messages to a log file, and at the same time, Genesys components also need to write debug messages to the log file.

To resolve this use case, you would:

  1. Specify the following logger in log4j2.xml: <logger name="org.apache.cassandra" level="error" additivity="false">
  2. Do not include org.apache.cassandra in the value for the affectedLoggers option.
  3. The default log4j2.xml file contains the following logger: <logger name="com.genesyslab.platform" level="info" additivity="false">
  4. Include com.genesyslab.platform in the value for the affectedLoggers option.
  5. Set the verbose option to debug.

In the sample above, the value of affectedLoggers should be com.genesyslab.platform. Error (but no debug or info) messages from Cassandra will be available in logs, and debug messages from com.genesyslab.platform will be available in logs.

Draft Option

No draft option

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