How to set and get SDK logs and stack information for Express?

Native Platform

Native platform mainly refers to Android, iOS, macOS and Windows platforms.

Set log properties

By default, the SDK generates two types of log files:

• TXT log files starting with "zegoavlog", with a default maximum size of 5MB (5 * 1024 * 1024 Bytes) per log file.

• Zip compressed files named zegoavlog{number}-{timestamp}. After decompression, you get a TXT log file named zegoavlog{number}-{timestamp}. The zegoavlog{number} may be different, but the {timestamp} is the same.

  For example, zegoavlog3-16901111.zip decompresses to zegoavlog2-16901111.txt log file.

The default storage paths for each platform are:

• Android: "/storage/Android/data/[application package name]/files"
• iOS: "~/Library/Caches/ZegoLogs"
• macOS:
  • Sandbox: "~/Library/Containers/[application package name Bundle ID]/Data/Library/Caches/ZegoLogs"
  • Non-sandbox: "~/Library/Caches/ZegoLogs"
• Windows: "C:\Users\current username\AppData\[application package name]\ZEGO.SDK\ZegoLogs"
• Linux: No default storage path. Developers need to actively call the setLogConfig interface to customize the SDK log file size and path. For example: "~/zegolog"
• HarmonyOS: "/data/app/el2/100/base/{package name}/files"

Developers can also set ZegoLogConfig properties, including the log storage path "logPath" and the maximum log file size "logSize", and call the setLogConfig interface to customize the SDK's log properties.

Android

For example, set the log storage path to "/data/user/0/package name/files" and the maximum size of a single log file to 5MB:

ZegoLogConfig logConfig;
// Set log storage path
logConfig.logPath = getApplicationContext().getFilesDir().getAbsolutePath();
// Set the maximum size of a single log file
logConfig.logSize = 5242880L;
ZegoExpressEngine.setLogConfig(logConfig);

ZegoLogConfig logConfig;
// Set log storage path
logConfig.logPath = getApplicationContext().getFilesDir().getAbsolutePath();
// Set the maximum size of a single log file
logConfig.logSize = 5242880L;
ZegoExpressEngine.setLogConfig(logConfig);

API Reference: ZegoLogConfig, setLogConfig

iOS/macOS

For example, set the log storage path to "[[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingString:@"/ZegoLogs"]" and the maximum size of a single log file to 5MB:

// Set log storage path
NSString *appLogPath = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingString:@"/ZegoLogs"];
ZegoLogConfig *logConfig = [[ZegoLogConfig alloc] init];
logConfig.logPath = appLogPath;
// Set the maximum size of a single log file
logConfig.logSize = 5 * 1024 * 1024;
[ZegoExpressEngine setLogConfig:logConfig];

// Set log storage path
NSString *appLogPath = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingString:@"/ZegoLogs"];
ZegoLogConfig *logConfig = [[ZegoLogConfig alloc] init];
logConfig.logPath = appLogPath;
// Set the maximum size of a single log file
logConfig.logSize = 5 * 1024 * 1024;
[ZegoExpressEngine setLogConfig:logConfig];

API Reference:

• iOS: ZegoLogConfig, setLogConfig
• macOS: ZegoLogConfig, setLogConfig

Windows/Linux

For example, set the log storage path to "/Users/zego/Log/log.txt" and the maximum size of a single log file to 5MB:

ZegoLogConfig logConfig;
// Set log storage path
logConfig.logPath = "/Users/zego/Log/log.txt";
// Set the maximum size of a single log file
logConfig.logSize = 5242880L;
ZegoExpressSDK::setLogConfig(logConfig);

ZegoLogConfig logConfig;
// Set log storage path
logConfig.logPath = "/Users/zego/Log/log.txt";
// Set the maximum size of a single log file
logConfig.logSize = 5242880L;
ZegoExpressSDK::setLogConfig(logConfig);

API Reference: ZegoLogConfig, setLogConfig

HarmonyOS

For example, set the log storage path to "/data/storage/el2/base/files" and the maximum size of a single log file to 5MB:

// set log config
let logConfig:ZegoLogConfig = new ZegoLogConfig();
logConfig.logPath = path;
logConfig.logSize = 5 *1024 * 1024;
ZegoExpressEngine.setLogConfig(logConfig)

// set log config
let logConfig:ZegoLogConfig = new ZegoLogConfig();
logConfig.logPath = path;
logConfig.logSize = 5 *1024 * 1024;
ZegoExpressEngine.setLogConfig(logConfig)

API Reference: ZegoLogConfig, setLogConfig

Get log information

Android, iOS, macOS, Windows, Linux and HarmonyOS platforms can get SDK log information according to the following methods.

Android

In the "/storage/Android/data/[application package name]/files" path, TXT files starting with "zegoavlog" are log information.

iOS/iPadOS

1. Connect the iOS device to Mac, open Xcode, and select "Window > Devices and Simulators" from the top menu bar.

2. Select the specified device on the left, then find the App that needs to get logs in "INSTALLED APPS", click the gear icon below, select "Download Container..." and save it.

