agora::commons::LogConfig Struct Reference

Configuration of Agora SDK log files. More...

#include <IAgoraLog.h>

Public Attributes
const char *	filePath
uint32_t	fileSizeInKB
LOG_LEVEL	level

Detailed Description

Configuration of Agora SDK log files.

Member Data Documentation

filePath

const char* agora::commons::LogConfig::filePath

The complete path of the log files. Agora recommends using the default log directory. If you need to modify the default directory, ensure that the directory you specify exists and is writable. The default log directory is:

• Android: /storage/emulated/0/Android/data/<packagename>/files/agorasdk.log.
• iOS: App Sandbox/Library/caches/agorasdk.log.
• macOS:
  • If Sandbox is enabled: App Sandbox/Library/Logs/agorasdk.log. For example, /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.
  • If Sandbox is disabled: ~/Library/Logs/agorasdk.log
• Windows: C:\Users<user_name>\AppData\Local\Agora<process_name>\agorasdk.log.

fileSizeInKB

uint32_t agora::commons::LogConfig::fileSizeInKB

The size (KB) of an agorasdk.log file. The value range is [128,20480]. The default value is 2,048 KB. If you set fileSizeInKByte smaller than 128 KB, the SDK automatically adjusts it to 128 KB; if you set fileSizeInKByte greater than 20,480 KB, the SDK automatically adjusts it to 20,480 KB.

level

LOG_LEVEL agora::commons::LogConfig::level

The output level of the SDK log file. See LOG_LEVEL. For example, if you set the log level to WARN, the SDK outputs the logs within levels FATAL, ERROR, and WARN.