| aimsserver.cfg reference for logging settings |  |
| aimsserver.cfg reference for logging settings | |
| Related Topics |
|---|
Aimsserver.cfg specifies default Spatial Server settings for logging and is located at:
Windows: <ArcGIS Installation Directory>\ArcIMS\Server\etc
UNIX and Linux: $AIMSHOME/etc
The following settings can be changed. For more information on these settings, see Enabling full verbose logging.
When set to True, on Windows platforms, some of the operating system messages are written to the ArcIMS log files. When this option is enabled, the Application Server cannot recover a crashed Spatial Server until a user at the console dismisses the dialog box. Production servers should leave this option off.
Default value is false.
Directory location for writing log files. This directory must already exist and be writable by the Spatial Server. If not, the default logpath is used.
The default directory for Windows is <ArcGIS Installation Directory>\ArcIMS\Server\log. The default for UNIX and Linux is $AIMSHOME/log. A relative path can be used and is considered relative to <ArcGIS Installation Directory>\ArcIMS\Server on Windows and $AIMSHOME on UNIX and Linux.
Sets one or more log output formats. The following formats are supported:
| [May 24, 2006 3:27:50 PM][2612 5908 INFO1] Begin Request |
|
<LINE> <DATE>May 24, 2006</DATE> <TIME>3:27:50 PM</TIME> <PID>2612</PID> <TID>5908</TID> <MSGLEVEL>INFO1</MSGLEVEL> <TEXT>Begin Request</TEXT> </LINE> |
| "May 24, 2006","3:27:50 PM","2612","5908","INFO1","Begin Request" |
The default output type is "log".
Sets the maximum file size in kilobytes. A log file is restarted if the specified limit is reached.
The default is "0" or no value, which means no limit is specified.
Maximum number of lines in a log file in units of one thousand. If specified, a log file is restarted if the specified limit is reached.
Default is "0" (no limit specified).
Maximum number of "aged" log files to be kept. If specified, log file names do not include the PID as part of the name. This option overrides any specified value for the logsavefiles option. The value for this option can be "0", which results in no log files being saved. Setting logmaxfiles to "n" (where n > 0) will result in the following actions:
Log files are renamed when a log file is first opened and whenever a log file reaches any specified limit.
The default is "" (no files are renamed).
Determines whether log files are overwritten or a new one is created when the maximum file size or number of lines is reached. The restarted log file is named <logname>_n.<ext>, where "n" is the log count. This option is ignored if logmaxfiles is specified.
Default value is "true", which means to create a new file.
The logging level.
Informational messages (INFO) are messages that provides facts about a request, such as the date and time of a request or status of a logging level, for reference purposes. ArcIMS uses several types of informational messages. The most important informational messages are INFO1, which provide the service name and beginning and ending timestamps. The other types are INFO2 and INFO3, which provide additional information about requests and responses.
Status messages (STAT) give information about processing times. STAT1 messages are for the total request time. All other processing times are listed as STAT2 messages.
The log message level can also be specified as a comma-delimited list of message levels desired. The message levels supported are:
Default value is 2 or "error,warning".
Included by default only on Solaris platforms. Other platforms can add this attribute manually. When set to "true", the file handle restriction is lifted, which on Solaris is 256 file handles.
After making any changes to aimsserver.cfg, you must restart ArcIMS Monitor and ArcIMS Application Server.
The following options are available for customizing the Spatial Server log files. Listed attributes must be added to AIMSSERVER.
A string defining the date format to use. All non-letter characters are copied, and letters are treated as tokens as follows. All symbols are case sensitive.
| Symbol | Meaning | Example |
|---|---|---|
| G | era designator | AD |
| yy | year (2-digit) | 06 |
| yyyy | year (4-digit) | 2006 |
| M | month in year (1-12) | 5 or 11 |
| MM | month (2-digit) | 05 or 11 |
| MMM | month (short name) | Sep |
| MMMM | month (long name) | September |
| d | day in month (1-31) | 7 or 13 |
| dd | day in month (2-digit) | 07 or 13 |
| E | day of week (short name) | Tue |
| EEEE | day of week (long name) | Tuesday |
| e | day of week/local (1-7) | 2 |
| D | day of year (1-366) | 189 |
| F | day of week in month | 2nd Wed in July |
| w | week in year (1-53) | 27 |
| W | week in month (1-5) | 2 |
| '..' | text | 'today is' |
The default value is dependent on the system locale. The default for the "en_US" locale is "MMM d, yyyy".
A string defining the time format to use. All non-letter characters are copied, and letters are treated as tokens as follows. All symbols are case sensitive.
| Symbol | Meaning | Example |
|---|---|---|
| h | hour in am/pm (1-12) | 7 or 11 |
| hh | hour in am/pm (2-digit) | 07 or 11 |
| H | hour in day (0-23) | 7 or 21 |
| HH | hour in day (2-digit) | 07 or 21 |
| k | hour in day (1-24) | 3 or 16 |
| kk | hour in day (2-digit) | 03 or 16 |
| K | hour in am/pm (0-11) | 6 or 11 |
| KK | hour in am/pm (2-digit) | 06 or 11 |
| m | minute in hour (0-59) | 4 or 30 |
| mm | minute in hour (2-digit) | 04 or 30 |
| s | second in minute (0-59) | 4 or 55 |
| ss | second in minute (2-digit) | 04 or 55 |
| SSS | millisecond (0-999) | 978 |
| a | am/pm marker | PM |
| z | time zone (short name) | PST |
| zzzz | time zone (long name) | Pacific Standard Time |
| '..' | text | 'the time is' |
The default value is dependent on the system locale. The default for the "en_US" locale is "K:mm:ss a".
A string defining the format of the log line. This string is copied with the following tokens expanded. Tokens are case sensitive.
| Token | Meaning |
|---|---|
| %d | date (formatted using "logdatefmt") |
| %t | time (formatted using "logtimefmt") |
| %p | Process ID |
| %h | Thread ID |
| %l | Log message level |
| %m | The actual log message text |
| %D | Field name for date |
| %T | Field name for time |
| %P | Field name for pid |
| %H | Field name for tid |
| %L | Field name for msglevel |
| %M | Field name for msgtext |
| %Q | The literal character '"' |
| %% | The literal character '%' |
| %q | Enclose all fields in quotes |
| %y | Enclose all fields in quotes except the msgtext field |
| %z | Enclose only the msgtext field in quotes |
| %f | Fold multiple msgtext field lines into one |
| %u | Upper-case field names |
| %c | Escape fields according to CSV rules |
| %x | Escape fields according to XML rules |
| %s | Escape fields according to SHELL rules |
A field token may contain a field-width specifier (e.g. %5h or %-6p) to pad the field on the left or right to a fixed width. The field width is ignored for "msgtext" fields.
Examples:
|
xml: "%x%f%q<LINE %D=%d %T=%t %P=%p %H=%h %L=%l %M=%m />" csv: "%c%f%q%d,%t,%p,%h,%l,%m" |
The default is "[%d %t][%p %h %l] %m".
These attributes specify a header and/or trailer line to be written to the log file. If a trailer is specified, the log file always ends with that line. These strings may contain tokens as described in the logformat option.
The "csv" and "xml" formats have built-in header and trailer lines defined for them, and specifying a header and/or trailer will override the built-in specifications. Specifying a value of "!" sets the header or trailer to an empty value.
Examples:
|
csv: xml: |
The default is "" (no header or trailer).
Specifies an extension to use instead of the default extension for that log type. This is useful if you want to create two different log files of the same type. Specifying a value of "!" will create a log file with no extension.
The default is "" (use the default extension for a log type).
If set to "true", the server's hostname is appended to each log filename before the PID, if logmaxfiles was not specified.
The default is "false" (hostname not added to log filenames).
When any attribute is included within AIMSSERVER, the attribute value applies to all log types. You can customize the configuration for a specific log type by using LOGTYPES and LOG. In the following example, specific options are applied to an XML log type:
|
<LOGTYPES> <LOG logtype="xml" ... /> </LOGTYPES> |
Any log option, except logpath, can appear in a LOG entry and applies only to that log type. A LOG entry must include a logtype option.
When specified in a LOG entry, this string describes a specific log type to create. This may be in addition to any log types specified in the AIMSSERVER entry, or it may duplicate a name already defined, in which case the entry overrides any options set in AIMSSERVER for that type. If no log types are specified in the AIMSSERVER entry, and log types are defined in the LOGTYPES section, then only those log types are created.
