Recopilar registros con LogService

Resumen

El SDK de NFC Wallet recopila registros de tiempo de ejecución y los almacena en el sandbox de la aplicación.

Tu aplicación de cartera digital puede recuperar archivos de registro y compartirlos con Thales para la resolución de problemas.

A partir de NFC Wallet SDK 6.14.0, el registro se habilita automáticamente con la configuración predeterminada.

Integración del SDK

Obtener el servicio de registro

La API de secure logger está obsoleta. Debes usar LogService.

Consulte Migrar desde la API de secure logger para más detalles.

Recupera el LogService instancia:

Java

LogService logService = SDKInitializer.getLogService(context);

Kotlin

val logService = SDKInitializer.getLogService(context)

El SDK aplica automáticamente la configuración predeterminada durante la inicialización del SDK.

Java

// Antes de 6.14.0
SecureLog secureLog = SDKInitializer.INSTANCE.configureSecureLog(
        new SecureLogConfig.Builder(context)
                .build()
);

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

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

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

Kotlin

// Antes de 6.14.0
val secureLog = SDKInitializer.INSTANCE.configureSecureLog(
    SecureLogConfig.Builder(context).build()
)

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

// Desde 6.14.0
val logService = SDKInitializer.getLogService(context)

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

Cambiar el nivel de registro

Use setLevel(...) para cambiar el nivel de registro. El nivel de registro predeterminado es Level.WARN.

Java

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

Kotlin

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

Establece el nivel en OFF para dejar de escribir nuevas entradas de registro.

Niveles de registro

Usa el nivel más bajo que admita tu caso de uso.

Nivel	Valor numérico	Use
ALL	7	Captura todas las entradas de registro. Equivalente a DEBUG.
DEBUG	7	Captura registros detallados para la resolución de problemas. Úsalo solo temporalmente.
INFO	6	Captura registros operativos rutinarios.
ERROR	3	Captura errores de tiempo de ejecución que requieren investigación.
WARN	4	Captura advertencias. Este es el nivel predeterminado.
FATAL	2	Captura solo errores de tiempo de ejecución irrecuperables.
OFF	0	Deshabilitar el registro.

Use DEBUG solo para sesiones breves de resolución de problemas.

Para el funcionamiento normal, mantén el nivel predeterminado WARN.

Deshabilitar el registro

A partir de NFC Wallet SDK 6.14.0, el registro está habilitado de forma predeterminada.

Establece el nivel en OFF para deshabilitarlo:

Java

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

Kotlin

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

Recuperar archivos de registro

Después de recuperar la LogService instancia, llama a getFiles():

Java

LogService logService = SDKInitializer.getLogService(context);

// Devuelve la lista de archivos
List<File> files = logService.getFiles();

Kotlin

val logService = SDKInitializer.getLogService(context)

// Devuelve la lista de archivos
val files = logService.files

Llamar a deleteFiles() para eliminar los archivos de registro:

Java

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

Kotlin

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

Ejemplo completo

Este ejemplo recupera la instancia del servicio de registro, comprime todos los archivos de registro y los comparte mediante una hoja de uso compartido de 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()) {
            // No hay ningún registro para compartir
            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;
                }

                // Si usas un FileProvider, decláralo en el manifiesto de la aplicación.
                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, "Archivos de registro");
                shareIntent.putExtra(Intent.EXTRA_STREAM, uri);
                shareIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);

                activity.startActivity(Intent.createChooser(shareIntent, "Compartir registros"));
            }
        });

        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()) {
            // No hay ningún registro para compartir
            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
            }

            // Si usas un FileProvider, decláralo en el manifiesto de la aplicación.
            val uri = FileProvider.getUriForFile(activity, "your.fileprovider.authority", file)

            val shareIntent = Intent(Intent.ACTION_SEND).apply {
                type = "application/zip"
                putExtra(Intent.EXTRA_SUBJECT, "Archivos de registro")
                putExtra(Intent.EXTRA_STREAM, uri)
                addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION)
            }

            activity.startActivity(Intent.createChooser(shareIntent, "Compartir registros"))
        }

        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 ?: "")
        }
    }
}

Migrar desde la API de secure logger

Elimina el código de configuración obsoleto.

Después, recupera la LogService instancia cuando la necesites.

API obsoleta	Reemplazo
SDKInitializer.INSTANCE.configureSecureLog(SecureLogConfig)	SDKInitializer.getLogService(Context)
SecureLogConfig.Builder(...)	No hay reemplazo. El SDK usa la configuración predeterminada.
secureLog.setLevel(SecureLogLevel.X)	logService.setLevel(LogService.Level.X)
secureLog.getFiles()	logService.getFiles()
secureLog.deleteFiles()	logService.deleteFiles()