Agentry Server Logs Overview

The Agentry Server can generate several log messages that are written to one or more log files. There are different categories of log file messages that pertain to a different aspect of the application:
  • Client-Server communications
  • System connection communications
  • User-specific information for both Client-Server and system connection synchronization
  • Definition loading and processing
  • Code file (SQL, Java, batch files, etc.) processing, including post-SDML expansion and results, JVM messages, and so on
  • Agentry Server system log files (these log files are always generated by the server and have no configurable behaviors)

You can use the log messages generated by the Agentry Server to diagnose development or production issues, determine processing times for numerous aspects of synchronization, and to obtain various other pieces of information.

Agentry Server System Log Files

Following are the system log files for the Agentry Server:
  • messages.log*
  • events.log*
  • startup.log
  • shutdown.log

* - These log files can be viewed using the SAP Control Center.

These log files are always generated and cannot be disabled. Their contents do not have different verbosity levels.

Log Message Contents and Categories

Log files are enabled or disabled, configured, and managed using the SAP Control Center. The options available are to enable or disable the various log files, to specify whether log files are generated based on a processing thread or more narrow areas of functionality, and to set the verbosity level of the log message contents.

The log messages generated by the Agentry Server are categorized as follows:
  • Server: Messages generated as a result of Agentry Server processing. The contents are an inclusive set of the other categories, with the messages including all those related to any processing performed by the Agentry Server.
  • User: Messages generated that are specific to a single user. The contents are an inclusive set of the other categories, with the messages including all those related to any user-specific processing performed by the Agentry Server.
  • System Connection: Messages generated resulting from processing performed by the Agentry Server for back end data synchronization for a specific system connection. The contents are messages that result from processing the various synchronization definitions within the application. Each system connection within an application has its own set of log messages that you can individually enable and configure.
  • Client Communications: Messages generated resulting from Client-Server communications. These messages include listings of involved IP addresses and port numbers, opening of sockets, transfer of data in both directions, and other messages sent between the Agentry Client and Agentry Server.

The contents of all log messages, regardless of category, include both error messages and informational or status messages. Each message includes a date and time stamp precise to the millisecond. The verbosity of the messages generated is configured when the category of log messages are enabled.

Log Messages Versus Log Files

Log messages generated by the Agentry Server are stored in log files. When enabling and configuring the logging behavior of the Agentry Server, the contents of the log messages are configured. In addition, the files into which those messages are written is also configured. By default, when a log message category is enabled, those messages are written to a log file for a processing thread. Each Agentry Server processing thread will have its own log file containing all messages generated by the Agentry Server for processing within that thread, and for the category of log messages that have been enabled.

As an optional additional method for storing log messages, each category of log messages can be written to a category-specific log file. When this is enabled, all log messages generated by the Agentry Server for a specific category are written to the same log file, regardless of processing thread. The messages within the category-specific log files are grouped by the processing thread. Therefore, a category log file contains log messages resulting from processing related to that category.

Following are the individual log files that can be generated for each category, in addition to the thread log files:
  • Server category: Server-ServerName.log where ServerName is the configured name for the Agentry Server in the Agentry - systemConnection configuration option. The category is Agentry by default.
  • User category: User-UserID.log where UserID is the user’s Agentry Client login ID.
  • System Connection category: BackEnd-SystemConnection.log where SystemConnection is the name of the system connection section (i.e., SQL-1, Java-2).
  • Client Communications category: FrontEnd-FrontEndType.log and ANGEL Connection-www.xxx.yyy.zzz.log where FrontEndType is the connect type (i.e., ANGEL Front End, Web Front End). The second file is specific to the ANGEL Connection type. One file is created for each Agentry Client where www.xxx.yyy.zzz is the Client’s IP address as seen by the Agentry Server.

Configuring the log files to generate separately based on the log message category will have a negative impact on Agentry Server performance, as multiple processing threads are logging messages to the same physical log file. Only a single message is written at a time to such a log file. Therefore, each thread must wait until the log file is available before it can write its log message to the log file. It is recommended to configure log files in this manner only for Agentry Development Servers with any regularity. It can be done in a production environment, but only when necessary and for limited durations.

All log files are written to the applicable Agentry application folder in C:\SAP\MobilePlatform\Servers\UnwiredServer\logs. Log files are rolled periodically by the Agentry Server, during Agentry Server startup or restart, and on command. The files are rolled to the sub-directory Logs-Rolled.