Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogConfig

Log file configurations.

since

v3.3.1.

Hierarchy

  • LogConfig

Index

Constructors

Properties

Constructors

constructor

  • new LogConfig(params?: undefined | { filePath?: undefined | string; fileSize?: undefined | number; level?: LogLevel }): LogConfig

  • Parameters

    • Optional params: undefined | { filePath?: undefined | string; fileSize?: undefined | number; level?: LogLevel }

    Returns LogConfig

Properties

Optional filePath

filePath: undefined | string

The absolute path of log files. The default file path is as follows:

  • Android: /storage/emulated/0/Android/data/<package_name>/files/agorasdk.log
  • iOS: App Sandbox/Library/caches/agorasdk.log Ensure that the directory for the log files exists and is writable. You can use this parameter to rename the log files.

Optional fileSize

fileSize: undefined | number

The size (KB) of a log file. The default value is 1024 KB. If you set fileSize 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.

Optional level

level: LogLevel

The output log level of the SDK.

For example, if you set the log level to WARN, the SDK outputs the logs within levels FATAL, ERROR, and WARN.

See [LogLevel]{@link enum LogLevel}.

Generated using TypeDoc