Collect logs with secure logger

Overview

The secure logger collects NFC Wallet SDK execution logs. It stores them securely in the application sandbox.

Your digital wallet application can retrieve log files and share them with Thales for troubleshooting.

SDK Integration

Set the log level

Secure logger is enabled by default with the log level set to warn.

Log level	Description
debug	Log detailed information for troubleshooting and debugging.
info	Log routine messages, such as API entry/exit points and returned values.
warn	Log warnings and critical flow issues during normal execution.
error	Log errors that prevent a flow from completing successfully.
fatal	Log runtime errors that require immediate action.
off	Disable logging.

Get the secure logger instance

Get the secure logger instance from the SDK:

// get securelog object from TSHPay sdk
let securelog = TSHPay.secureLog

In production, keep warn in normal conditions.

For issue reproduction, let the end user enable a more verbose level. Then reproduce the issue and share the log files.

Disable secure logger

To disable secure logger:

// By setting the level to off, logs are disabled. MPA can turn it on by selecting a different level. For example, debug
securelog.setLevel(.off)

Retrieve log files

To retrieve the log files:

// return list of files
let files = securelog.files()

Delete log files

To delete the log files:

// delete files
securelog.deleteFiles()

Share log files (example)

This example shares logs using UIActivityViewController.

Your digital wallet application can also upload logs to a file server.

You can also send logs through other approved channels.

// share logs
    func archieveLogsURL(_ onComplete: @escaping (URL?) -> ()) {
        var error: NSError?
        guard let file = TSHPay.secureLog.files().first?.absoluteURL.deletingLastPathComponent(),
            let fileURL = URL(string: "file://\(file.absoluteString)") else {
            onComplete(nil)
            return
        }
        
        NSFileCoordinator().coordinate(
            readingItemAt: fileURL,
            options: [.forUploading],
            error: &error
        ) { zipUrl in
            do {
                let tmpUrl = try FileManager.default
                    .url(
                        for: .itemReplacementDirectory,
                        in: .userDomainMask,
                        appropriateFor: zipUrl,
                        create: true
                    )
                    .appendingPathComponent("archive.zip")
                
                try FileManager.default.moveItem(at: zipUrl, to: tmpUrl)
                onComplete(tmpUrl)
            } catch {
                onComplete(nil)
            }
        }
    }