Managing System Logs
Sterling B2B Integrator comprises multiple components, including software applications such as archive tools, Web servers, and database servers.
To monitor the activities of each component, Sterling B2B Integrator generates log files based on the system's monitoring activity. These log files are one of the tools that enable you to monitor the way the system operates.
Each operations server on a host has its own operations log file. Log files are created in the logs directory of the installation directory. To prevent the system log files from taking up excessive storage space and main memory, Sterling B2B Integrator generates a log file only when a component runs. This in turn improves the performance of Sterling B2B Integrator.
Each open log file is closed once every 24 hours (usually at midnight), and a new file is created. When moving into or out of Daylight Savings Time (DST), you must stop and restart both Sterling B2B Integrator and its database to ensure that log files are created with the correct timestamp.
Log files are allowed to grow only up to a maximum size. If a log file reaches its maximum size, it is closed and another file is created. There is a limit to the number of log files that can exist simultaneously. If this limit is exceeded, the old logs files are automatically deleted. If the Sterling B2B Integrator Dashboard interface links to a deleted log file (which will display a blank page), click the link to a newer log file.
Naming Conventions
This section provides information about the naming conventions to be used in Sterling B2B Integrator.
Use the following naming convention for a directory:
- UNIX - install_dir/logs/directory
- Windows - install-dir\logs\directory
- install_dir or install-dir refers to the name of the installation directory.
- logs refers to the primary log directory.
- directory refers to the subdirectory created
when you start Sterling B2B Integrator.
All the old log files are moved to this subdirectory for archiving. The naming convention to be used for the old log directory is logs_mmddyy_hhmmss.
Use the following naming convention for a log file:
name.log.Dyyyymmdd.Thhmmss_#
- name identifies the type of the log file.
- log refers to the file name extension, which indicates the file type.
- Dyyyymmdd refers to the date in the year, month, and day format. The D at the beginning refers to Date.
- Thhmmss refers to the time in hours, minutes, and seconds format. The T at the beginning refers to Time.
- _# is the increment
of the log file. If you attempt to write a log file that already exists, _# is
appended to the log file name, allowing you to write a new file and
save the integrity of the existing file.
For example, if mylog.D20041101.T092022 exists, and you try to save a new log file with the same name, the new file becomes mylog.D20041101.T092022_2, where _2 indicates that it is the second log in a sequence using the same file name.
Each time Sterling B2B Integrator is started, the log files created since the last time it was started are archived in a time-stamped subdirectory. New log files, those created subsequent to the most recent execution of Sterling B2B Integrator, are written to the install_dir/logs directory.
Viewing Log File Contents
Users of Sterling B2B Integrator can view the contents of both current log files and old log files.
- If you are working in a clustered environment, the log information that is displayed is determined by the node you select from the Select Node list.
- The Sterling B2B Integrator interface displays only the last 2500 lines of a current log file. To view the entire log, you must have read permission for the file system on which Sterling B2B Integrator is installed. Open the log file in read-only mode using a text editor.
- From the Administration menu, select .
- Click the appropriate log file.
- In the install_dir/logs/log directory, locate the old log file that you want to view.
- Open the log file in read-only mode using a text editor.
Analyzing Log File Contents
The contents of a log file provide information about system activities and problems. The format used for entries written to a log file is [YYYY-MM-DD HH:MM:SS.ss] loglevel ‘message code' Scope.Subsystem.Name ‘information string'
[2008-04-22 09:02:43.404] ERROR 000310160001 UTIL.FRAME_POOL.ERR_Pool [Pool] Could not create the initial objects for the pool gentranTPPool
[2008-04-22 09:02:43.405] ERROR 000000000000 GLOBAL_SCOPE [1208869363405] The driver manager could not obtain a database connection.
- YYYY-MM-DD refers to the date in year, month, day format.
- HH:MM:SS.ss refers to the time in hour, minutes, seconds, and hundredths of a second format.
- loglevel indicates how much information is logged and the relative importance of the message. A subsystem may log only a subset of these messages (as defined in the subsystem.loglevel property of log.properties), discarding those that have a severity that is lower (less severe) than the current log level set for that subsystem.
Log Level Description FATAL Collects fatal and critical error information. ERRORDTL Collects only error conditions, with a detailed description of the error. ERROR Collects only error conditions such as exceptions and error messages (including errors from the user interface). WARN Collects non-fatal configuration messages. SQLDEBUG Collects SQL statements that are being executed. INFO Collects basic operational information. TIMER Collects timing information. COMMTRACE Collects communication trace information. DEBUG Collects basic debugging statements including system state and code paths. VERBOSE Collects extra debugging statements (like XML information) that describe and explain what is happening in the system. ALL Collects information about all the conditions. - message code describes the activity
or problem, using the following format:
- The first four digits specify the scope (like Workflow, Ops, Util).
- The next digit specifies the log severity level (default conventions use 1 for error or exception, 2 for debug messages, 3 for warnings, and 4 for information or all messages.
- The next three digits specify the subsystem (like Workflow Queue or Workflow Engine).
- The last four digits specify the error number.
- Scope.Subsystem.Name is a text description of the affected part of Sterling B2B Integrator (such as WORKFLOW, OPS, or UTIL), the Sterling B2B Integrator subsystem (such as FRAME_POOL, NOAPP, or SERVER), and what occurred (such as ERR_Pool or INFO_NamingException1).
- information string is a brief description of the activity that occurred.
Following is an example of this format:
[2006-05-30 11:06:55.661] ALL 000440020297
SERVICES.SERVICES_CONTROLLER.INFO_sdi_getName startup: loading HTTP_SEND_ADAPTER
- Scope (Services)
- The affected part of Sterling B2B Integrator (Services Controller)
- What occurred (INFO_sdi_getName)
- Error code (0297)
Changing Log Settings
Sterling B2B Integrator enables you to change the log settings globally and locally.
Changing Log Settings Globally
You can change log settings globally using the customer_overrides.properties file, which prevents customized property file changes from being overridden by updates or patches. You can change global settings in the log.properties file. For more information about the customer_overrides.properties file, refer to Sterling B2B Integrator Property Files documentation.
- In the install_dir/properties directory, either create or locate the customer_overrides.properties file.
- Open the customer_overrides.properties file using a text editor.
- Specify the settings for the global log properties described in
the following table. These properties are displayed in the following
format:logService.Property=Value
- logService identifies the log.properties file in the customer_overrides.properties file.
- Property is the global property of the log.properties file that you want to set. See the following table for a list of properties.
- Value is the property setting of the log.properties file.
Property Description newloggers Specifies whether to allow new log files to be created when the maximum log file size setting has been exceeded. Valid values: - true – Allow new logs to be created (Default)
- false – Do not allow new logs to be created
defaultlog Specifies the name of the default log. Default is systemlogger.
Example: logService.defaultlog=logtype
logtype.maxnumlogs Specifies the maximum number of logs to retain before deleting the old logs. Default is 10.
Examples:
logService.defaultlog.maxnumlogs=15 sets the maximum number of a log type specified as the default log (systemlogger, by default) to 15.
logService.uilogger.maxnumlogs=20 sets the maximum number of UI type logs to 20.
The following table provides the log type name for each log file name defined by default in the log.properties file and extension files. If you have changed the file name, use the original file name to find the log type name.File Name of Log
(As Shown on the System Logs Screen)
Log Type
(For the customer_overrides.properties file)
alerterlogger.log alerterlogger archive.log archivelogger Authentication.log AuthenticationLogger cdinterop.log cdinteroplogger cdinterop_cdjava.log cdinteropcdjavalogger ceuinterop.log ceulogger common3splogger.log common3splogger delete.log deletelogger ebXML.log ebXMLlogger EDIINT.log EDIINTLogger event.log event ftp.log ftplogger ftpclient.log psftpclientlogger http.log httplogger httpclient.log httpclientlogger jetty.log jettylogger lifecycle.log lifecycleLogger mailbox.log mailboxlogger mgmtdash.log neo noapp.log noapplogger ocsp.log ocsplogger oftp.log oftplogger ops_exe.log opslogger Perimeter.log PSLogger pipeline.log pipelinelogger report.log reportlogger resourcemonitor.log resourcemonitorlogger mif.log rnlogger sap.log saplogger schedule.log schedulelogger Security.log SecurityLogger servicesctl.log sclogger sftpclient.log sftpclientlogger sftpserver.log sftpserverlogger si_exe.log silogger sql.log sqllogger system.log systemlogger system.log purgelogger test.log testlogger tracking.log tracking txtrace.log txtracelogger ui.log uilogger ui_performance.log ui_perf_logger webdav.log webdavlogger WebSphereMQSuite.log wsmqSuiteLogger webx.log webxlogger wf.log wflogger wfexception.log wfexception_logger wfstatistics.log wfstatistics - Save and close the customer_overrides.properties file.
- Stop the Sterling B2B Integrator and restart it to use the new values.
Changing Log Settings for an Individual Log Type
- Location of the log file
- The number of lines pertaining to the log file to be saved
- The amount of details to log
- From the Administration menu, select .
- Click the icon next to the log type whose log settings you want to change.
- In the Log Settings page, specify the settings for the options
described in the following table:
Option Description Location Specifies the absolute path for the log file. Rollover Interval If newloggers is set to false, the rollover interval specifies the point at which the oldest lines in the log file are deleted as new lines are created. If newloggers is set to true (default), the rollover interval is the maximum number of lines allowed in the log file before a new file is created. Select one of the following rollover interval values:- 50000 lines
- 100000 lines
- 150000 lines
- 200000 lines
Note: Here, the term “lines” refers to logical lines (entries) and not physical lines. For example, following is a “line”:[2005-07-11 08:12:07.679] ALL 000440020297 SERVICES.SERVICES_CONTROLLER.INFO_sdi_getName startup: loading HTTP_SEND_ADAPTER FtpConfig.logConfiguration() client configuration: ftpListenPort=[10021] localDataPortCollection=[null] localControlPortCollection=[null] minThreadPoolSize=[3] maxThreadPoolSize=[6] systemCertificateId=[null] caCertificatesIds=[null] passphrase=[******] cipher=[Strong] sslOption=[SSL_NONE] sslAllowed=[false] sslRequired=[false] sslImplicit=[false] cccAllowed=[false] cccRequired=[false] clusterNodeName=[Node1] perimeterServerName=[local] nonTerminationCharsToTotalCharsRatio=[0.9]
Logging Level Specifies the amount of details to log. Select one of the following values:- On – Set the logging level to include comprehensive and detailed logs (creates larger files)
- Off – Set the logging level to include log errors (creates smaller files)
Note: Setting the logging level to ALL may generate an excessive amount of debugging information. You should lower the logging level after you have retrieved the debugging information you require.The ALL string does not mean the logging level is set as ALL. Strings such as ALL, INFO, and WARN appear in the log files irrespective of setting the logging level to ON or OFF.
- Click Save.
Changing Log File Location
- Modify the LOG_DIR setting in sandbox.cfg.
- Run the setupfiles.sh script to apply the changes.
- jetspeed.log
- jetspeedservices.log
- torque.log
- turbine.log
- access.log
To modify the location of these log files, run the deployer.sh script. This script rebuilds and redeploys the Web ARchive (WAR) files of the dashboard interface.
The locations of the log files created by the service configuration are hard coded in the configuration. As a result, the location of the einvoicing.log files cannot be changed by modifying the setting in sandbox.cfg. To modify the location of these log files, you must modify the settings at the service configuration level.
Log File Types
Log Type | Log Name | Description |
---|---|---|
Central Operations Server | ||
Operations Security | opsSecurity.log | Used by the security components. Indicates problems with startup, passwords, and passphrases. |
Operations Server | ops.log | Used by the operations server. |
opsServer.log | Receives all the log messages the operations servers generate during startup. | |
IBM® Sterling Gentran:Server® for UNIX | ||
Data Adapter | Logs activities of the Sterling Gentran:Server for UNIX adapter. You cannot turn logging on or off for Sterling Gentran:Server for UNIX data adapter. Note: The Sterling Gentran:Server for UNIX logs are displayed only if
you have Sterling B2B Integrator
configured for Sterling Gentran:Server for UNIX.
|
|
Application Logs | ||
Adapter Server | servicesctl.log | Used by the service controller component. |
AFT Routing | aftrouting.log | |
Alerter | alerterlogger.log | Logs notification failures and Alert own errors in the Alert Service. When debug is turned on, the alerter log type also logs all the alert information, such as defined alerter and filter information. |
Archive | archive.log | Used by the archive components. |
Business Process Exceptions | wfexception.log | Tracks the exceptions that occur while a business process is running. |
Business Process Execution | wf.log | Captures information that is specific to running a business process. |
Business Process Policy Statistics | wfstatistics.log | Contains workflow policy statistics generated by the workflow scheduling policy. Although the actual content depends on the scheduling policy in place, the business process policy statistics log type basically contains XML timestamps followed by XML records. |
IBM Sterling Connect:Direct® Secure Perimeter Adapter | cdsp.log | |
Sterling Connect:Direct Server Adapter Protocol Layer | cdinterop_cdjava.log | Used by the Sterling Connect:Direct Server adapter. |
Sterling Connect:Direct Server and Requester Adapter and Services | cdinterop.log | Used by the Sterling Connect:Direct Server and Requester Adapter and related services |
IBM Sterling Connect:Enterprise® Server Adapter and Services | ceuinterop.log | Used by the Sterling Connect:Enterprise Server adapter. |
Crypto | crypto.log | Used for cryptographic functions |
CSP2 FTP Adapter | cspftp.log | |
CSP2 Http Adapter | csphttp.log | |
Dashboard | mgmtdash.log | Used by the Dashboard component. |
Delete Resources | delete.log | Logs information about resources that have been deleted from Sterling B2B Integrator. |
Document Tracking | tracking.log | Logs document tracking activities. |
ebXML Business Process Execution | ebXML.log | Logs ebXML business process execution activities. |
EDI Log | edi.log | Used for EDI Communication |
EDIINT AS1 and AS2 |
EDIINT.log | Used by the EDIINT components. |
Embedded Engine | embeddedEngine.log | Used when a workflow is running and has zero persistence |
Event Framework | event.log | Logs event framework activities for events completed in Sterling B2B Integrator. |
FTP Client Adapter and Services | ftpclient.log | Used by the FTP Client Adapter and related services. |
FTP Server | ftp.log | Used by the FTP server components. |
Sterling Gentran:Server for UNIX Lifecycle | lifecycle.log | Used by the Sterling Gentran:Server for UNIX Lifecycle components when loading lifecycle records. |
Sterling Gentran:Server for UNIX Lifecycle Purge Service | system.log | Used by the Sterling Gentran:Server for UNIX Lifecycle purge components when purging lifecycle records. |
HTTP Client Adapter and Services | httpclient.log | Used by the HTTP Client Adapter and related services. |
HTTP Server Adapter | http.log | Used by the HTTP Server Adapter. |
Integrator Administration | ui.log | Used by the Sterling B2B Integrator interface. |
Jetty HTTP Server | jetty.log | Used by the Jetty HTTP Server. |
JMX Agent | jmx.log | |
Log.ResourceMonitorLog | resourcemonitor.log | Used by the Resource Monitor. |
Mailboxing Subsystem | mailbox.log | Used by the mailbox components in Sterling B2B Integrator. |
OCSP | ocsp.log | Used by the Online Certificate Status Protocol. |
Odette FTP Adapter Administration | OdetteFTP.log | Logs Odette FTP Adapter activities |
OFTP Administration | oftp.log | Logs OFTP administration activities. |
Perimeter Services | Perimeter.log | Used by the perimeter server components in Sterling B2B Integrator. |
Pipeline | pipeline.log | Used by the pipeline components. |
Platform | platform.log | |
Report | report.log | Used by the reporting components. |
Reporting Services | bizIntel.log | Used to log Reporting services |
Resource Monitor | resourcemonitor.log | Logs Resource Monitoring activities |
RosettaNet Business Process Execution | rnif.log | Used by the RosettaNet™ components. |
SAP Adapter Administration | sap.log | Used by the SAP components. |
SAP XI Adapter Administration | sapxi.log | Used by SAP Suite adapters |
Schedule | schedule.log | Logs scheduling activities. |
Schedule Monitor | schedulemonitor.log | Logs scheduling monitor activities |
Security | security.log | Used by the security components. Indicates problems with startup and component licensing. |
SFTP Client Adapter and Services | sftpclient.log | Used by the SFTP Client adapter and related services. |
SFTP Common Log | common3splogger.log | Logs SFTP security errors. |
SFTP Server Adapter | sftpserver.log | Used by the SFTP Server adapter. |
SQL Manager | sql.log | Logs queries sent to the database by the SQL Query service. |
IBM Sterling Secure Proxy | secureproxy.log | Logs IBM SSP activities |
System | system.log | Used as a general logging service, typically the default system log. |
noapp.log | Used on an application server-independent system as a general activity log. | |
System Output/Error Redirect | noapp.log | Used to provide additional system log information. |
Translation Log | tx.log | Used by Translation services |
Translation Trace Output | txtrace.log | Used as a logging service that helps with map debugging. This log contains debugging messages that show how the translator traversed the maps definition and matched each block of data against the map. |
User Authentication | Authentication.log | Logs user authentication attempts and activities. |
Visibility | visibility.log | Logs information about Dim Visibility |
Web Extension | webx.log | Used by the Web Extensions components in Sterling B2B Integrator. |
Web Services Security | wssec.log | Used to provide security logs of web services |
WebDAV Server | webdav.log | Used by Web dav adapters |
WebSphereMQ Suite | WebSphereMQSuite.log | Used by the WebSphereMQ Suite Async Receiver adapter and related services. |
Windows Service GI | si_exe.log | Log file created by the Sterling B2B Integrator Windows service. |
Windows Service Ops log | ops_exe.log | Log file created by the Opserver Windows service. |
WorkFlow Deadline | bpdeadline.log | Logs when BP is configured with deadlines |
WS-Reliability Routing | wsrm.log | Log file created by the Sterling B2B Integrator Web Services. |
Log Name | Description |
---|---|
ScheduleBackup.log | Temporary file that is created when Sterling B2B Integrator Windows service stops. |
Backuplogs.log | Temporary file that is created when Sterling B2B Integrator Windows service stops. |
ScheduleStopOps.log | Temporary log file that can be ignored. |
Log Name | Description |
---|---|
PSLogger.Dyyyymmdd.Thhmmss | Logs perimeter server information for the DMZ perimeter server. |
StartupPS.log | Logs startup activities for the DMZ perimeter server. |