Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add JC content for tutorial 3,4,5,6,9 against BTP SDK 24.8 #18

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+1,034 −55
Draft

Add JC content for tutorial 3,4,5,6,9 against BTP SDK 24.8 #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 109 additions & 9 deletions tutorials/sdk-android-wizard-app-logging/sdk-android-wizard-app-logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,47 @@ time: 15

### Use the logging component

[OPTION BEGIN [Jetpack Compose-based UI]]

1. In Android Studio, on Windows, press **`Ctrl+N`**, or, on a Mac, press **`command+O`**, and enter **`EntitySetListActivity`** to open `EntitySetListActivity.kt`.
1. In Android Studio, on Windows, press **`Ctrl+N`**, or on a Mac, press **`command+O`**, and enter **`SettingsViewModel`** to open `SettingsViewModel.kt`.

2. On Windows, press **`Ctrl+F12`**, or, on a Mac, press **`command+F12`**, and enter **`onOptionsItemSelected`** to move to the `onOptionsItemSelected` method.
2. On Windows, press **`Ctrl+F`**, or on a Mac, press **`command+F`**, and enter **`init`** to navigate to the `init` block.

Note that the following code block contains two logger statements:

```Kotlin
init {
//init from shared preference
viewModelScope.launch(Dispatchers.Default) {
preferencesFlow.collect { userReference ->
logger.debug("get preference as {}", userReference.logSetting)
_settingUIState.update { uiState ->
uiState.copy(level = LogPolicy.getLogLevel(userReference.logSetting))
}
}
}

val consentUsage = UserSecureStoreDelegate.getInstance().getConsentStatus(ConsentType.USAGE)
val consentCrashReport =
UserSecureStoreDelegate.getInstance().getConsentStatus(ConsentType.CRASH_REPORT)
logger.debug(
"init consent data : consentUsage {}, consentCrashReport {}",
consentUsage,
consentCrashReport
)

... ...
```

These messages will be logged when the app's log level is set to **Debug** or **Path** and the app's **Settings** menu item is opened.

[OPTION END]

[OPTION BEGIN [View-based UI]]

1. In Android Studio, on Windows, press **`Ctrl+N`**, or on a Mac, press **`command+O`**, and enter **`EntitySetListActivity`** to open `EntitySetListActivity.kt`.

2. On Windows, press **`Ctrl+F12`**, or on a Mac, press **`command+F12`**, and enter **`onOptionsItemSelected`** to navigate to the `onOptionsItemSelected` method.

Note that the following method contains two LOGGER statements:

Expand All @@ -48,25 +85,56 @@ time: 15

These messages will be logged when the app's log level is set to **Debug** or **Path** and the app's **Settings** menu item is opened.

[OPTION END]


### Change the log level

[OPTION BEGIN [Jetpack Compose-based UI]]

1. Navigate to the entity list screen and open the app's menu.

![Settings menu button](settings_menu_button.png)

2. Choose **Settings**.

![Settings menu opened](settings_menu.png)
3. Select **Log Level** displayed in **Logging** on the **Settings** screen.

3. Select **Log Level**.
4. Set the level to **Debug**.

![Log level settings option](log_level_option.png)
5. Navigate back to the entity list screen, then back into the **Settings** screen to see the effect of changing the log level.

4. Set the level to **Debug**.
![Settings menu opened](settings_menu_jc.png)

6. Examine the **Logcat** (located at the bottom of the Android Studio screen, click it and you can see the logs). In the filter, add the name of the class that we are interested in seeing the log from: **`com.sap.wizapp.ui.odata.viewmodel.SettingsViewModel`**.

Notice that the messages were logged since the log level of the app was set to **Debug** or **Path**.

![Debug log level output](debug_log_jc.png)

---

The SDK libraries also log output based on the app's log level.

1. Change the filter to **`com.sap.cloud.mobile.foundation`**.

2. Press **Back** to exit the app and you will see the logged lines from the foundation library.

![Debug log level output for foundation](debug_log_foundation_jc.png)

[OPTION END]

[OPTION BEGIN [View-based UI]]

1. Navigate to the entity list screen and open the app's menu.

![Settings menu button](settings_menu_button.png)

2. Choose **Settings**.

![Debug log level option](debug_log_level_option.png)
3. Select **Log Level** displayed in **Logging** on the **Settings** screen.

4. Set the level to **Debug**.

5. Navigate back to the entity list screen, then back into the **Settings** screen to see the effect of changing the log level.

Expand All @@ -88,13 +156,44 @@ The SDK libraries also log output based on the app's log level.

![Debug log level output for foundation](debug_log_foundation.png)

[OPTION END]


### Upload and view the log

[OPTION BEGIN [Jetpack Compose-based UI]]

1. Navigate back to the **Settings** screen in the app, and this time tap **Upload Log** right below **Log Level**.

A Toast message is displayed confirming that the upload succeeded.

![Log upload succeeded](log_uploaded_jc.png)

2. In the **Mobile Services cockpit**, navigate to **Mobile Applications** > **Native/MDK** > **com.sap.wizapp** > **Mobile Client Log Upload**.

![Mobile Applications > Native/MDK > com.sap.wizapp > Mobile Client Log Upload](select_and_download_log.png)

3. Select the **Error Logs** tab and you will see the log you just uploaded in the **Error** level list. If the log doesn't appear immediately, wait for a few moments, then click **Go** to refresh the view.

4. You can inspect the log details in the browser by clicking on its table entry.

5. Select the **Log Files** tab and you will see the log files you just uploaded in the list. You can download the files by clicking **Download**.

![View log details](view_log_files.png)

6. Additionally, you can access the logs locally on an emulator. You can browse the file system of an Android emulator using the **Device Explorer** to view the log files as shown below: **data** > **data** > **com.sap.wizapp** (or the package name of your project) > **files**.

![View logs in emulator](local_log_location.png)

7. You can manage the initial log level of the application and the ability for mobile services to accept logs on the **Configuration** page, as shown below.

![Log Policy](client_policies.png)

[OPTION END]

1. Navigate back to the **Settings** menu in the app, and this time tap **Upload Log**.
[OPTION BEGIN [View-based UI]]

![Upload log button in settings menu](upload_log_button.png)
1. Navigate back to the **Settings** menu in the app, and this time tap **Upload Log** right below **Log Level**.

A Toast message is displayed confirming that the upload succeeded.

Expand All @@ -120,6 +219,7 @@ The SDK libraries also log output based on the app's log level.

![Log Policy](client_policies.png)

[OPTION END]

>For further information on logging, see [Logging](https://help.sap.com/doc/f53c64b93e5140918d676b927a3cd65b/Cloud/en-US/docs-en/guides/features/logging/overview.html).

Expand Down
Loading