How do I collect Mobile SDK logs?

Logging can be helpful when you run into any issues. They contain information on how you use our products that helps us analyze, troubleshoot, and debug any issues you may experience.

Collect logs from your application
Collect logs from Regula DocReader application

Collect logs from your application

Enable parameters listed below in your code in addition to those you already use:

Warning

These parameters should be set before starting the recognition process, e.g. after the initialization process is passed.

If you are experiencing the issue with ID documents recognition or verification, choose the following settings:

DocumentReader.Instance().processParams().debugSaveLogs = true;
DocumentReader.Instance().processParams().debugSaveCroppedImages = true;

DocumentReader.Instance().processParams().debugSaveLogs = true
DocumentReader.Instance().processParams().debugSaveCroppedImages = true

DocReader.shared.processParams.debugSaveLogs = true
DocReader.shared.processParams.debugSaveCroppedImages = true

[RGLDocReader shared].processParams.debugSaveLogs = @YES;
[RGLDocReader shared].processParams.debugSaveCroppedImages = @YES;

// Xamarin.Android
DocumentReader.Instance().ProcessParams().DebugSaveLogs = (Java.Lang.Boolean)true;
DocumentReader.Instance().ProcessParams().DebugSaveCroppedImages = (Java.Lang.Boolean)true;

// Xamarin.iOS
RGLDocReader.Shared.ProcessParams.DebugSaveLogs = true;
RGLDocReader.Shared.ProcessParams.DebugSaveCroppedImages = true;

DocumentReader.setConfig({
    processParams: {
        debugSaveLogs: true,
        debugSaveCroppedImages: true
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });

DocumentReader.setConfig({
    processParams: {
        debugSaveLogs: true,
        debugSaveCroppedImages: true
    },
}, function (m) { }, function (e) { console.log(e); });

DocumentReader.setConfig({
    processParams: {
        debugSaveLogs: true,
        debugSaveCroppedImages: true
    }
});

DocumentReader.setConfig({
  "processParams": {
    "debugSaveLogs": true,
    "debugSaveCroppedImages": true
  }
});

If you are experiencing the issue with RFID chip reading, choose the following settings:

DocumentReader.Instance().processParams().debugSaveLogs = true;
DocumentReader.Instance().processParams().debugSaveCroppedImages = true;
DocumentReader.Instance().processParams().debugSaveRFIDSession = true;

DocumentReader.Instance().processParams().debugSaveLogs = true 
DocumentReader.Instance().processParams().debugSaveCroppedImages = true 
DocumentReader.Instance().processParams().debugSaveRFIDSession = true

DocReader.shared.processParams.debugSaveLogs = true 
DocReader.shared.processParams.debugSaveCroppedImages = true 
DocReader.shared.processParams.debugSaveRFIDSession = true

[RGLDocReader shared].processParams.debugSaveLogs = @YES;
[RGLDocReader shared].processParams.debugSaveCroppedImages = @YES;
[RGLDocReader shared].processParams.debugSaveRFIDSession = @YES;

// Xamarin.Android
DocumentReader.Instance().ProcessParams().DebugSaveLogs = (Java.Lang.Boolean)true;
DocumentReader.Instance().ProcessParams().DebugSaveCroppedImages = (Java.Lang.Boolean)true;
DocumentReader.Instance().ProcessParams().DebugSaveRFIDSession = (Java.Lang.Boolean)true;

// Xamarin.iOS
RGLDocReader.Shared.ProcessParams.DebugSaveLogs = true;
RGLDocReader.Shared.ProcessParams.DebugSaveCroppedImages = true;
RGLDocReader.Shared.ProcessParams.DebugSaveRFIDSession = true;

DocumentReader.setConfig({
    processParams: {
        debugSaveLogs: true,
        debugSaveCroppedImages: true,
        debugSaveRFIDSession: true
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });

DocumentReader.setConfig({
    processParams: {
        debugSaveLogs: true,
        debugSaveCroppedImages: true,
        debugSaveRFIDSession: true
    },
}, function (m) { }, function (e) { console.log(e); });

DocumentReader.setConfig({
    processParams: {
        debugSaveLogs: true,
        debugSaveCroppedImages: true,
        debugSaveRFIDSession: true
    }
});

DocumentReader.setConfig({
  "processParams": {
    "debugSaveLogs": true,
    "debugSaveCroppedImages": true,
    "debugSaveRFIDSession": true
  }
});

Now you can build and run your application and take the steps needed to reproduce the issue
After the step 2 is performed, logs can be found in the app folder - you can print the path to it in the console like that:

Warning

Insert these lines of code after all the needed steps are completed.

String path = DocumentReader.Instance().processParams().sessionLogFolder;
Log.d("Regula" , "Path: " + path);

val path = DocumentReader.Instance().processParams().sessionLogFolder
Log.d("Regula" , "Path: $path")

let path = DocReader.shared.processParams.sessionLogFolder
print("Path: \(path ?? "nil")")

NSString *path = [RGLDocReader shared].processParams.sessionLogFolder;
NSLog(@"Path: %@", path);

// Xamarin.Android
string path = DocumentReader.Instance().ProcessParams().SessionLogFolder;
Console.WriteLine("Path: " + path);

// Xamarin.iOS
var path = RGLDocReader.Shared.ProcessParams.SessionLogFolder;
Console.WriteLine("Path: " + path);

DocumentReader.getSessionLogFolder((path) => {
    console.log("Path: " + path);
},
(error) => {
    console.log(error);
});

DocumentReader.getSessionLogFolder(
    function (path) { console.log("Path: " + path) },
);

 DocumentReader.getSessionLogFolder().then(path => {
    console.log("Path: " + path);
});

DocumentReader.getSessionLogFolder().then((path) {
  print("Path: " + path);
}).catchError(
    (Object error) => print((error as PlatformException).message));

Collect logs from Regula DocReader application

Our apps are available on App Store and Google Play.

Open the app and wait until the app launches.
Open Menu.
Open Settings.
Navigate to the Advanced section.
Then to the Debug section.
Enable settings according to the issue you experience:
- If you are experiencing the issue with ID documents recognition or verification, choose the following settings:
  - Save event logs
  - Save cropped images
- If you are experiencing the issue with RFID chip reading, choose the following settings:
  - Save event logs
  - Save cropped images
  - Save RFID session
Perform other steps needed to reproduce the issue.

You can see logs on the results screen after the document recognition is finished or find them in the logs table: Home ⇾ Menu ⇾ Settings ⇾ Advanced ⇾ Debug ⇾ Report event logs. Save logs and fill in the requested form with a clear and detailed description with as much information as possible including steps you’ve taken to solve the problem and conditions we should consider (such as failing on specific hardware or OS version).

How do I collect Mobile SDK logs?

Collect logs from your application

Warning

Warning

Collect logs from Regula DocReader application

Comments

Articles in this section