Logging

Maverics is capable of integrating with log aggregation systems to consume and process logs.

Log records are sent to Syslog (Linux, MacOS, and Kubernetes) or Windows Event Viewer (Windows) and include a maverics identifier. The sizing or overwriting of system logs must be configured from your operating system via logrotate (usually /etc/logrotate.d/rsyslog or /etc/logrotate.conf). For more information on managing log settings, see the logrotate documentation.

Most log aggregation platforms (ELK, Loggly, etc.) can accept log streams via Syslog.

To run Maverics in debug mode, set the MAVERICS_DEBUG_MODE environment variable to true. Logging will be much more verbose when running in debug mode.

Configuration options

Logging options can be set in the logger section of the Maverics config file.

Level

level determines the verbosity of the Orchestrator logs. For example, level: error will only show error logs (when debug mode is off). The following log levels are supported:

debug
info
error

ℹ️

Enabling debug mode from the command line (-v/--verbose) or through the environment variable (MAVERICS_DEBUG_MODE) will take precedence over the level field.

Log Session IDs

logSessionID is used to append a session identifier in log messages. This setting is useful when filtering logs to isolate a problem with a particular session.

ℹ️

The identifier printed in the logs corresponds to a particular session, but it is not the actual session ID itself and hence cannot be used to impersonate a user’s session.

Time format

timeFormat is used to change the formatting of the log timestamps.

For example, a time format of timeFormat: ANSIC will create timestamps in the format ts=:"Mon Jan 2 15:04:05 2006".

The following format names are supported (case-insensitive):

Name	Format
ANSIC	“Mon Jan _2 15:04:05 2006”
UnixDate	“Mon Jan _2 15:04:05 MST 2006”
RubyDate	“Mon Jan 02 15:04:05 -0700 2006”
RFC822	“02 Jan 06 15:04 MST”
RFC822Z	“02 Jan 06 15:04 -0700”
RFC850	“Monday, 02-Jan-06 15:04:05 MST”
RFC1123	“Mon, 02 Jan 2006 15:04:05 MST”
RFC1123Z	“Mon, 02 Jan 2006 15:04:05 -0700”
RFC3339	“2006-01-02T15:04:05Z07:00”
RFC3339Nano	“2006-01-02T15:04:05.999999999Z07:00”
Kitchen	“3:04PM”
Stamp	“Jan _2 15:04:05”
StampMilli	“Jan _2 15:04:05.000”
StampMicro	“Jan _2 15:04:05.000000”
StampNano	“Jan _2 15:04:05.000000000”

Custom time formats can be specified with a layout string using the date in the examples above (Jan 2 15:04:05 2006) as per Golang’s time format. For example:

logger:
  timeFormat: "2006-01-02 15:04:05 MST"

ℹ️

Orchestrator logs are always in UTC. When setting a custom timeFormat string as above, the MST time zone abbreviation (or -0700 offset) in the layout string does not change this but will set the position of UTC or -0000 in the timestamp.

Examples

logger:
  level: debug
  logSessionID: true 
  timeFormat: UnixDate

Health