AgoraLogConfig Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

The configuration of the log files that the SDK outputs.

  filePath

The absolute path of log files.

@property (copy, nonatomic) NSString *filePath

Availability

v3.3.0

Ensure that the directory for the log files exists and is writable. The default file path is as follows:

  • iOS: App Sandbox/Library/caches/agorasdk.log
  • macOS:
    • Sandbox enabled: App Sandbox/Library/Logs/agorasdk.log, such as /Users/<username>/Library/Containers/<App Bundle Identifier>/Data/Library/Logs/agorasdk.log
    • Sandbox disabled: ~/Library/Logs/agorasdk.log

Declared In

AgoraObjects.h

  fileSize

The size (KB) of a log file.

@property (assign, nonatomic) NSInteger fileSize

Availability

v3.3.0

The default value is 1024 KB. If you set this parameter to 1024 KB, the SDK outputs at most 5 MB log files; if you set it to less than 1024 KB, the setting is invalid, and the maximum size of a log file is still 1024 KB.

Declared In

AgoraObjects.h

  level

The output log level of the SDK. See details in AgoraLogLevel.

@property (assign, nonatomic) AgoraLogLevel level

Availability

v3.3.0

For example, if you set the log level to AgoraLogLevelWarn, the SDK outputs the logs within levels AgoraLogLevelFatal, AgoraLogLevelError, and AgoraLogLevelWarn.

Declared In

AgoraObjects.h