LogServiceでログを収集する

概要

NFC Wallet SDK は実行時ログを収集し、アプリケーションのサンドボックスに保存します。

デジタルウォレットアプリケーションはログファイルを取得し、トラブルシューティングのために Thales と共有できます。

NFC Wallet SDK 6.14.0 からは、デフォルト設定でログ記録が自動的に有効になります。

SDK 連携

ログサービスを取得する

Secure logger API は非推奨です。LogService を使用する必要があります。

参照 セキュアロガー API から移行する 詳細については、

次を取得します LogService インスタンス:

Java

LogService logService = SDKInitializer.getLogService(context);

Kotlin

val logService = SDKInitializer.getLogService(context)

SDK は SDK 初期化中にデフォルト設定を自動的に適用します。

Java

// 6.14.0 より前
SecureLog secureLog = SDKInitializer.INSTANCE.configureSecureLog(
        new SecureLogConfig.Builder(context)
                .build()
);

secureLog.setLevel(SecureLogLevel.INFO);
List<File> files = secureLog.getFiles();
secureLog.deleteFiles();

// 6.14.0 以降
LogService logService = SDKInitializer.getLogService(context);

logService.setLevel(LogService.Level.INFO);
List<File> files = logService.getFiles();
logService.deleteFiles();

Kotlin

// 6.14.0 より前
val secureLog = SDKInitializer.INSTANCE.configureSecureLog(
    SecureLogConfig.Builder(context).build()
)

secureLog.setLevel(SecureLogLevel.INFO)
val files = secureLog.files
secureLog.deleteFiles()

// 6.14.0 以降
val logService = SDKInitializer.getLogService(context)

logService.setLevel(LogService.Level.INFO)
val files = logService.files
logService.deleteFiles()

ログレベルを変更する

使用する setLevel(...) を使用してログレベルを変更します。デフォルトのログレベルは Level.WARN.

Java

LogService logService = SDKInitializer.getLogService(context);
logService.setLevel(LogService.Level.INFO);

Kotlin

val logService = SDKInitializer.getLogService(context)
logService.setLevel(LogService.Level.INFO)

に設定します。 OFF にすると、新しいログエントリの書き込みを停止します。

ログレベル

ユースケースをサポートする最も低いレベルを使用してください。

レベル	数値	使用する
ALL	7	すべてのログエントリをキャプチャします。 DEBUG.
DEBUG	7	トラブルシューティング用の詳細なログをキャプチャします。必要なときだけ一時的に使用してください。
INFO	6	通常の運用ログをキャプチャします。
ERROR	3	調査が必要な実行時エラーをキャプチャします。
WARN	4	警告をキャプチャします。これはデフォルトレベルです。
FATAL	2	回復不能な実行時エラーのみをキャプチャします。
OFF	0	ログ記録を無効にします。

使用する DEBUG 短時間のトラブルシューティングセッションでのみ。

通常の運用では、デフォルトレベルの WARN.

ログ記録を無効にする

NFC Wallet SDK 6.14.0 以降、ログ記録はデフォルトで有効です。

に設定します。 OFF を無効にするには、

Java

LogService logService = SDKInitializer.getLogService(context);
logService.setLevel(LogService.Level.OFF);

Kotlin

val logService = SDKInitializer.getLogService(context)
logService.setLevel(LogService.Level.OFF)

ログファイルを取得する

を取得したら、 LogService インスタンスを取得して、 getFiles():

Java

LogService logService = SDKInitializer.getLogService(context);

// ファイルのリストを返す
List<File> files = logService.getFiles();

Kotlin

val logService = SDKInitializer.getLogService(context)

// ファイルのリストを返す
val files = logService.files

呼び出します deleteFiles() を呼び出してログファイルを削除します:

Java

LogService logService = SDKInitializer.getLogService(context);
logService.deleteFiles();

Kotlin

val logService = SDKInitializer.getLogService(context)
logService.deleteFiles()

完全な例

この例では、ログサービスのインスタンスを取得し、すべてのログファイルを zip にまとめ、Android の共有シートを使用して共有します。

Java

LogServiceHelper.java

public class LogServiceHelper {

    private static LogService getLogService(Context context) {
        return SDKInitializer.getLogService(context);
    }

    public static void setDebugLogLevel(Context context) {
        LogService logService = getLogService(context);
        logService.setLevel(LogService.Level.DEBUG);
    }

