System.Log

The System and your Actors can LogMessage through this module.

The System itself doesn't store these log messages anywhere, It's up to you to handle and/or store these messages through an Actor.

type alias LogMessage address actorName wrappedMsg =

LogMessage address actorName wrappedMsg

The opaque LogMessage type

You can create LogMessages using the helper function available

Create

emergency : PID -> String -> LogMessage address actorName wrappedMsg

Create a new LogMessage with the severity Emergency

alert : PID -> String -> LogMessage address actorName wrappedMsg

Create a new LogMessage with the severity Alert

critical : PID -> String -> LogMessage address actorName wrappedMsg

Create a new LogMessage with the severity Critical

error : PID -> String -> LogMessage address actorName wrappedMsg

Create a new LogMessage with the severity Error

warning : PID -> String -> LogMessage address actorName wrappedMsg

Create a new LogMessage with the severity Warning

notice : PID -> String -> LogMessage address actorName wrappedMsg

Create a new LogMessage with the severity Notice

info : PID -> String -> LogMessage address actorName wrappedMsg

Create a new LogMessage with the severity Informational

debug : PID -> String -> LogMessage address actorName wrappedMsg

Create a new LogMessage with the severity Debug

Time

When you create a log message through any of the create helpers your log message will not have a time accociated with it.

withPosix :

LogMessage address actorName wrappedMsg

-> Posix

-> LogMessage address actorName wrappedMsg

Add a Posix (elm/time) to your LogMessage

Msg

What was the message that resulted in this LogMessage? I don't know, but if you supply it I'll store it on the LogMessage type!

withMessage :

SystemMessage address actorName wrappedMsg

-> LogMessage address actorName wrappedMsg

Supply a Message that resulted in this logMessage

You could use this to retry a failed command for instance.

Helpers

toString : LogMessage address actorName wrappedMsg -> String

Turn a LogMessage into a String

error pid wrappedMsg "I'm sorry Dave, I'm afraid I can't do that"
    |> toString


-- error | 2(1) | I'm sorry Dave, I'm afraid I can't do that


error system wrappedMsg "I'm sorry Dave, I'm afraid I can't do that"
    |> withPosix now
    |> toString


-- 2019/12/25 12:59:59 (UTC) | error | system | I'm sorry Dave, I'm afraid I can't do that

severityToString : Severity -> String

Severity to String

toMeta :

LogMessage address actorName appMsg

-> { posix : Maybe Posix

, severity : Severity

, pid : PID

, message : Maybe (SystemMessage address actorName appMsg)

, description : String

}

LogMessage to Description

tricycle/system-actor-model/4.1.1

System.Log

Create

Time

Msg

Helpers

Modules