This section contains the following topics:
logger.properties File Overview
Modifying the logger.properties File
The CA SiteMinder® Agent for SharePoint log settings are configured through the logger.properties file. These settings in the file are groups of name/value pairs or directives that the CA SiteMinder® Agent for SharePoint reads at run time. You can update the logger.properties file without restarting the CA SiteMinder® Agent for SharePoint.
The logger.properties file is located in the following (default) directory:
Agent-for-SharePoint_home/Tomcat/properties
The log settings for the CA SiteMinder® Agent for SharePoint are maintained in the logger.properties file that is located in the following directory:
Agent-for-SharePoint_home/Tomcat/properties
Follow these steps:
The log settings are changed.
The logger.properties file contents are grouped into the following sections:
The directives that are contained in this file follow the format name=value. Any lines beginning with the # symbol are comments, and are not read when the CA SiteMinder® Agent for SharePoint loads configuration settings.
Note: Pathnames on Windows operating environments use double backslashes (\\).
The SvrConsoleAppender Settings section contains settings for logging events on to a console. This section has the following format:
# SvrConsoleAppender is set to be a ConsoleAppender. log4j.appender.SvrConsoleAppender=org.apache.log4j.ConsoleAppender log4j.appender.SvrConsoleAppender.layout=org.apache.log4j.PatternLayout log4j.appender.SvrConsoleAppender.layout.ConversionPattern=<log_message_display_format_on_console>
Specifies the display format of a log message on the console. The CA SiteMinder® Agent for SharePoint supports all the log4j date pattern strings.
Default: [%d{dd/MMM/yyyy:HH:mm:ss-SSS}] [%p] - %m%n
The SvrFileAppender Settings section contains settings for logging events in a file. This section has the following format:
# SvrFileAppender is set to be a FileAppender. log4j.appender.SvrFileAppender=org.apache.log4j.FileAppender log4j.appender.SvrFileAppender.layout=org.apache.log4j.PatternLayout log4j.appender.SvrFileAppender.layout.ConversionPattern=<log_message_display_formin_file>
Specifies the display format of a log message in the file. The CA SiteMinder® Agent for SharePoint supports all the log4j date pattern strings.
Default: [%d{dd/MMM/yyyy:HH:mm:ss-SSS}] [%p] - %m%n
The server log settings section contains settings for enabling and disabling logging, setting logging level, and setting the output format of the log messages. This section has the following format:
# Server.conf settings: # details of setting "log4j.rootCategory": # For First attribute: # Depending on the logging level needed, set the appropriate level # Possible values : OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL # For Second attribute: # if you want to enable log console, then add SvrConsoleAppender, else don't add this. # For Third attribute: # if you want to enable logging into file, theb add SvrFileAppender, else don't add this. log4j.rootCategory=<log_level>,<output_format>
Specifies the log level of a message. The following list displays values in starting with the lowest priority and moving to the highest:
If the value is set to OFF, logging is disabled. If the value is set to any other value, logging is enabled.
Default: INFO
Specifies how a log message is displayed. You can display a log message on a console, or can store it in a file, or both.
Default: SvrFileAppender
Example: The following command specifies the log level of INFO, and displays a log message on the console and stores it in a file:
log4j.rootCategory=INFO,SvrConsoleAppender,SvrFileAppender
The server log rolling Settings section contains settings to enable the creation of a new log file at certain intervals. You can enable the log rolling based on one of the following mechanisms:
The Log Rolling Based on the file size section contains settings for enabling the log rolling based on a file size. This section has the following format:
# Enable the below setting only if file logging is enabled above. if not make it as an comment by adding "#" at the begging of the line. log4j.appender.SvrFileAppender.File=<logfile_path> # Enable this only if file logging is enabled above. # set vale to "true" if messages are to be appended to the existing file. else set to "false" log4j.appender.SvrFileAppender.Append=true|false #Configurations to rollover server log file based on file size log4j.appender.SvrFileAppender=org.apache.log4j.RollingFileAppender log4j.appender.SvrFileAppender.MaxFileSize=<maximum_logfile_size> log4j.appender.SvrFileAppender.MaxBackupIndex=<maximum_number_of_logfile>
Specifies the name and path of the log file.
Default Name: server.log
Default Path: Agent-for-SharePoint_home/secure-proxy/proxy-engine/logs/
Specifies how the CA SiteMinder® Agent for SharePoint manages the log file. When this value is set to true, the CA SiteMinder® Agent for SharePoint appends new log messages to the existing log file. When this value is set to false, the CA SiteMinder® Agent for SharePoint rolls over the existing log file by creating a log file for new messages.
Default: true
Specifies the maximum size of the log file after which the CA SiteMinder® Agent for SharePoint creates a log file.
Default: 1 MB
Specifies the maximum number of log files that the CA SiteMinder® Agent for SharePoint creates. When the number of log files exceeds this number, the CA SiteMinder® Agent for SharePoint deletes the oldest log file. The CA SiteMinder® Agent for SharePoint creates another log file.
Default: 10
The Log Rolling Based on the file age section contains settings for enabling the log rolling based on the age of a file. This section has the following format:
#Configurations to rollover server log file based on time #log4j.appender.SvrFileAppender=org.apache.log4j.DailyRollingFileAppender #log4j.appender.SvrFileAppender.DatePattern=<date_pattern>
Specifies the date when the CA SiteMinder® Agent for SharePoint creates a log file.
Default: yyyy-MM-dd
The CA SiteMinder® Agent for SharePoint creates another logfile in the following format:
<logfile_name>.<date_format>
Specifies the name of the log file.
Default: server.log
Specifies the date when the CA SiteMinder® Agent for SharePoint created a logfile. The CA SiteMinder® Agent for SharePoint supports all the log4j date pattern strings.
Default: yyyy-MM-dd
|
Copyright © 2014 CA.
All rights reserved.
|
|