Application log output settings

Refer to here for more information about DataSpider Studio/DataSpider Studio for Web edition.

Application log output settings

Application log output settings is a tool to set up output destination information of application log that can be referenced from all projects and scripts.
An application log output destination must be created before output application log using script component "Output Log".

Functions provided by Application log output settings

Application log output settings provides following functions
Description of Functions
Name of functions Menu Description Remarks
List all Application Log Output Settings Log output settings list Lists all application log output settings.
  • Sorted by standard unicode character order.
Add new application log output setting Creates new application log output setting  
Change application log output setting Changes application log output setting  
Remove application log output setting Removes application log output setting  

List all Application Log Output Settings

Description of items
Item name Description Remarks
Name Name of the Application log output setting  
Resource type Type of the Application log output setting
  • Syslog
  • NT event log
  • Rotation file
  • Schedule file
Owner User who last updated the Application log output  

Add new application log output setting

You can create a new application log output settings by [Add] button.

Select type of application log output newly added

Description of items
Item name Description Remarks
Syslog Send log to remote Syslog daemon.  
NT event log Adds to the NT event log system.
  • Only available when DataSpiderServer operates in Windows 32bit environment or Windows 64bit environment.
  • It is necessary to locate the following library file to directory included in the environment variable "PATH" of Windows system on which DataSpiderServer operates.
    • $DATASPIDER_HOME/server/lib/NTEventLogAppender.dll
Rotation file Outputs log to file.
Rolls up when file reaches to the [Maximum size of file], then saves backup file of the designated part [Number of backups].
 
Schedule file Outputs log to file.
Rolls up the log files in accord with the schedule and saves the backup file.
 

Common settings

Description of items
Item name Description Remarks
Name Enter the name of Log output destination setting

Type:Syslog

Description of items
Item name Description Remarks
Hostname/IP address Enter the name of the host that Syslog daemon operates on.
  • The default value is "localhost" (machine that DataSpiderServer operates on) .
Facility Select the Syslog facility.
  • [KERN]
  • [USER]:(default)
  • [MAIL]
  • [DAEMON]
  • [AUTH]
  • [SYSLOG]
  • [LPR]
  • [NEWS]
  • [UUCP]
  • [CRON]
  • [AUTHPRIV]
  • [FTP]
  • [LOCAL0]
  • [LOCAL1]
  • [LOCAL2]
  • [LOCAL3]
  • [LOCAL4]
  • [LOCAL5]
  • [LOCAL6]
  • [LOCAL7]
 
Output facility name Select whether to output facility name to log.
  • [Checked]:
    Output facility name to log.
  • [Not Checked]: (default)
    Do not output facility name to log.
 

Type:NT event log

Description of items
Item name Description Remarks
Source When outputting NT event logs, input source showing the name of where the log occurred.
  • The default value is "DataSpider Servista"

Type:Rotation file

Description of items
Item name Description Remarks
File path Select or input path of log file.

Click [Browse] button to activate the file Selectr and Select the file.
  • For file path, specify absolute path of the local file system of server OS.
Maximum size of file Enter the maximum size of log file.

Rolls up log file when the set value is exceeded.
  • The default value is "2MB".
  • The unit of "B", "KB", "MB", "GB" for each string can be specified.
  • The range can be specified is "1B" to "about 92 billion GB".
Number of backups Enter the maximum number of backup files.

Deletes the backup files when the set value is exceeded.
  • The default value is "10".
  • The range can be specified is from "0" to "2.1 billion".

Type:Schedule File

Description of items
Item name Description Remarks
File path Select or input the log file path.

Click [Browse] button to activate the file Selectr and Select the file.
  • For file path, specify absolute path of the local file system of server OS.
Schedule setting Select the schedule to roll up.
  • [Daily]:(default)
  • [Weekly]
  • [Monthly]
  • The timing of rolling up log files are as follows.
    • [Daily]: At the first run time of log output process after date changes.
    • [Weekly]: At the first run time of log output process after week changes.
    • [Monthly]: At the first run time of log output process after month changes.
  • The time of changing 0 AM for date, 0 AM of Sunday for week and 0 AM of 1st for month.
  • The log file name which is rolled up is as follows.
    • [Daily]: "file name.yyyy-MM-dd"
      Example: test.log.2008-07-15
    • [Weekly]: "file name.yyyy-MM-W"
      "W" means which week in the month.
      Example: test.log.2008-07-3
    • [Monthly]: "file name.yyyy-MM"
      Example: test.log.2008-06

Layout

Description of items
Item name Description Remarks
Layout Enter the log format layout by pattern string.
  • The default value is "[%c] %m [%d{HH:mm:ss}]%n".

For example, for the default of "[%c] %m [%d{HH:mm:ss}]%n" pattern string, outputs log of "[Category] Message [time] (line break)". Each conversion specifier begins by is a percent sign ("%"), and the conversion character is followed by optional conversion modifiers and conversion character.
Conversion character
Character Description Remarks
c Used to output the category of the logging event.  
d Used to output the date of the log event.
Date format can be specified by a string specified in the {} brackets followed.
For example,%d{HH:mm:ss,SSS} or %d{dd MMM yyyy HH:mm:ss,SSS} and so on. If omitted, ISO8601 format is assumed.
 
m Outputs the message set by logging event.  
n Outputs platform dependent line break character.
It is recommended using this conversion character because non-portable line break characters "\n" or "\r\n" performance is the same as natural performance
 
p Outputs log level.  
% For the series of %%, outputs a single percent character.  
Option
Format of option is specified between percent mark and conversion character.
The following categories (conversion character "c") is an example to display a specified format.

Specification example Left aligned Minimum width Maximum width Description
%20c false 20 none If category name has less than 20 characters then it will be filled with blanks on the left.
%-20c true 20 none If category name has less than 20 characters then it will be padded with spaces to the right.
%.30c - - 30 If category name is longer than 30 characters, then it will be removed from the beginning.
%20.30c false 20 30 If the category name is shorter than 20 characters, then it will be padded with spaces to the left .
If category name is longer than 30 characters, then it will be removed from the beginning.
%-20.30c true 20 30 If category name is shorter than 20 characters, It will be padded with spaces to the right .
If the category name is longer than 30 characters, it will be removed from the beginning.

For details, please refer to "PatternLayout" of log4j (http://logging.apache.org/log4j/1.2/apidocs/index.html).

Log level

Description of items
Item name Description Remarks
Log level threshold Select the log level threshold.
  • [FATAL]
  • [ERROR]
  • [WARN]
  • [INFO]:(default)
  • [DEBUG]
  • Outputs log of the selected [Log level threshold] or higher.
    For example,If "INFO" is selected, "INFO" "WARN" "ERROR" "FATAL" level log will be output. "DEBUG" level log is not output.
Log level conversion rules
These log levels is used internally, therefore, their log output will be converted to the corresponding level.

Log level Syslog NT Event
FATAL emerg Error
ERROR err Error
WARN warning Warning
INFO info, notice Information
DEBUG debug Information

Specification Limits

Main exceptions

Exception name Cause Solution
java.lang.NoClassDefFoundError Library file is not located in a specified place. It is necessary to locate the required library file to the specified directory to use the NT event log function.
Refer to "NT event log" for details.

Notes