Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

📜 Logging


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
BaseLoggerDebugLevel40 (default was 1)1

Description:

Specifies the logging level for algod (node.log).

The levels are:

  • 0: Panic: Highest level of severity. Logs and then calls panic().

  • 1: Fatal: Logs and then calls os.Exit(1). It will exit even if the logging level is set to Panic.

  • 2: Error: Used for errors that should definitely be noted. Commonly used for hooks to send errors to an error tracking service.

  • 3: Warn: Non-critical entries that deserve attention.

  • 4: Info: General operational entries.

  • 5: Debug: Verbose logging, usually only enabled when debugging.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
CadaverSizeTarget00 (default was 1073741824)24

Description:

Specifies the maximum size of the agreement.cdv file in bytes. Once full, the file will be renamed to agreement.archive.log and a new agreement.cdv will be created.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
CadaverDirectoryEmpty string2727

Description:

If not set, MakeService will attempt to use ColdDataDir instead.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
LogFileDirEmpty string3131

Description:

An optional directory to store the log file, node.log. If not set, the node will use the HotDataDir. The -o GOAL CLI option can override this output location.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
LogArchiveDirEmpty string3131

Description:

An optional directory to store the log archive. If not specified, the node will use the ColdDataDir.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
LogSizeLimit107374182400

Description:

Sets the node log file size limit in bytes. When set to 0, logs will be written to stdout.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
LogArchiveNamenode.archive.log44

Description:

Text template for creating the log archive filename. If the filename ends with .gz or .bz2 it will be compressed.

Available template variables:

  • Time at the start of log:

    • {{.Year}}
    • {{.Month}}
    • {{.Day}}
    • {{.Hour}}
    • {{.Minute}}
    • {{.Second}}
  • Time at the end of log:

    • {{.EndYear}}
    • {{.EndMonth}}
    • {{.EndDay}}
    • {{.EndHour}}
    • {{.EndMinute}}
    • {{.EndSecond}}

Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
LogArchiveMaxAgeEmpty string44

Description:

Specifies the maximum age for a node log. Valid units are s seconds, m minutes, h hours.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
EnableRequestLoggerfalse44

Description:

Enables the logging of the incoming requests to the telemetry server.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
TelemetryToLogtrue55

Description:

Configures whether to record messages to node.log that are usually only sent to remote event monitoring.


Parameter NameDefault ValueIntroduced in VersionLast Updated in Version
EnableVerbosedTransactionSyncLoggingfalse1717

Description:

Allows the Transaction Sync to write extensive message exchange information to the log file. This option is disabled by default to prevent the rapid growth of logs.