How can I set the log file?

The Agora SDK allows you to configure the output log file. All logs generated by the SDK are written to this file.

Native platforms include Android, iOS, macOS, and Windows.

When you create and initialize an RtcEngine instance, use the mLogConfig parameter to set the log file.

By default, the SDK generates five log files for the SDK and five for API calls. All log files are encoded in UTF-8.

• SDK log files: agorasdk.log, agorasdk.1.log, agorasdk.2.log, agorasdk.3.log, agorasdk.4.log
• API call log files: agoraapi.log, agoraapi.1.log, agoraapi.2.log, agoraapi.3.log, agoraapi.4.log

The most recent logs are always written to agorasdk.log and agoraapi.log. When agorasdk.log is full, the SDK handles the log files as follows:

1. Deletes agorasdk.4.log, if present.
2. Renames agorasdk.3.log to agorasdk.4.log.
3. Renames agorasdk.2.log to agorasdk.3.log.
4. Renames agorasdk.1.log to agorasdk.2.log.
5. Creates a new agorasdk.log.

The agoraapi.log file follows the same rules.

• Android: /storage/emulated/0/Android/data/<package_name>/files/agorasdk.log
• iOS: App Sandbox/Library/Caches/agorasdk.log
• macOS:
  • Sandbox enabled: ~/Library/Containers/<App_Bundle_Identifier>/Data/Library/Logs/agorasdk.log
  • Sandbox disabled: ~/Library/Logs/agorasdk.log
• Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log

info

Agora recommends using the default log file storage path. If you need to change the path, make sure the specified path exists and is writable.

Use the level field in the mLogConfig parameter to set the log output level. You can choose from the following levels:

• INFO (default): Logs at FATAL, ERROR, WARN, and INFO levels. Recommended.
• WARN: Logs at FATAL, ERROR, and WARN levels.
• ERROR: Logs at FATAL and ERROR levels.
• FATAL: Logs only FATAL level.
• NONE: No logs are recorded.

By default, each SDK log file is 2,048 KB. The API call log file size is also 2,048 KB. To set a custom log file size, use the fileSizeInKB field in the mLogConfig parameter.

• The size of each agorasdk.log file can be between 128 and 20,480 KB.
• This setting applies only to agorasdk.log, not agoraapi.log.

Java

RtcEngineConfig.LogConfig logConfig = new RtcEngineConfig.LogConfig();// Set log filter level to ERRORlogConfig.level = Constants.LogLevel.getValue(Constants.LogLevel.LOG_LEVEL_ERROR);// Set log file pathString ts = new SimpleDateFormat("yyyyMMdd").format(new Date());logConfig.filePath = "/sdcard/" + ts + ".log";// Set log file size to 2 MBlogConfig.fileSize = 2048;RtcEngineConfig config = new RtcEngineConfig();config.mAppId = getString(R.string.agora_app_id);config.mEventHandler = iRtcEngineEventHandler;config.mContext = context.getApplicationContext();config.mAreaCode = getAreaCode();config.mLogConfig = logConfig;mRtcEngine = RtcEngine.create(config);

Swift

let logConfig = AgoraLogConfig()// Set log filter level to ERRORlogConfig.level = AgoraLogLevel.error// Set log file pathlet formatter = DateFormatter()formatter.dateFormat = "ddMMyyyyHHmm"let folder = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true)logConfig.filePath = "(folder[0])/logs/(formatter.string(from: Date())).log"// Set log file size to 2 MBlogConfig.fileSize = 2 * 1024let config = AgoraRtcEngineConfig()config.appId = KeyCenter.AppIdconfig.areaCode = GlobalSettings.shared.area.rawValueconfig.logConfig = logConfigagoraKit = AgoraRtcEngineKit.sharedEngine(with: config, delegate: self)

Objective-C

AgoraLogConfig *logConfig = [[AgoraLogConfig alloc] init];// Set log filter level to ERRORlogConfig.level = AgoraLogLevelError;// Set log file pathNSDateFormatter *formatter = [[NSDateFormatter alloc] init];[formatter setDateFormat:@"ddMMyyyyHHmm"];NSString *folder = NSSearchPathForDirectoriesInDomains( NSDocumentDirectory, NSUserDomainMask, YES )[0];logConfig.filePath = [NSString stringWithFormat:@"%@/logs/%@.log", folder, [formatter stringFromDate:[NSDate date]]];// Set log file size to 2MBlogConfig.fileSizeInKB = 2 * 1024;AgoraRtcEngineConfig *config = [[AgoraRtcEngineConfig alloc] init];config.appId = KeyCenter.AppId;config.areaCode = [GlobalSettings sharedSettings].areaCode;config.logConfig = logConfig;self.agoraKit = [AgoraRtcEngineKit sharedEngineWithConfig:config delegate: self];

C++

LogConfig logConfig;// Set log filter level to ERRORlogConfig.level = LOG_LEVEL::LOG_LEVEL_ERROR;// Set log file pathtime_t rawtime;struct tm * timeinfo;char buffer[128];time(&rawtime);timeinfo = localtime(&rawtime);strftime(buffer, sizeof(buffer), "c:\log\%Y%m%d.log", timeinfo);logConfig.filePath = buffer;// Set log file size to 2MBlogConfig.fileSize = 2048;RtcEngineContext context;context.logConfig = logConfig;std::string strAppID = GET_APP_ID;context.appId = strAppID.c_str();context.eventHandler = &m_eventHandler;int ret = m_rtcEngine->initialize(context);

• Android
  • create[2/2]
• iOS/macOS
  • sharedEngineWithConfig
• Windows
  • initialize

You can also get the stack information when crashes occur:

• Android: Run the adb bugreport command
• iOS：
  • Open Xcode and go to Window > Devices and Simulators.
  • Select the Devices tab and choose the device where the crash occurred.
  • Under Installed Apps, find the relevant app.
  • Click the Settings icon (gear button) below the app list.
  • Select Download Container.
  • Once downloaded, right-click the container file and choose Show Package Contents.
  • Navigate to AppData > Library > Caches to find the agorasdk.log file with stack information
• macOS: ~/Library/Logs/DiagnosticReports/
• Windows: You need to capture dump files

On Android and iOS, if you have integrated Bugly in your app, you can also use Bugly to get the stack information.

Call enableLogUpload to upload Agora Web SDK logs to Agora servers, and call disaleLogUpload to stop the upload.

To ensure that the output log is complete, call enableLogUpload before creating the client object.

If you fail to join a channel, logs are unavailable on Agora servers.

Call setLogLevel to set the log output level. When you select a level, you can see the logs in the preceding levels.

• DEBUG: Outputs all logs.
• INFO: Outputs logs in the INFO, WARNING and ERROR levels.
• WARNING: Outputs logs in the WARNING and ERROR levels.
• ERROR: Outputs logs in the ERROR level.
• NONE: Outputs no log.

_5

// Javascript

_5

// Enable log upload

_5

AgoraRTC.enableLogUpload();

_5

// Set the log output level as INFO

_5

AgoraRTC.setLogLevel(1);

• enableLogUpload
• disableLogUpload
• setLogLevel