LogConfig class

Log configuration controls how Xray outputs logs. Docs

Annotations

• @JsonSerializable.new(includeIfNull: false)

Constructors

LogConfig({String? access, bool? dnsLog, LogLevel? logLevel = LogLevel.warning, String? error, String? maskAddress})

LogConfig.fromJson(Map<String, dynamic> json)

factory

Properties

access ↔ String?

The file path for the access log. The value is a valid file path, such as "/var/log/Xray/access.log" (Linux) or "C:\Temp\Xray\_access.log" (Windows). When this item is not specified or is an empty value, the log is output to stdout.

getter/setter pair

dnsLog ↔ bool?

Log DNS queries made by built-in DNS clients to the access log. Example log record: DOH//doh.server got answer: domain.com -> ip1, ip2 2.333ms.

getter/setter pair

error ↔ String?

The file path for the error log. The value is a valid file path, such as "/var/log/Xray/error.log" (Linux) or "C:\Temp\Xray\_error.log" (Windows). When this item is not specified or is an empty value, the log is output to stdout.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

logLevel ↔ LogLevel?

The log level for error logs, indicating the information that needs to be recorded. The default value is "warning". Note that this setting applies to the error log only. It doesn't affect the access log (except for "none" value). The access log doesn't have log levels.

getter/setter pair

maskAddress ↔ String?

IP address masking, when enabled, will automatically replace the IP address appearing in the log. It is used to protect privacy when sharing logs.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited