Client Logs¶
SAP Mobile Cards enables users to upload logs directly from the native client. These logs can be used for debugging or performance enhancement.
Configure Log Upload Settings¶
Log settings for an application are applied to all installed instances of that application. Override the application-level settings for a particular device by changing the settings for the deviceID
.
Note
You can upload the client logs only from the SAP mobile service cockpit.
Default Logging¶
Log Upload - Enable/disable end-user log upload for all users.
Upon enabling the log upload service, the following settings appear:
Setting | Details |
---|---|
Log Level | Select the severity of logs that must be recorded and uploaded. |
Delete Uploaded Log After | Select the time period after which logs are deleted from the database. |
Maximum Number of Logs | Enter the maximum number of log files that can be stored on the user's system at the same time. Choose a value from 1-99999. |
Maximum Log Size | Enter the maximum size of each log file. Choose a value from 0-99999 MB; '0 MB' indicates that the file size is unlimited. |
Note
If the maximum number of log files or file size exceeds the defined value, the oldest log file will be deleted and the logs will be written to a new log file. This can happen irrespective of whether the logs are uploaded to the server or not.
To ensure the logs are retained, set the maximum number of log files to "1" and file size to 0 MB.
User-Specific Logging¶
Specify the users whose logs are uploaded to the mobile services server.
Setting | Details |
---|---|
User | User name of the user whose logs are uploaded. |
Log Upload | Enable/disable end-user log upload for the specified user. |
Log Level | Select the severity of logs that must be recorded and uploaded. |
Delete Uploaded Log After | Select the time period after which logs are deleted from the database. |
Delete |
Delete user-specific logging. |
Log Level¶
Log Level | Details |
---|---|
Error | The application can recover from the error, but cannot fulfill the task due to the error. |
Warning | The application can recover from the anomaly, and fulfill the task, but requires attention from the developer or operator. |
Information | Informational text, used mostly for echoing what has been performed. |
Debug | For debugging purposes, includes extensive and low-level information. |
Fatal | The application cannot recover from the error, and the severe situation causes fatal termination. |
Path | For tracing execution flow. For example, used in the context of entering and leaving a method, looping, and branching operations. Not applicable to the offline logging component. |
Viewing Client Logs in SAP Business Application Studio¶
-
In the command palette, type SAP Business Application Studio:Load Client Log.
-
Select the Severity Level from the drop-down list.
-
Enter the Correlation ID.
-
Select a Timestamp from the drop-down list. A new folder
MobileServicesData
containing the log file is created.
Logs¶
Logs uploaded by the clients are viewed in the Logs tab.
Log View Actions¶
Action | Details |
---|---|
View logs. | |
Download logs to a .json file. |
Filter Logs¶
Option | Details |
---|---|
Search for User Name | Filter logs based on the user ID. |
Level | Filter logs based on the log level. |
Correlation ID | Filter logs based on the log level. Multiple messages are associated using the Correlation ID. |
Time Frame (UTC+0530) | Filter logs based on a timeframe. Select from options such as: Last Hour, Last 24 Hours, Last 7 Days, Last Month, Last 3 Months, Last 6 Months or Custom Defined. For Custom Defined option, the Start time stamp and End time stamp are defined. |
Go | Enable the specified filters. The effect is observed in the log view table. |
Reset Filter | Reset the specified filters. |
Sort |
Specify the sort order and criteria. |
Log View Table¶
Logs are rendered as rows in the log view table. The logs are formatted as follows:
Column | Details |
---|---|
Time (UTC+0530) | The time and date stamp of the log entry. |
Level | Level value of the log. Typically ERROR, WARN, INFO, or DEBUG. |
Message Text | The link to detailed information associated with the log. |
User Name | The name of the user associated with the log. |
Location | The location where the log was printed. |
Archived Logs¶
To troubleshoot application problems that are older than seven days, archived logs can be used. Archived logs are automatically exported from persistent storage to the customer or tenant document store after seven days.
An archived log is exported as a ZIP file and contains files in text format with columns separated by "#". One archived log file is created for all log data generated on a specific day, and the log file name reflects the day the data was logged.