    public static void shareLogs(Activity activity) {
        LogService logService = getLogService(activity.getApplicationContext());
        List<File> files = logService.getFiles();
        if (files == null || files.isEmpty()) {
            // 共有するログがありません
            return;
        }

        File directory = files.get(0).getParentFile();
        String outputZipPath = activity.getCacheDir().getAbsolutePath() + "/temp.zip";

        Thread zipTask = new Thread(new Runnable() {
            @Override
            public void run() {
                File file = new File(outputZipPath);
                if (file.exists()) {
                    file.delete();
                }

                zipFolder(directory.getAbsolutePath(), outputZipPath);

                if (!file.exists() || !file.canRead()) {
                    return;
                }

                // FileProvider を使用する場合は、アプリケーションのマニフェストに宣言してください。
                Uri uri = FileProvider.getUriForFile(activity, "your.fileprovider.authority", file);

                Intent shareIntent = new Intent(Intent.ACTION_SEND);
                shareIntent.setType("application/zip");
                shareIntent.putExtra(Intent.EXTRA_SUBJECT, "ログファイル");
                shareIntent.putExtra(Intent.EXTRA_STREAM, uri);
                shareIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);

                activity.startActivity(Intent.createChooser(shareIntent, "ログを共有"));
            }
        });

        zipTask.start();
    }

    private static void zipFolder(String inputFolderPath, String outZipPath) {
        try {
            FileOutputStream fos = new FileOutputStream(outZipPath);
            ZipOutputStream zos = new ZipOutputStream(fos);
            File srcFile = new File(inputFolderPath);
            File[] files = srcFile.listFiles();

            for (int i = 0; i < files.length; i++) {
                byte[] buffer = new byte[1024];
                FileInputStream fis = new FileInputStream(files[i]);
                zos.putNextEntry(new ZipEntry(files[i].getName()));
                int length;
                while ((length = fis.read(buffer)) > 0) {
                    zos.write(buffer, 0, length);
                }
                zos.closeEntry();
                fis.close();
            }
            zos.close();
        } catch (IOException ioe) {
            Log.e("", ioe.getMessage());
        }
    }
}

Kotlin

LogServiceHelper.kt

object LogServiceHelper {

    private fun getLogService(context: Context): LogService {
        return SDKInitializer.getLogService(context)
    }

    fun setDebugLogLevel(context: Context) {
        val logService = getLogService(context)
        logService.setLevel(LogService.Level.DEBUG)
    }

    fun shareLogs(activity: Activity) {
        val logService = getLogService(activity.applicationContext)
        val files = logService.files
        if (files.isNullOrEmpty()) {
            // 共有するログがありません
            return
        }

        val directory = files[0].parentFile
        val outputZipPath = activity.cacheDir.absolutePath + "/temp.zip"

        val zipTask = Thread {
            val file = File(outputZipPath)
            if (file.exists()) {
                file.delete()
            }

            zipFolder(directory.absolutePath, outputZipPath)

            if (!file.exists() || !file.canRead()) {
                return@Thread
            }

            // FileProvider を使用する場合は、アプリケーションのマニフェストに宣言してください。
            val uri = FileProvider.getUriForFile(activity, "your.fileprovider.authority", file)

            val shareIntent = Intent(Intent.ACTION_SEND).apply {
                type = "application/zip"
                putExtra(Intent.EXTRA_SUBJECT, "ログファイル")
                putExtra(Intent.EXTRA_STREAM, uri)
                addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION)
            }

            activity.startActivity(Intent.createChooser(shareIntent, "ログを共有"))
        }

        zipTask.start()
    }

    private fun zipFolder(inputFolderPath: String, outZipPath: String) {
        try {
            val fos = FileOutputStream(outZipPath)
            val zos = ZipOutputStream(fos)
            val srcFile = File(inputFolderPath)
            val files = srcFile.listFiles() ?: return

            for (currentFile in files) {
                val buffer = ByteArray(1024)
                val fis = FileInputStream(currentFile)
                zos.putNextEntry(ZipEntry(currentFile.name))
                var length: Int
                while (fis.read(buffer).also { length = it } > 0) {
                    zos.write(buffer, 0, length)
                }
                zos.closeEntry()
                fis.close()
            }
            zos.close()
        } catch (ioe: IOException) {
            Log.e("", ioe.message ?: "")
        }
    }
}

Secure logger API から移行する

非推奨の設定コードを削除します。

その後、必要なときに LogService インスタンスを取得します。

非推奨 API	置き換え先
SDKInitializer.INSTANCE.configureSecureLog(SecureLogConfig)	SDKInitializer.getLogService(Context)
SecureLogConfig.Builder(...)	置き換えはありません。SDK はデフォルト設定を使用します。
secureLog.setLevel(SecureLogLevel.X)	logService.setLevel(LogService.Level.X)
secureLog.getFiles()	logService.getFiles()
secureLog.deleteFiles()	logService.deleteFiles()