3. Open "Finder" to find the saved ".xcappdata" file, right-click and select "Show Package Contents", select the "AppData/Library/Caches/ZegoLogs" directory. TXT files starting with "zegoavlog" are log information.

macOS

• Sandbox: In the "~/Library/Containers/[application package name Bundle ID]/Data/Library/Caches/ZegoLogs" path, TXT files starting with "zegoavlog" are log information.

• Non-sandbox: In the "~/Library/Caches/ZegoLogs" path, TXT files starting with "zegoavlog" are log information.

Windows

The log folder is named: "program process name" + "ZEGO.SDK". In "My Computer" path, directly enter "%APPDATA%" and press Enter to locate the log folder storage directory. TXT files starting with "zegoavlog" are log information.

Linux

In the log folder, TXT files starting with "zegoavlog" are log information.

The Linux platform has no default storage path. Developers should search according to the SDK log file path customized in the setLogConfig interface.

HarmonyOS

Connect the HarmonyOS device to Mac/PC, open devEco-studio, select the Device File Browser module, open the directory "/data/app/el2/100/base/{package name}/files/" to find txt or zip files starting with "zegoavlog".

Get stack information

When a crash occurs, the SDK generates crash stack information. Android, iOS, macOS, Windows, Linux and HarmonyOS platforms can get SDK stack information according to the following methods.

Android

• Real-time log analysis

adb logcat | ndk-stack -sym [directory where the so dynamic library of the target abi (armeabi/armeabi-v7a/arm64-v8a) is located]

For example:

adb logcat | ndk-stack -sym /path/to/your/project/armeabi-v7a

• Get logs first and then analyze (use adb logcat to save log files, then analyze with ndk-stack command)

adb logcat > xx.log

ndk-stack -sym [directory where the so dynamic library of the target abi is located] -dump [log file]

For example:

adb logcat > crash.log

ndk-stack -sym /path/to/your/project/armeabi-v7a -dump crash.log

iOS/iPadOS

There are two ways to get it:

• First Xcode method:
  1. Connect the iOS device to Mac, open Xcode, and select "Window > Devices and Simulators" from the top menu bar.
  2. Select the specified device on the left, then click "View Device Logs", find the log corresponding to the application package name in Process and the corresponding time with Type as Crash, right-click on this log and select "Export Log". The saved ".crash" file is the stack information.
• Second Xcode method:
  1. Connect the iOS device to Mac, open Xcode, and select "Window > Devices and Simulators" from the top menu bar.
  2. Select the specified device on the left, then click "Open Recent Logs", and find the ".ips" file corresponding to the time as the stack information.

macOS

In the "~/Library/Logs/DiagnosticReports" path, files ending with ".crash" are stack information.

Windows

1. Find the registry path:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\WindowsError Reporting\LocalDumps

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\WindowsError Reporting\LocalDumps

2. In the right window, create new string values DumpCount, DumpFolder, DumpType and modify their values as follows: DumpType values: 0 = Create a custom dump 1 = Mini dump 2 = Full dump

3. When the program crashes, the system will generate a Dump file for the corresponding program in the DumpFolder directory set above, which is the stack information.

Linux

1. Open core switch
   • Command line method

   # Enter the following command in the command line
   ulimit -c unlimited

   # Enter the following command in the command line
   ulimit -c unlimited

   • Modify configuration file method

   vim /etc/security/limits.conf
   # In the opened file, remove the comment before the line containing soft core 0 and change 0 to unlimited

   vim /etc/security/limits.conf
   # In the opened file, remove the comment before the line containing soft core 0 and change 0 to unlimited

2. Modify core generation path and naming rules

By default, after opening the core switch using any of the above methods, when the program crashes, a stack information file named core will be generated in the directory where the program was started. The newly generated core will overwrite the existing core. By modifying /proc/sys/kernel/core_pattern, you can control the location and file format of core files

# For example: generate all core files to the /corefile directory, with the file name format as core-command name-pid-timestamp.
echo "/corefile/core-%e-%p-%t" > /proc/sys/kernel/core_pattern

# For example: generate all core files to the /corefile directory, with the file name format as core-command name-pid-timestamp.
echo "/corefile/core-%e-%p-%t" > /proc/sys/kernel/core_pattern

HarmonyOS

Connect the HarmonyOS device to Mac/PC, open devEco-studio, select the Log module, open the FaultLog column to find the corresponding package name. There are two directories: cppcrash and jscrash, which contain the crash information of the native layer and the ets layer. Right-click on the file to export the crash stack information.

Web Platform

The Web platform has log reporting enabled by default.

Set log output level

Call the setLogConfig interface and set the log level printed by the local console through the "logLevel" property in the ZegoLogConfig object.

const config = {
    logLevel: 'debug',
};
zg.setLogConfig(config);

const config = {
    logLevel: 'debug',
};
zg.setLogConfig(config);

Other Platforms

When using cross-platform frameworks such as Flutter, Electron, uni-app, Unity3D, React Native, etc., you can refer to the above Native Platform methods for setting and getting logs.