D1 SDKログを取得する

Android

Secure logs

D1 SDK can be configured to generate secure encrypted log files.

These files can only be read by the Thales delivery team.

Enable or disable secure logging

The Secure Log feature is enabled by default. It can however be disabled during the initialisation of D1 SDK as follows.

Configuration for D1 SDK V4.3.0 and Later

fun setupD1Task() {
        // Integrator should assign the Activity class that is used to receive callback for D1Task.handleCardResult
        val activity: FragmentActivity? = null

        // Ask Thales delivery team for the following information.
        val d1ServiceUrl = "https://www.123.com"
        val issuerID = "IssuerID"
        val digitalCardUrl = "https://www.456.com"
        val applicationContext: Context? = null // Integrator should assign the application context.

        // Initialize all necessary settings for D1 SDK.
        val d1Task: D1Task = D1Task.Builder()
            .setContext(applicationContext!!)
            .setD1ServiceURL(d1ServiceUrl)
            .setIssuerID(issuerID)
            .setDigitalCardURL(digitalCardUrl)
            .disableLogService() // disable Secure Log
            .build()

        // Initialize the required SDKs.
        // Application is required to provide consumerId.
        val consumerID = "consumerID"
        val coreConfig = ConfigParams.buildConfigCore(consumerID)

        // Required for Card Processing and OEM Pay.
        // Last parameter is used for Samsung Pay Service ID.
        // Last parameter is used for Samsung Pay Service ID.
        val cardConfig = ConfigParams.buildConfigCard(activity, OEMPayType.GOOGLE_PAY, null, null)

        val configCallback: ConfigCallback<Void?> = object : ConfigCallback<Void?> {
            override fun onSuccess(ignored: Void?) {
                // D1 config is successful.
            }

            override fun onError(exceptions: MutableList<D1Exception?>) {
                // D1 config failed, check exception for more details.
            }
        }

        d1Task.configure(configCallback, coreConfig, cardConfig)
    }

Configuration for D1 SDK Version 4.2.0 and Earlier

fun setupD1TaskVer420() {
        // Integrator should assign the Activity class that is used to receive callback for D1Task.handleCardResult
        val activity: FragmentActivity? = null

        // Ask Thales delivery team for the following information.
        val d1ServiceUrl = "https://www.123.com"
        val issuerID = "IssuerID"
        val digitalCardUrl = "https://www.456.com"
        val applicationContext: Context? = null // Integrator should assign the application context.

        // Initialize all necessary settings for D1 SDK.
        val d1Task = D1Task.Builder()
            .setContext(applicationContext!!)
            .setD1ServiceURL(d1ServiceUrl)
            .setIssuerID(issuerID)
            .setDigitalCardURL(digitalCardUrl)
            .enableSecureLog(false) // disable Secure Log
            .build()

        // Initialize the required SDKs.
        // Application is required to provide consumerId.
        val consumerID = "consumerID"
        val coreConfig = ConfigParams.buildConfigCore(consumerID)

        // Required for Card Processing and OEM Pay.
        // Last parameter is used for Samsung Pay Service ID.
        val cardConfig = ConfigParams.buildConfigCard(activity, OEMPayType.GOOGLE_PAY, null, null)

        val configCallback: ConfigCallback<Void?> = object : ConfigCallback<Void?> {
            override fun onSuccess(ignored: Void?) {
                // D1 config is successful.
            }

            override fun onError(exceptions: MutableList<D1Exception?>) {
                // D1 config failed, check exception for more details.
            }
        }

        d1Task.configure(configCallback, coreConfig, cardConfig)
    }

In this example, the disableLogService method of the D1Task.Builder structure is called so that the SDK does not generate logs after the D1Task object has been instantiated. If the default setting is used where the disableLogService method is not called, the SDK will generate logs for the duration of the application runtime.

There is an option to disable the logs temporarily, if necessary:

Disable logs for D1 SDK V4.3.0 and Later

fun setSecureLogLevel(d1Task: D1Task) {
   // Disable logs temporarily.
   d1Task.getLogService().setLevel(LogService.Level.OFF)

   // Resume logging with the default log level.
   d1Task.getLogService().setLevel(LogService.Level.WARN)
}

Disable logs for D1 SDK V4.2.0 and Earlier

fun setSecureLogLevelVer420(d1Task: D1Task) {
    // Disable logs temporarily.
    d1Task.getSecureLog().setLevel(SecureLogLevel.OFF)

   // Resume logging with the default log level.
    d1Task.getSecureLog().setLevel(SecureLogLevel.WARN)
}

Setting the log level to OFF will prevent any subsequent calls to D1 SDK from generating entries in the secure logs. It is necessary to set the log level back to another value (WARN by default) in order to resume the generating of logs.

Retrieve secure log files

The D1 SDK secure log files are generated within the application sandbox. Retrieving these files can be done as follows:

Log retrieval for D1 SDK V4.3.0 and Later

fun getSecureLogFiles(d1Task: D1Task): MutableList<File?>? {
   val logFiles: MutableList<File?>? = d1Task.getLogService().getFiles()
   return logFiles
}
// Process the files.

Log retrieval for D1 SDK V4.2.0 and Earlier

fun getSecureLogFilesVer420(d1Task: D1Task): MutableList<File?>? { 
     val logFiles = d1Task.getSecureLog().getFiles()
     return logFiles
 }
// Process the files.

The logFiles variable will contain an array of File objects pointing to the available log files. These files are used by the Thales delivery team when investigating an issue.

Logcat

Before you can retrieve the log files from an Android device, ensure that you have done the following setup:

• The Android Debug Bridge tool (ADB) is ready at the host system.

• The USB debugging option is enabled on the device under test.

• The Android device is connected to the host system by means of an USB cable and the USB driver has been installed.

You may execute the following command in the command prompt to verify your setup:

adb devices

A response similar to the following code snippet indicates that the device can be reached by the ADB tool:

List of devices attached
228b0e100d047ece device

If this is not the case, check that the prerequisites are met as specified above.

There are guides available covering these steps on the web.

For setup from the beginning, you may refer to https://support.citrix.com/article/CTX232375.

Warning

Some devices require the device logging to be enabled from a vendor's specific configuration menu.

For example on Huawei devices, this is hidden under a menu that could be reached by dialing *#*#2846579#*#* You may check the information at https://stackoverflow.com/questions/18124334/huawei-logcat-not-showing-the-log-for-my-app for more details.

Recommended steps for capturing logs

1. Open the command prompt and clear all the log buffers in the device:

   adb logcat -b all -c

2. Start the log capturing:

   adb logcat > TestLogFileName.txt

3. Perform the use case(s).

4. Press CTRL+C in the command prompt to stop the log capturing.

5. Recover the resulting log file TestLogFileName.txt in the same command execution folder as mentioned in step 2.

SDK variant and log filters

• In order to obtain the most detailed logging, ensure that the application version used has been built with an SDK variant named debug. See Deliverables section for more details.

• Avoid using log filters that will limit the log messages captured as these data will be useful for troubleshooting purposes.

• It is recommended to limit the size of the log by limiting the time the log is captured. This means that start capturing just before the use case begins and stop capturing immediately after the use case has been completed as described in the the above steps.

Log filters

Different D1 SDK services use different log filters:

• D1 Push filter: TPCSDK

• D1 Pay filter: SDK_ENTRY_POINT, util.h

iOS