Upload Logs from an MDK App

SAP Mobile Services provides administrators, developers and support staff with extensive logs and traces functionality to troubleshoot application issues. You can control the amount of information that is captured by setting the log level for individual logging components.

In this step, you will enable client log upload policy in SAP Mobile Services Cockpit for a given MDK app.

1. Login to Mobile Services Cockpit, click com.sap.mdk.demo | Mobile Client Log Upload.

   

2. Check Log Upload option and click Save.

   

   Other policy parameters like Log Level, Delete Uploaded Log After, Maximum Number of Logs and Maximum Log Size currently have no effect.

   You can find more details about Client Log Upload feature.

Logs help you trace events that occur while your application is running. You can create logging actions, set their priority levels and upload stored log entries.

You will create 3 actions:

• Log action of Type SetState: to turn the logger On, Off or Toggle

• Log action of Type SetLevel: to set log level (Debug, Info, Warn or Error)

• Log action of Type Upload: to upload logs from app to Mobile Services

You can find more details about MDK Log Actions.

1. Create a log action of type SetState:

   Right-click the Actions folder | MDK: New Action | choose Log in Category | click Log | Next.

   

   In the Base Information step, provide the below information:

   Property	Value
   Name	LogSetState
   Type	Select SetState from the dropdown
   LoggerState	Select On from the dropdown

   

   Click Finish to create the action creation process.

2. Create a log action of type SetLevel:

   Right-click the Actions folder | MDK: New Action | choose Log in Category | click Log | Next.

   In the Base Information step, provide the below information:

   Property	Value
   Name	LogSetLevel
   Type	Select SetLevel from the dropdown
   Level	Select Trace from the dropdown

   

   Click Finish to create the action creation process.

3. Create a log action of type Upload:

   Right-click the Actions folder | MDK: New Action | choose Log in Category | click Log | Next.

   In the Base Information step, provide the below information:

   Property	Value
   Name	LogUpload
   Type	Select Upload from the dropdown

   

   Click Finish to create the action creation process.

In the Project Explorer, click the LogSetState.action file | expand Common Action Properties | click the link icon for Success Action and bind it to LogSetLevel.action

When the metadata is downloaded from App Update, OnDidUpdate event is being called which eventually triggers InitializeOffline.action. You can look at Application.app file for the details.

You will bind LogSetState.action at success of InitializeOffline.action.

Navigate to DemoSampleApp | Actions | Service | InitializeOffline.action | scroll-down and expand Common Action Properties section | click the link icon for Success Action and bind it to LogSetState.action

You will define two message actions for displaying success or failure when Log upload action is triggered.

1. Expand the Common Action Properties section in the LogUpload.action and select the Create a rule/action for its Success Action.

   

2. Keep the default selection for the Object Type as Action and Folders path.

   

3. In the Template Selection step, choose Message in Category | click Message | Next.

4. In the Base Information step, provide the below information:

   Property	Value
   Name	LogUploadSuccessful
   Type	Select ToastMessage from the dropdown
   Message	Log File Uploaded
   NumberOfLines	1
   Duration	3
   IsIconHidden	Select true from the dropdown
   Animated	Select true from the dropdown

   

5. Click Finish to create the action creation process.

6. Switch back to the LogUpload.action tab and create a message action displaying error in case of the Log Upload failure. In the LogUpload.action, click the Create a rule/action icon for the Failure Action.

   

7. Keep the default selection for the Object Type as Action and Folders path.

   

8. In the Template Selection step, choose Message in Category | click Message | Next.

9. In the Base Information step, provide the below information:

   Property	Value
   Name	LogUploadFailure
   Type	Select Message from the dropdown
   Message	Failed to upload client logs - {#ActionResults:LogUpload/error}
   Title	Upload Client Logs
   OKCaption	OK
   OnOK	--None--
   CancelCaption	leave it blank
   OnCancel	--None--

   

10. Click Finish to create the action creation process.

    LogUpload is the Action Result value of the LogUpload.action. This reference is used to pass the results to subsequent actions in the chain. These actions can reference the action result as needed. In this case if there is a failure, you access the error property of the action result to display the failure message.

11. Let’s show an Activity Indicator in the MDK client when logs are being uploaded to the SAP Mobile Services. Switch back to the LogUpload.action tab and provide below information.

    Property	Value
    Show Activity Indicator	Select true from the dropdown
    Activity Indicator Text	Uploading Logs...

    

You will add a toolbar item to the main page called Upload Logs. You will link toolbar item to LogUpload.action you just created in step 2.

1. In the Main.page, drag and drop an Toolbar Item to the bottom right of the page.

   

2. Provide the below information:

   Property	Value
   Caption	Upload Logs
   Visible	$(PLT,true,true,false)

   

   Platform (PLT) function $(PLT, <iOS>, <Android>, <Web>) lets you to define a platform specific value for metadata property as Upload Logs functionality is not applicable in MDK Web environment, this option will not be visible in Web application. You can find more details on PLT function in help documentation.

3. In the Properties pane, click the Events tab, click the 3 dots icon for the OnPress property to open the Object Browser.

   Double click the LogUpload.action action and click OK to set it as the OnPress Action.

   

Deploy the updated application to your MDK client.

1. Right-click Application.app and select MDK: Deploy.

   

2. Select deploy target as Mobile Services.

   

   You should see Deploy to Mobile Services successfully! message.

   

   Alternatively, you can select MDK: Redeploy in the command palette (View menu>Find Command OR press Command+Shift+p on Mac OR press Ctrl+Shift+P on Windows machine), it will perform the last deployment.

   

Open SAP Mobile Services Cockpit, click Mobile Applications | Native/MDK | click com.sap.mdk.demo app | Mobile Client Log Upload | Log Files.

A log file is created for each upload. All the uploaded files, including all levels, not just error or fatal will be listed here.

Check documentation for more details about Uploading and Viewing Client Logs.