Agentry Logs

Use Management Cockpit to manage Agentry log files. You can enable or disable the various files, specify how log file are generated (based on a processing thread, or more narrow areas of functionality), and set the verbosity level of the message contents.

The log messages generated by the SAP Mobile Platform Server are categorized as follows:
  • Server: Messages that are generated as a result of Agentry application processing. The contents are an inclusive set of the other categories, with the messages including all those related to any processing performed by the SAP Mobile Platform Server.
  • User: Messages that are specific to a single user. User logs are inclusive of system connection and client communication logs, with the messages including all those related to any user-specific processing performed by the SAP Mobile Platform Server.
  • System Connection: Messages that result from processing 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 that result from client-server communication. These messages include IP addresses and port numbers, socket opening, data transfer in both directions, and other messages sent between the Agentry client and SAP Mobile Platform 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 timestamp, 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 application are stored in log files. When enabling and configuring the logging behavior of the Agentry application, 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 application processing thread has its own log file containing all messages generated by the Agentry application 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 application 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.

In addition to the thread log files, you can generate log files by category:
  • Server category: Server-ServerName.log, where ServerName is the System Name specified in the Agentry application definition. By default, the category is Agentry.
  • 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 (for example, SQL-1, Java-2).
  • Client communications category: FrontEnd-FrontEndType.log, where FrontEndType is the connect type (for example, WebSockets Front End).

Configuring the log files to generate separately based on the log message category has a negative impact on Agentry application performance, as multiple processing threads are logging messages to the same physical log file. One message at a time is written to such a log; therefore, each thread must wait until the log file is available before it can write its log message. SAP recommends that you configure log files in this manner only in a development environment.

All log files are written to the Agentry application folder in <SMP_HOME>\log\agentry. Log files are rolled over periodically, during SAP Mobile Platform Server start-up or restart, and, on command, to the subdirectory rolled.