joystream/distributor-node/docs/schema/definition-properties-logs-properties-file-logging-options.md

file Type

object (File logging options)

file Properties

Property	Type	Required	Nullable	Defined by
level	string	Required	cannot be null	Distributor node configuration
path	string	Required	cannot be null	Distributor node configuration
maxFiles	integer	Optional	cannot be null	Distributor node configuration
maxSize	integer	Optional	cannot be null	Distributor node configuration
frequency	string	Optional	cannot be null	Distributor node configuration
archive	boolean	Optional	cannot be null	Distributor node configuration

level

Minimum level of logs sent to this output

level

• is required

• Type: string

• cannot be null

• defined in: Distributor node configuration

level Type

string

level Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"error"
"warn"
"info"
"http"
"verbose"
"debug"
"silly"

path

Path where the logs will be stored (absolute or relative to config file)

path

• is required

• Type: string

• cannot be null

• defined in: Distributor node configuration

path Type

string

maxFiles

Maximum number of log files to store. Recommended to be at least 7 when frequency is set to daily and at least 24 * 7 when frequency is set to hourly

maxFiles

• is optional

• Type: integer

• cannot be null

• defined in: Distributor node configuration

maxFiles Type

integer

maxFiles Constraints

minimum: the value of this number must greater than or equal to: 1

maxSize

Maximum size of a single log file in bytes

maxSize

• is optional

• Type: integer

• cannot be null

• defined in: Distributor node configuration

maxSize Type

integer

maxSize Constraints

minimum: the value of this number must greater than or equal to: 1024

frequency

The frequency of creating new log files (regardless of maxSize)

frequency

• is optional

• Type: string

• cannot be null

• defined in: Distributor node configuration

frequency Type

string

frequency Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"yearly"
"monthly"
"daily"
"hourly"

frequency Default Value

The default value is:

"daily"

archive

Whether to archive old logs

archive

• is optional

• Type: boolean

• cannot be null

• defined in: Distributor node configuration

archive Type

boolean