LoggerJSON.Formatter behaviour (logger_json v5.1.0) View Source

Behaviour that should be implemented by log formatters.

Example implementations can be found in LoggerJSON.Formatters.GoogleCloudLogger and LoggerJSON.Formatters.BasicLogger.

Link to this section Summary

Callbacks

Initialization callback. Ran on startup with the given formatter_opts list.

Link to this section Callbacks

Link to this callback

format_event( level, msg, ts, md, state, formatter_state )

View Source

Specs

format_event(
  level :: Logger.level(),
  msg :: Logger.message(),
  ts :: Logger.Formatter.time(),
  md :: [atom()] | :all,
  state :: map(),
  formatter_state :: map()
) :: map() | iodata() | %Jason.Fragment{encode: term()}

Format event callback.

Returned map will be encoded to JSON.

Specs

init(Keyword.t()) :: Keyword.t()

Initialization callback. Ran on startup with the given formatter_opts list.

Returned list will be used as formatter_state in format_event/6.