LogConfig

Configuration for SDK log files.

export class LogConfig {

  filePath?: string;

  fileSizeInKB?: number;

  level?: LogLevel;
}

Properties

filePath
Full path of the log file. Agora recommends using the default log path. If you need to modify the default log path, make sure the specified path exists and is writable. Default paths:
  • macOS:
    • Sandbox enabled: App Sandbox/Library/Logs/agorasdk.log, e.g., /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.
    • Sandbox disabled: ~/Library/Logs/agorasdk.log
  • Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log.
fileSizeInKB
Size of a single agorasdk.log file in KB. Range: [128, 20480]. Default: 2,048 KB. If you set fileSizeInKByte to less than 128 KB, the SDK automatically adjusts it to 128 KB; if you set it to more than 20,480 KB, the SDK adjusts it to 20,480 KB.
level
Log output level of the SDK. See LogLevel. For example, if you choose WARN level, you will see all logs at FATAL, ERROR, and WARN levels.